Package com.buschmais.jqassistant.plugin.common.impl.scanner

Class AbstractUriScannerPlugin<R>

java.lang.Object

com.buschmais.jqassistant.plugin.common.api.scanner.AbstractScannerPlugin<URI,URIDescriptor>

com.buschmais.jqassistant.plugin.common.impl.scanner.AbstractUriScannerPlugin<R>

Type Parameters:

R - The resource type represented by the URI and to be passed to subsequent scanners .

All Implemented Interfaces:

ScannerPlugin<URI,URIDescriptor>, com.buschmais.jqassistant.core.shared.lifecycle.ContextualConfigurableLifecycleAware<ScannerContext,Map<String,Object>>, com.buschmais.jqassistant.core.shared.lifecycle.LifecycleAware

Direct Known Subclasses:

DefaultUriScannerPlugin, PluginUriScannerPlugin

public abstract class AbstractUriScannerPlugin<R>
extends AbstractScannerPlugin<URI,URIDescriptor>

Abstract base class for URI scanners.

Nested Class Summary

Nested classes/interfaces inherited from interface com.buschmais.jqassistant.core.scanner.api.ScannerPlugin

ScannerPlugin.Requires

Constructor Summary

Constructors

Constructor	Description
AbstractUriScannerPlugin()

Method Summary

Modifier and Type	Method	Description
Class<URIDescriptor>	getDescriptorType()
protected abstract Optional<R>	getResource(URI uri, ScannerContext context)	Get the resource identified by the URI.
Class<URI>	getType()
protected final Optional<R>	resolve(URI uri, Supplier<R> resourceSupplier, ScannerContext context)	Convenience method for sub-classes to resolve a URI resource uniquely, i.e. only provide a resource if there's no matching URIDescriptor in the store.
final URIDescriptor	scan(URI uri, String path, Scope scope, Scanner scanner)

Methods inherited from class com.buschmais.jqassistant.plugin.common.api.scanner.AbstractScannerPlugin

configure, configure, equals, getBooleanProperty, getDirectoryPath, getName, getProperties, getProperty, getScannerContext, getStringProperty, getTypeParameter, hashCode

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.buschmais.jqassistant.core.scanner.api.ScannerPlugin

accepts, destroy, initialize

Constructor Details

AbstractUriScannerPlugin

public AbstractUriScannerPlugin()

Method Details

getType

public Class<URI> getType()

Specified by:

getType in interface ScannerPlugin<URI,URIDescriptor>

Overrides:

getType in class AbstractScannerPlugin<URI,URIDescriptor>

getDescriptorType

public Class<URIDescriptor> getDescriptorType()

Specified by:

getDescriptorType in interface ScannerPlugin<URI,URIDescriptor>

Overrides:

getDescriptorType in class AbstractScannerPlugin<URI,URIDescriptor>

scan

public final URIDescriptor scan(URI uri,
 String path,
 Scope scope,
 Scanner scanner)
                         throws IOException

Throws:

IOException

getResource

protected abstract Optional<R> getResource(URI uri,
 ScannerContext context)
                                    throws IOException

Get the resource identified by the URI.

Parameters:

uri - The URI

context - The ScannerContext.

Returns:

The resource.

Throws:

IOException - If the resource cannot be opened.

resolve

protected final Optional<R> resolve(URI uri,
 Supplier<R> resourceSupplier,
 ScannerContext context)

Convenience method for sub-classes to resolve a URI resource uniquely, i.e. only provide a resource if there's no matching URIDescriptor in the store.

Parameters:

uri - The URI.

resourceSupplier - The resource Supplier. The Supplier is allowed to return a null value.

context - The ScannerContext.

Returns:

An Optional representing the URI resource to be scanned.