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

Class AbstractArchiveInputStreamScannerPlugin<S extends org.apache.commons.compress.archivers.ArchiveInputStream,E extends org.apache.commons.compress.archivers.ArchiveEntry,D extends ArchiveDescriptor>

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<S,E,D>

com.buschmais.jqassistant.plugin.common.impl.scanner.AbstractArchiveInputStreamScannerPlugin<S,E,D>

Type Parameters:

S - The ArchiveInputStream type.

E - The ArchiveEntry type.

D - The ArchiveDescriptor type.

All Implemented Interfaces:

com.buschmais.jqassistant.core.scanner.api.ScannerPlugin<S,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:

TarArchiveInputStreamScannerPlugin

public abstract class AbstractArchiveInputStreamScannerPlugin<S extends org.apache.commons.compress.archivers.ArchiveInputStream,E extends org.apache.commons.compress.archivers.ArchiveEntry,D extends ArchiveDescriptor>
extends AbstractContainerScannerPlugin<S,E,D>

<p>Abstract base class for archive scanners based on commons compress.</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
AbstractArchiveInputStreamScannerPlugin()

Method Summary

Modifier and Type	Method and Description
boolean	accepts(S item, String path, com.buschmais.jqassistant.core.scanner.api.Scope scope)
protected void	enterContainer(S 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 String	getContainerPath(S container, String path) <p>Return the normalized path to the container.
protected Iterable<? extends E>	getEntries(S container) <p>Return an iterable which delivers the entries of the container.
protected Resource	getEntry(S container, E entry) <p>Return a Resource representing an entry.
protected abstract E	getNextEntry(S container)
protected String	getRelativePath(S container, E entry) <p>Return the relative path of an element within the container.
protected void	leaveContainer(S container, D containerDescriptor, com.buschmais.jqassistant.core.scanner.api.ScannerContext scannerContext) <p>Destroy the container dependent scope.

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

getContainerDescriptor, scan

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

destroy, initialize

Constructor Detail

AbstractArchiveInputStreamScannerPlugin

public AbstractArchiveInputStreamScannerPlugin()

Method Detail

getNextEntry

protected abstract E getNextEntry(S container)
                           throws IOException

Throws:

IOException

accepts

public boolean accepts(S item,
                       String path,
                       com.buschmais.jqassistant.core.scanner.api.Scope scope)
                throws IOException

Throws:

IOException

getEntries

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

Description copied from class: AbstractContainerScannerPlugin

<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>

Specified by:

getEntries in class AbstractContainerScannerPlugin<S extends org.apache.commons.compress.archivers.ArchiveInputStream,E extends org.apache.commons.compress.archivers.ArchiveEntry,D extends ArchiveDescriptor>

Parameters:

container - The container.

Returns:

The iterable of entries.

Throws:

IOException - If the entries cannot be determined.

getContainerPath

protected String getContainerPath(S container,
                                  String path)

Description copied from class: AbstractContainerScannerPlugin

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

Specified by:

getContainerPath in class AbstractContainerScannerPlugin<S extends org.apache.commons.compress.archivers.ArchiveInputStream,E extends org.apache.commons.compress.archivers.ArchiveEntry,D extends ArchiveDescriptor>

Parameters:

container - The container.

Returns:

The normalized path.

getRelativePath

protected String getRelativePath(S container,
                                 E entry)

Description copied from class: AbstractContainerScannerPlugin

<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>

Specified by:

getRelativePath in class AbstractContainerScannerPlugin<S extends org.apache.commons.compress.archivers.ArchiveInputStream,E extends org.apache.commons.compress.archivers.ArchiveEntry,D extends ArchiveDescriptor>

Parameters:

container - The container.

entry - The entry.

Returns:

The relative path.

enterContainer

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

Description copied from class: AbstractContainerScannerPlugin

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

Specified by:

enterContainer in class AbstractContainerScannerPlugin<S extends org.apache.commons.compress.archivers.ArchiveInputStream,E extends org.apache.commons.compress.archivers.ArchiveEntry,D extends ArchiveDescriptor>

Parameters:

container - The container.

containerDescriptor - The container descriptor.

scannerContext - The scanner context.

Throws:

IOException

leaveContainer

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

Description copied from class: AbstractContainerScannerPlugin

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

Specified by:

leaveContainer in class AbstractContainerScannerPlugin<S extends org.apache.commons.compress.archivers.ArchiveInputStream,E extends org.apache.commons.compress.archivers.ArchiveEntry,D extends ArchiveDescriptor>

Parameters:

container - The container.

containerDescriptor - The container descriptor

scannerContext - The scanner context.

Throws:

IOException

getEntry

protected Resource getEntry(S container,
                            E entry)

Description copied from class: AbstractContainerScannerPlugin

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

Specified by:

getEntry in class AbstractContainerScannerPlugin<S extends org.apache.commons.compress.archivers.ArchiveInputStream,E extends org.apache.commons.compress.archivers.ArchiveEntry,D extends ArchiveDescriptor>

Parameters:

container - The container.

entry - The entry.

Returns:

The FileResource .