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

Class AbstractScannerPlugin<I,D extends com.buschmais.jqassistant.core.store.api.model.Descriptor>

java.lang.Object

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

All Implemented Interfaces:

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

AbstractResourceScannerPlugin, AbstractZipArchiveScannerPlugin, DefaultUriScannerPlugin, DirectoryResourceScannerPlugin, FileResourceScannerPlugin, GZIPFileScannerPlugin, TarFileScannerPlugin

public abstract class AbstractScannerPlugin<I,D extends com.buschmais.jqassistant.core.store.api.model.Descriptor>
extends Object
implements com.buschmais.jqassistant.core.scanner.api.ScannerPlugin<I,D>

<p>Abstract base implementation of a ScannerPlugin.</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
AbstractScannerPlugin()

Method Summary

Modifier and Type	Method and Description
protected void	configure() <p>Convenience method which might be overridden by sub-classes.
void	configure(com.buschmais.jqassistant.core.scanner.api.ScannerContext scannerContext, Map<String,Object> properties)
boolean	equals(Object obj)
protected Boolean	getBooleanProperty(String name, Boolean defaultValue) <p>Get a property as boolean.
Class<D>	getDescriptorType()
protected String	getDirectoryPath(File directory, File entry) <p>Return the relative path of a file within a directory.
String	getName()
protected Map<String,Object>	getProperties() <p>Get all properties.
protected <T> T	getProperty(String name, Class<T> type) <p>Get the value of a property.
protected com.buschmais.jqassistant.core.scanner.api.ScannerContext	getScannerContext() <p>Return the scanner context.
protected String	getStringProperty(String name, String defaultValue) <p>Get a property as string.
Class<? extends I>	getType()
protected <T> Class<T>	getTypeParameter(Class<?> expectedSuperClass, int genericTypeParameterIndex) <p>Determines the type parameter for a generic super class.
int	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

accepts, destroy, initialize, scan

Constructor Detail

AbstractScannerPlugin

public AbstractScannerPlugin()

Method Detail

configure

public final void configure(com.buschmais.jqassistant.core.scanner.api.ScannerContext scannerContext,
                            Map<String,Object> properties)

Specified by:

configure in interface com.buschmais.jqassistant.core.scanner.api.ScannerPlugin<I,D extends com.buschmais.jqassistant.core.store.api.model.Descriptor>

Specified by:

configure in interface com.buschmais.jqassistant.core.shared.lifecycle.ContextualConfigurableLifecycleAware<com.buschmais.jqassistant.core.scanner.api.ScannerContext,Map<String,Object>>

configure

protected void configure()

<p>Convenience method which might be overridden by sub-classes.</p>

getType

public Class<? extends I> getType()

Specified by:

getType in interface com.buschmais.jqassistant.core.scanner.api.ScannerPlugin<I,D extends com.buschmais.jqassistant.core.store.api.model.Descriptor>

getDescriptorType

public Class<D> getDescriptorType()

Specified by:

getDescriptorType in interface com.buschmais.jqassistant.core.scanner.api.ScannerPlugin<I,D extends com.buschmais.jqassistant.core.store.api.model.Descriptor>

getName

public String getName()

Specified by:

getName in interface com.buschmais.jqassistant.core.scanner.api.ScannerPlugin<I,D extends com.buschmais.jqassistant.core.store.api.model.Descriptor>

getTypeParameter

protected <T> Class<T> getTypeParameter(Class<?> expectedSuperClass,
                                        int genericTypeParameterIndex)

<p>Determines the type parameter for a generic super class.</p>

Parameters:

expectedSuperClass - The generic super class.

genericTypeParameterIndex - The index, e.g. 0 for the first.

Returns:

The type parameter.

getProperties

protected Map<String,Object> getProperties()

<p>Get all properties.</p>

Returns:

The properties.

getProperty

protected <T> T getProperty(String name,
                            Class<T> type)

<p>Get the value of a property.</p>

Type Parameters:

T - The type.

Parameters:

name - The name of the property.

type - The expected type.

Returns:

The value.

getStringProperty

protected String getStringProperty(String name,
                                   String defaultValue)

<p>Get a property as string.</p>

Parameters:

name - The name.

defaultValue - The default value.

Returns:

The value.

getBooleanProperty

protected Boolean getBooleanProperty(String name,
                                     Boolean defaultValue)

<p>Get a property as boolean.</p>

Parameters:

name - The name.

defaultValue - The default value.

Returns:

The value.

getScannerContext

protected com.buschmais.jqassistant.core.scanner.api.ScannerContext getScannerContext()

<p>Return the scanner context.</p>

Returns:

The scanner context.

getDirectoryPath

protected String getDirectoryPath(File directory,
                                  File entry)

<p>Return the relative path of a file within a directory.</p>

Parameters:

directory - The directory.

entry - The file.

Returns:

The relative path.

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object