Package org.apache.maven.index.creator
Class MavenArchetypeArtifactInfoIndexCreator
- java.lang.Object
-
- org.apache.maven.index.creator.AbstractIndexCreator
-
- org.apache.maven.index.creator.MavenArchetypeArtifactInfoIndexCreator
-
- All Implemented Interfaces:
IndexCreator
@Singleton @Named("maven-archetype") public class MavenArchetypeArtifactInfoIndexCreator extends AbstractIndexCreator
A Maven Archetype index creator used to detect and correct the artifact packaging to "maven-archetype" if the inspected JAR is an Archetype. Since packaging is already handled by Minimal creator, this Creator only alters the supplied ArtifactInfo packaging field during processing, but does not interferes with Lucene document fill-up or the ArtifactInfo fill-up (the update* methods are empty).
-
-
Field Summary
Fields Modifier and Type Field Description private static java.lang.String[]
ARCHETYPE_XML_LOCATIONS
static java.lang.String
ID
private static java.lang.String
MAVEN_ARCHETYPE_PACKAGING
-
Constructor Summary
Constructors Constructor Description MavenArchetypeArtifactInfoIndexCreator()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description private void
checkMavenArchetype(ArtifactInfo ai, java.io.File artifact)
Archetypes that are added will have their packaging types set correctly (to maven-archetype)java.util.Collection<IndexerField>
getIndexerFields()
Returns the indexer fields that this IndexCreator introduces to index.void
populateArtifactInfo(ArtifactContext ac)
Populate anArtifactContext
with information about corresponding artifact.java.lang.String
toString()
boolean
updateArtifactInfo(org.apache.lucene.document.Document doc, ArtifactInfo ai)
Update anArtifactInfo
from given LuceneDocument
.void
updateDocument(ArtifactInfo ai, org.apache.lucene.document.Document doc)
Update LuceneDocument
from a givenArtifactInfo
.-
Methods inherited from class org.apache.maven.index.creator.AbstractIndexCreator
bos, getCreatorDependencies, getId, getLogger, sob
-
-
-
-
Field Detail
-
ID
public static final java.lang.String ID
- See Also:
- Constant Field Values
-
MAVEN_ARCHETYPE_PACKAGING
private static final java.lang.String MAVEN_ARCHETYPE_PACKAGING
- See Also:
- Constant Field Values
-
ARCHETYPE_XML_LOCATIONS
private static final java.lang.String[] ARCHETYPE_XML_LOCATIONS
-
-
Method Detail
-
populateArtifactInfo
public void populateArtifactInfo(ArtifactContext ac)
Description copied from interface:IndexCreator
Populate anArtifactContext
with information about corresponding artifact.
-
checkMavenArchetype
private void checkMavenArchetype(ArtifactInfo ai, java.io.File artifact)
Archetypes that are added will have their packaging types set correctly (to maven-archetype)- Parameters:
ai
-artifact
-
-
updateDocument
public void updateDocument(ArtifactInfo ai, org.apache.lucene.document.Document doc)
Description copied from interface:IndexCreator
Update LuceneDocument
from a givenArtifactInfo
.
-
updateArtifactInfo
public boolean updateArtifactInfo(org.apache.lucene.document.Document doc, ArtifactInfo ai)
Description copied from interface:IndexCreator
Update anArtifactInfo
from given LuceneDocument
.- Returns:
- true is artifact info has been updated
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
getIndexerFields
public java.util.Collection<IndexerField> getIndexerFields()
Description copied from interface:IndexCreator
Returns the indexer fields that this IndexCreator introduces to index.- Returns:
-
-