com.buschmais.jqassistant.plugin.common.api.scanner

Class AbstractContainerScannerPlugin<I,E,D extends FileContainerDescriptor>

java.lang.Object

com.buschmais.jqassistant.plugin.common.api.scanner.AbstractScannerPlugin<I,D>

com.buschmais.jqassistant.plugin.common.api.scanner.AbstractResourceScannerPlugin<I,D>

com.buschmais.jqassistant.plugin.common.api.scanner.AbstractContainerScannerPlugin<I,E,D>

Type Parameters:

I - The container type.

E - The element type.

D - The descriptor type.

All Implemented Interfaces:

com.buschmais.jqassistant.core.scanner.api.ScannerPlugin<I,D>, com.buschmais.jqassistant.core.shared.lifecycle.ContextualConfigurableLifecycleAware<com.buschmais.jqassistant.core.scanner.api.ScannerContext,Map<String,Object>>, com.buschmais.jqassistant.core.shared.lifecycle.LifecycleAware

Direct Known Subclasses:

AbstractArchiveInputStreamScannerPlugin, AbstractDirectoryScannerPlugin, ZipFileScannerPlugin

public abstract class AbstractContainerScannerPlugin<I,E,D extends FileContainerDescriptor>
extends AbstractResourceScannerPlugin<I,D>

<p>Abstract base implementation for scanner plugins that handle containers of elements like directories, archives, etc.</p>

Nested Class Summary

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

com.buschmais.jqassistant.core.scanner.api.ScannerPlugin.Requires

Constructor Summary

Constructors

Constructor and Description
AbstractContainerScannerPlugin()

Method Summary

Modifier and Type	Method and Description
protected abstract void	enterContainer(I container, D containerDescriptor, com.buschmais.jqassistant.core.scanner.api.ScannerContext scannerContext) <p>Create a scope depending on the container type, e.g. a JAR file should return classpath scope.
protected abstract D	getContainerDescriptor(I container, com.buschmais.jqassistant.core.scanner.api.ScannerContext scannerContext) <p>Return the descriptor representing the artifact.
protected abstract String	getContainerPath(I container, String path) <p>Return the normalized path to the container.
protected abstract Iterable<? extends E>	getEntries(I container) <p>Return an iterable which delivers the entries of the container.
protected abstract Resource	getEntry(I container, E entry) <p>Return a Resource representing an entry.
protected abstract String	getRelativePath(I container, E entry) <p>Return the relative path of an element within the container.
protected abstract void	leaveContainer(I container, D containerDescriptor, com.buschmais.jqassistant.core.scanner.api.ScannerContext scannerContext) <p>Destroy the container dependent scope.
D	scan(I container, String path, com.buschmais.jqassistant.core.scanner.api.Scope scope, com.buschmais.jqassistant.core.scanner.api.Scanner scanner)

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

getDescriptorType, getType

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 Detail

AbstractContainerScannerPlugin

public AbstractContainerScannerPlugin()

Method Detail

scan

public final D scan(I container,
                    String path,
                    com.buschmais.jqassistant.core.scanner.api.Scope scope,
                    com.buschmais.jqassistant.core.scanner.api.Scanner scanner)
             throws IOException

Throws:

IOException

getContainerDescriptor

protected abstract D getContainerDescriptor(I container,
                                            com.buschmais.jqassistant.core.scanner.api.ScannerContext scannerContext)

<p>Return the descriptor representing the artifact.</p>

Parameters:

container - The container.

scannerContext - The scanner context.

Returns:

The artifact descriptor.

getEntries

protected abstract Iterable<? extends E> getEntries(I container)
                                             throws IOException

<p>Return an iterable which delivers the entries of the container. <p> The entries must not contain the relative root element, i.e. "/". </p></p>

Parameters:

container - The container.

Returns:

The iterable of entries.

Throws:

IOException - If the entries cannot be determined.

getContainerPath

protected abstract String getContainerPath(I container,
                                           String path)

<p>Return the normalized path to the container.</p>

Parameters:

container - The container.

Returns:

The normalized path.

getRelativePath

protected abstract String getRelativePath(I container,
                                          E entry)

<p>Return the relative path of an element within the container. <p> The following conditions must be considered: <ul> <li>The separator to use is "/".</li> <li>The path must start with "/".</li> <li>The path must not end with "/".</li> </ul></p> <p></p></p>

Parameters:

container - The container.

entry - The entry.

Returns:

The relative path.

enterContainer

protected abstract void enterContainer(I container,
                                       D containerDescriptor,
                                       com.buschmais.jqassistant.core.scanner.api.ScannerContext scannerContext)
                                throws IOException

<p>Create a scope depending on the container type, e.g. a JAR file should return classpath scope.</p>

Parameters:

container - The container.

containerDescriptor - The container descriptor.

scannerContext - The scanner context.

Throws:

IOException

leaveContainer

protected abstract void leaveContainer(I container,
                                       D containerDescriptor,
                                       com.buschmais.jqassistant.core.scanner.api.ScannerContext scannerContext)
                                throws IOException

<p>Destroy the container dependent scope.</p>

Parameters:

container - The container.

containerDescriptor - The container descriptor

scannerContext - The scanner context.

Throws:

IOException

getEntry

protected abstract Resource getEntry(I container,
                                     E entry)

<p>Return a Resource representing an entry.</p>

Parameters:

container - The container.

entry - The entry.

Returns:

The FileResource .