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

Class ZipScannerPlugin

java.lang.Object

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

com.buschmais.jqassistant.plugin.common.api.scanner.AbstractZipArchiveScannerPlugin<ZipArchiveDescriptor>

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

All Implemented Interfaces:

com.buschmais.jqassistant.core.scanner.api.ScannerPlugin<FileResource,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 ZipScannerPlugin
extends AbstractZipArchiveScannerPlugin<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
ZipScannerPlugin()

Method Summary

Modifier and Type	Method and Description
protected com.buschmais.jqassistant.core.scanner.api.Scope	createScope(com.buschmais.jqassistant.core.scanner.api.Scope currentScope, ZipArchiveDescriptor archiveDescriptor, com.buschmais.jqassistant.core.scanner.api.ScannerContext context) <p>Create a scope depending of the archive type.
protected void	destroyScope(com.buschmais.jqassistant.core.scanner.api.ScannerContext scannerContext) <p>Destroy the scope.
protected String	getExtension() <p>Return the file extension to match.

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

accepts, getDescriptorType, getType, 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

ZipScannerPlugin

public ZipScannerPlugin()

Method Detail

getExtension

protected String getExtension()

Description copied from class: AbstractZipArchiveScannerPlugin

<p>Return the file extension to match.</p>

Specified by:

getExtension in class AbstractZipArchiveScannerPlugin<ZipArchiveDescriptor>

Returns:

The file extension

createScope

protected com.buschmais.jqassistant.core.scanner.api.Scope createScope(com.buschmais.jqassistant.core.scanner.api.Scope currentScope,
                                                                       ZipArchiveDescriptor archiveDescriptor,
                                                                       com.buschmais.jqassistant.core.scanner.api.ScannerContext context)

Description copied from class: AbstractZipArchiveScannerPlugin

<p>Create a scope depending of the archive type.</p>

Specified by:

createScope in class AbstractZipArchiveScannerPlugin<ZipArchiveDescriptor>

Parameters:

currentScope - The current scope.

archiveDescriptor - The created archive descriptor.

context - The scanner context

Returns:

The new scope.

destroyScope

protected void destroyScope(com.buschmais.jqassistant.core.scanner.api.ScannerContext scannerContext)

Description copied from class: AbstractZipArchiveScannerPlugin

<p>Destroy the scope.</p>

Specified by:

destroyScope in class AbstractZipArchiveScannerPlugin<ZipArchiveDescriptor>

Parameters:

scannerContext - The scanner context