org.apache.maven.index.creator

Class AbstractIndexCreator

java.lang.Object

org.codehaus.plexus.logging.AbstractLogEnabled

org.apache.maven.index.creator.AbstractIndexCreator

All Implemented Interfaces:

IndexCreator, org.codehaus.plexus.logging.LogEnabled

Direct Known Subclasses:

JarFileContentsIndexCreator, MavenArchetypeArtifactInfoIndexCreator, MavenPluginArtifactInfoIndexCreator, MinimalArtifactInfoIndexCreator, OsgiArtifactIndexCreator

public abstract class AbstractIndexCreator
extends org.codehaus.plexus.logging.AbstractLogEnabled
implements IndexCreator

An abstract base class for IndexCreator implementations.

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.List<java.lang.String>	creatorDependencies
private java.lang.String	id

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractIndexCreator(java.lang.String id)
protected	AbstractIndexCreator(java.lang.String id, java.util.List<java.lang.String> creatorDependencies)

Method Summary

Modifier and Type	Method and Description
static java.lang.String	bos(boolean b)
java.util.List<java.lang.String>	getCreatorDependencies() Returns list of IndexCreator IDs that this creator depends on.
java.lang.String	getId() Returns IndexCreator ID, that has to be unique across all existing creators.
static boolean	sob(java.lang.String b)

Methods inherited from class org.codehaus.plexus.logging.AbstractLogEnabled

enableLogging, getLogger, setupLogger, setupLogger, setupLogger

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.maven.index.context.IndexCreator

getIndexerFields, populateArtifactInfo, updateArtifactInfo, updateDocument

Field Detail

id

private final java.lang.String id

creatorDependencies

private final java.util.List<java.lang.String> creatorDependencies

Constructor Detail

AbstractIndexCreator

protected AbstractIndexCreator(java.lang.String id)

AbstractIndexCreator

protected AbstractIndexCreator(java.lang.String id,
                               java.util.List<java.lang.String> creatorDependencies)

Method Detail

getId

public java.lang.String getId()

Description copied from interface: IndexCreator

Returns IndexCreator ID, that has to be unique across all existing creators.

Specified by:

getId in interface IndexCreator

Returns:

getCreatorDependencies

public java.util.List<java.lang.String> getCreatorDependencies()

Description copied from interface: IndexCreator

Returns list of IndexCreator IDs that this creator depends on. Needed to perform a topological sort on IndexCreators to guarantee proper ordering of them, as some IndexCreators might rely on informations already extracted by some other IndexCreator.

Specified by:

getCreatorDependencies in interface IndexCreator

Returns:

bos

public static java.lang.String bos(boolean b)

sob

public static boolean sob(java.lang.String b)