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

Class DirectoryScannerPlugin

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<File,File,D>

com.buschmais.jqassistant.plugin.common.api.scanner.AbstractDirectoryScannerPlugin<DirectoryDescriptor>

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

All Implemented Interfaces:

com.buschmais.jqassistant.core.scanner.api.ScannerPlugin<File,DirectoryDescriptor>, 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 DirectoryScannerPlugin
extends AbstractDirectoryScannerPlugin<DirectoryDescriptor>

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

Method Summary

Modifier and Type	Method and Description
protected void	enterContainer(File directory, DirectoryDescriptor directoryDescriptor, 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 DirectoryDescriptor	getContainerDescriptor(File container, com.buschmais.jqassistant.core.scanner.api.ScannerContext scannerContext) <p>Return the descriptor representing the artifact.
protected com.buschmais.jqassistant.core.scanner.api.Scope	getRequiredScope() <p>Return the scope the plugin expects for execution.
protected void	leaveContainer(File directory, DirectoryDescriptor directoryDescriptor, 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.AbstractDirectoryScannerPlugin

accepts, getContainerPath, getDescriptorType, getEntries, getEntry, getRelativePath, getType

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

DirectoryScannerPlugin

public DirectoryScannerPlugin()

Method Detail

getRequiredScope

protected com.buschmais.jqassistant.core.scanner.api.Scope getRequiredScope()

Description copied from class: AbstractDirectoryScannerPlugin

<p>Return the scope the plugin expects for execution.</p>

Specified by:

getRequiredScope in class AbstractDirectoryScannerPlugin<DirectoryDescriptor>

Returns:

The scope.

getContainerDescriptor

protected DirectoryDescriptor getContainerDescriptor(File container,
                                                     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<File,File,DirectoryDescriptor>

Parameters:

container - The container.

scannerContext - The scanner context.

Returns:

The artifact descriptor.

enterContainer

protected void enterContainer(File directory,
                              DirectoryDescriptor directoryDescriptor,
                              com.buschmais.jqassistant.core.scanner.api.ScannerContext scannerContext)

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<File,File,DirectoryDescriptor>

Parameters:

directory - The container.

directoryDescriptor - The container descriptor.

scannerContext - The scanner context.

leaveContainer

protected void leaveContainer(File directory,
                              DirectoryDescriptor directoryDescriptor,
                              com.buschmais.jqassistant.core.scanner.api.ScannerContext scannerContext)

Description copied from class: AbstractContainerScannerPlugin

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

Specified by:

leaveContainer in class AbstractContainerScannerPlugin<File,File,DirectoryDescriptor>

Parameters:

directory - The container.

directoryDescriptor - The container descriptor

scannerContext - The scanner context.