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

Class AbstractDirectoryScannerPlugin<D extends DirectoryDescriptor>

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

All Implemented Interfaces:

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

DirectoryScannerPlugin

public abstract class AbstractDirectoryScannerPlugin<D extends DirectoryDescriptor>
extends AbstractContainerScannerPlugin<File,File,D>

<p>Abstract base implementation for directory 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
AbstractDirectoryScannerPlugin()

Method Summary

Modifier and Type	Method and Description
boolean	accepts(File item, String path, com.buschmais.jqassistant.core.scanner.api.Scope scope)
protected String	getContainerPath(File container, String path) <p>Return the normalized path to the container.
Class<D>	getDescriptorType()
protected Iterable<? extends File>	getEntries(File container) <p>Return an iterable which delivers the entries of the container.
protected Resource	getEntry(File container, File entry) <p>Return a Resource representing an entry.
protected String	getRelativePath(File container, File entry) <p>Return the relative path of an element within the container.
protected abstract com.buschmais.jqassistant.core.scanner.api.Scope	getRequiredScope() <p>Return the scope the plugin expects for execution.
Class<? extends File>	getType()

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

enterContainer, getContainerDescriptor, leaveContainer, 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

AbstractDirectoryScannerPlugin

public AbstractDirectoryScannerPlugin()

Method Detail

getType

public Class<? extends File> getType()

Specified by:

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

Overrides:

getType in class AbstractResourceScannerPlugin<File,D extends DirectoryDescriptor>

getDescriptorType

public Class<D> getDescriptorType()

Specified by:

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

Overrides:

getDescriptorType in class AbstractResourceScannerPlugin<File,D extends DirectoryDescriptor>

accepts

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

Throws:

IOException

getEntries

protected Iterable<? extends File> getEntries(File 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<File,File,D extends DirectoryDescriptor>

Parameters:

container - The container.

Returns:

The iterable of entries.

Throws:

IOException - If the entries cannot be determined.

getRequiredScope

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

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

Returns:

The scope.

getContainerPath

protected String getContainerPath(File container,
                                  String path)

Description copied from class: AbstractContainerScannerPlugin

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

Specified by:

getContainerPath in class AbstractContainerScannerPlugin<File,File,D extends DirectoryDescriptor>

Parameters:

container - The container.

Returns:

The normalized path.

getRelativePath

protected String getRelativePath(File container,
                                 File 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<File,File,D extends DirectoryDescriptor>

Parameters:

container - The container.

entry - The entry.

Returns:

The relative path.

getEntry

protected Resource getEntry(File container,
                            File entry)

Description copied from class: AbstractContainerScannerPlugin

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

Specified by:

getEntry in class AbstractContainerScannerPlugin<File,File,D extends DirectoryDescriptor>

Parameters:

container - The container.

entry - The entry.

Returns:

The FileResource .