org.eclipse.sisu.mojos

Class IndexMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.eclipse.sisu.mojos.IndexMojo

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo

@Mojo(name="index",
      requiresDependencyResolution=TEST,
      threadSafe=true)
public class IndexMojo
extends org.apache.maven.plugin.AbstractMojo

Generates a qualified class index for the current project and its dependencies.

Field Summary

Fields

Modifier and Type	Field and Description
protected String	excludeArtifactIds Comma separated list of ArtifactIds to exclude when indexing.
protected String	excludeClassifiers Comma Separated list of Classifiers to exclude when indexing.
protected String	excludeGroupIds Comma separated list of GroupIds to exclude when indexing.
protected String	excludeScope Scope to exclude.
protected boolean	excludeTransitive If we should exclude transitive dependencies when indexing.
protected String	excludeTypes Comma Separated list of Types to exclude when indexing.
protected String	includeArtifactIds Comma separated list of ArtifactIds to include when indexing.
protected String	includeClassifiers Comma Separated list of Classifiers to include when indexing.
protected boolean	includeDependencies If we should include project dependencies when indexing.
protected String	includeGroupIds Comma separated list of GroupIds to include when indexing.
protected String	includeScope Scope to include.
protected String	includeTypes Comma Separated list of Types to include when indexing.
protected File	outputDirectory The output directory.

Fields inherited from interface org.apache.maven.plugin.Mojo

ROLE

Constructor Summary

Constructors

Constructor and Description
IndexMojo()

Method Summary

Methods

Modifier and Type	Method and Description
void	execute()
void	setOutputDirectory(File outputDirectory)
void	setProject(org.apache.maven.project.MavenProject project)

Methods inherited from class org.apache.maven.plugin.AbstractMojo

getLog, getPluginContext, setLog, setPluginContext

Methods inherited from class java.lang.Object

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

Field Detail

outputDirectory

@Parameter(property="outputDirectory",
           defaultValue="${project.build.outputDirectory}")
protected File outputDirectory

The output directory.

includeDependencies

@Parameter(property="includeDependencies",
           defaultValue="true")
protected boolean includeDependencies

If we should include project dependencies when indexing.

excludeGroupIds

@Parameter(property="excludeGroupIds",
           defaultValue="")
protected String excludeGroupIds

Comma separated list of GroupIds to exclude when indexing.

includeGroupIds

@Parameter(property="includeGroupIds",
           defaultValue="")
protected String includeGroupIds

Comma separated list of GroupIds to include when indexing.

excludeArtifactIds

@Parameter(property="excludeArtifactIds",
           defaultValue="")
protected String excludeArtifactIds

Comma separated list of ArtifactIds to exclude when indexing.

includeArtifactIds

@Parameter(property="includeArtifactIds",
           defaultValue="")
protected String includeArtifactIds

Comma separated list of ArtifactIds to include when indexing.

excludeClassifiers

@Parameter(property="excludeClassifiers",
           defaultValue="")
protected String excludeClassifiers

Comma Separated list of Classifiers to exclude when indexing.

includeClassifiers

@Parameter(property="includeClassifiers",
           defaultValue="")
protected String includeClassifiers

Comma Separated list of Classifiers to include when indexing.

excludeTypes

@Parameter(property="excludeTypes",
           defaultValue="")
protected String excludeTypes

Comma Separated list of Types to exclude when indexing.

includeTypes

@Parameter(property="includeTypes",
           defaultValue="")
protected String includeTypes

Comma Separated list of Types to include when indexing.

excludeScope

@Parameter(property="excludeScope",
           defaultValue="")
protected String excludeScope

Scope to exclude. Empty string indicates no scopes (default).

includeScope

@Parameter(property="includeScope",
           defaultValue="")
protected String includeScope

Scope to include. Empty string indicates all scopes (default).

excludeTransitive

@Parameter(property="excludeTransitive",
           defaultValue="false")
protected boolean excludeTransitive

If we should exclude transitive dependencies when indexing.

Constructor Detail

IndexMojo

public IndexMojo()

Method Detail

setProject

public void setProject(org.apache.maven.project.MavenProject project)

setOutputDirectory

public void setOutputDirectory(File outputDirectory)

execute

public void execute()