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

Class AbstractZipArchiveScannerPlugin<D extends ZipArchiveDescriptor>

java.lang.Object

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

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

All Implemented Interfaces:

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

ZipScannerPlugin

public abstract class AbstractZipArchiveScannerPlugin<D extends ZipArchiveDescriptor>
extends AbstractScannerPlugin<FileResource,D>

<p>Abstract base implementation for archive scanners.</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
AbstractZipArchiveScannerPlugin()

Method Summary

Modifier and Type	Method and Description
boolean	accepts(FileResource file, String path, com.buschmais.jqassistant.core.scanner.api.Scope scope)
protected abstract com.buschmais.jqassistant.core.scanner.api.Scope	createScope(com.buschmais.jqassistant.core.scanner.api.Scope currentScope, D archiveDescriptor, com.buschmais.jqassistant.core.scanner.api.ScannerContext scannerContext) <p>Create a scope depending of the archive type.
protected abstract void	destroyScope(com.buschmais.jqassistant.core.scanner.api.ScannerContext scannerContext) <p>Destroy the scope.
Class<D>	getDescriptorType()
protected abstract String	getExtension() <p>Return the file extension to match.
Class<? extends FileResource>	getType()
D	scan(FileResource file, String path, com.buschmais.jqassistant.core.scanner.api.Scope currentScope, com.buschmais.jqassistant.core.scanner.api.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

destroy, initialize

Constructor Detail

AbstractZipArchiveScannerPlugin

public AbstractZipArchiveScannerPlugin()

Method Detail

getType

public Class<? extends FileResource> getType()

Specified by:

getType in interface com.buschmais.jqassistant.core.scanner.api.ScannerPlugin<FileResource,D extends ZipArchiveDescriptor>

Overrides:

getType in class AbstractScannerPlugin<FileResource,D extends ZipArchiveDescriptor>

getDescriptorType

public Class<D> getDescriptorType()

Specified by:

getDescriptorType in interface com.buschmais.jqassistant.core.scanner.api.ScannerPlugin<FileResource,D extends ZipArchiveDescriptor>

Overrides:

getDescriptorType in class AbstractScannerPlugin<FileResource,D extends ZipArchiveDescriptor>

accepts

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

Throws:

IOException

scan

public D scan(FileResource file,
              String path,
              com.buschmais.jqassistant.core.scanner.api.Scope currentScope,
              com.buschmais.jqassistant.core.scanner.api.Scanner scanner)
       throws IOException

Throws:

IOException

getExtension

protected abstract String getExtension()

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

Returns:

The file extension

createScope

protected abstract com.buschmais.jqassistant.core.scanner.api.Scope createScope(com.buschmais.jqassistant.core.scanner.api.Scope currentScope,
                                                                                D archiveDescriptor,
                                                                                com.buschmais.jqassistant.core.scanner.api.ScannerContext scannerContext)

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

Parameters:

currentScope - The current scope.

archiveDescriptor - The created archive descriptor.

scannerContext - The scanner context

Returns:

The new scope.

destroyScope

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

<p>Destroy the scope.</p>

Parameters:

scannerContext - The scanner context