AbstractIndexCreator (Maven :: Indexer 5.1.1 API)

Prev Class
Next Class

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

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.

Author:

Jason van Zyl

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`AbstractIndexCreator(String id)`
`protected`	`AbstractIndexCreator(String id, List<String> creatorDependencies)`

Method Summary

Methods
Modifier and Type	Method and Description
`static String`	`bos(boolean b)`
`List<String>`	`getCreatorDependencies()` Returns list of IndexCreator IDs that this creator depends on.
`String`	`getId()` Returns IndexCreator ID, that has to be unique across all existing creators.
`static boolean`	`sob(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

- Constructor Detail
  - AbstractIndexCreator
```
protected AbstractIndexCreator(String id)
```
  - AbstractIndexCreator
```
protected AbstractIndexCreator(String id,
                    List<String> creatorDependencies)
```
- Method Detail
  - getId
```
public 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 List<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 String bos(boolean b)
```
  - sob
```
public static boolean sob(String b)
```

Prev Class
Next Class

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

Copyright © 2002-2013 The Apache Software Foundation. All Rights Reserved.