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

Class ZipFileScannerPlugin

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<ZipFileResource,org.apache.commons.compress.archivers.zip.ZipArchiveEntry,ZipArchiveDescriptor>

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

All Implemented Interfaces:

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

public class ZipFileScannerPlugin
extends AbstractContainerScannerPlugin<ZipFileResource,org.apache.commons.compress.archivers.zip.ZipArchiveEntry,ZipArchiveDescriptor>

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
ZipFileScannerPlugin()

Method Summary

Modifier and Type	Method and Description
boolean	accepts(ZipFileResource item, String path, com.buschmais.jqassistant.core.scanner.api.Scope scope)
protected void	enterContainer(ZipFileResource zipFile, ZipArchiveDescriptor archiveDescriptor, com.buschmais.jqassistant.core.scanner.api.ScannerContext context) <p>Create a scope depending on the container type, e.g. a JAR file should return classpath scope.
protected ZipArchiveDescriptor	getContainerDescriptor(ZipFileResource zipFile, com.buschmais.jqassistant.core.scanner.api.ScannerContext scannerContext) <p>Return the descriptor representing the artifact.
protected String	getContainerPath(ZipFileResource container, String path) <p>Return the normalized path to the container.
Class<ZipArchiveDescriptor>	getDescriptorType()
protected Iterable<? extends org.apache.commons.compress.archivers.zip.ZipArchiveEntry>	getEntries(ZipFileResource container) <p>Return an iterable which delivers the entries of the container.
protected Resource	getEntry(ZipFileResource container, org.apache.commons.compress.archivers.zip.ZipArchiveEntry entry) <p>Return a Resource representing an entry.
protected String	getRelativePath(ZipFileResource container, org.apache.commons.compress.archivers.zip.ZipArchiveEntry entry) <p>Return the relative path of an element within the container.
Class<? extends ZipFileResource>	getType()
protected void	leaveContainer(ZipFileResource zipFile, ZipArchiveDescriptor archiveDescriptor, 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

scan

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

ZipFileScannerPlugin

public ZipFileScannerPlugin()

Method Detail

getType

public Class<? extends ZipFileResource> getType()

Specified by:

getType in interface com.buschmais.jqassistant.core.scanner.api.ScannerPlugin<ZipFileResource,ZipArchiveDescriptor>

Overrides:

getType in class AbstractResourceScannerPlugin<ZipFileResource,ZipArchiveDescriptor>

getDescriptorType

public Class<ZipArchiveDescriptor> getDescriptorType()

Specified by:

getDescriptorType in interface com.buschmais.jqassistant.core.scanner.api.ScannerPlugin<ZipFileResource,ZipArchiveDescriptor>

Overrides:

getDescriptorType in class AbstractResourceScannerPlugin<ZipFileResource,ZipArchiveDescriptor>

accepts

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

Throws:

IOException

getContainerDescriptor

protected ZipArchiveDescriptor getContainerDescriptor(ZipFileResource zipFile,
                                                      com.buschmais.jqassistant.core.scanner.api.ScannerContext scannerContext)

Description copied from class: AbstractContainerScannerPlugin

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

Specified by:

getContainerDescriptor in class AbstractContainerScannerPlugin<ZipFileResource,org.apache.commons.compress.archivers.zip.ZipArchiveEntry,ZipArchiveDescriptor>

Parameters:

zipFile - The container.

scannerContext - The scanner context.

Returns:

The artifact descriptor.

getEntries

protected Iterable<? extends org.apache.commons.compress.archivers.zip.ZipArchiveEntry> getEntries(ZipFileResource 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<ZipFileResource,org.apache.commons.compress.archivers.zip.ZipArchiveEntry,ZipArchiveDescriptor>

Parameters:

container - The container.

Returns:

The iterable of entries.

Throws:

IOException - If the entries cannot be determined.

getContainerPath

protected String getContainerPath(ZipFileResource container,
                                  String path)

Description copied from class: AbstractContainerScannerPlugin

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

Specified by:

getContainerPath in class AbstractContainerScannerPlugin<ZipFileResource,org.apache.commons.compress.archivers.zip.ZipArchiveEntry,ZipArchiveDescriptor>

Parameters:

container - The container.

Returns:

The normalized path.

getRelativePath

protected String getRelativePath(ZipFileResource container,
                                 org.apache.commons.compress.archivers.zip.ZipArchiveEntry 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<ZipFileResource,org.apache.commons.compress.archivers.zip.ZipArchiveEntry,ZipArchiveDescriptor>

Parameters:

container - The container.

entry - The entry.

Returns:

The relative path.

enterContainer

protected void enterContainer(ZipFileResource zipFile,
                              ZipArchiveDescriptor archiveDescriptor,
                              com.buschmais.jqassistant.core.scanner.api.ScannerContext context)
                       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<ZipFileResource,org.apache.commons.compress.archivers.zip.ZipArchiveEntry,ZipArchiveDescriptor>

Parameters:

zipFile - The container.

archiveDescriptor - The container descriptor.

context - The scanner context.

Throws:

IOException

leaveContainer

protected void leaveContainer(ZipFileResource zipFile,
                              ZipArchiveDescriptor archiveDescriptor,
                              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<ZipFileResource,org.apache.commons.compress.archivers.zip.ZipArchiveEntry,ZipArchiveDescriptor>

Parameters:

zipFile - The container.

archiveDescriptor - The container descriptor

scannerContext - The scanner context.

Throws:

IOException

getEntry

protected Resource getEntry(ZipFileResource container,
                            org.apache.commons.compress.archivers.zip.ZipArchiveEntry entry)

Description copied from class: AbstractContainerScannerPlugin

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

Specified by:

getEntry in class AbstractContainerScannerPlugin<ZipFileResource,org.apache.commons.compress.archivers.zip.ZipArchiveEntry,ZipArchiveDescriptor>

Parameters:

container - The container.

entry - The entry.

Returns:

The FileResource .