sisu:index

Full name:

org.sonatype.plugins:sisu-maven-plugin:1.1:index

Description:

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

Attributes:

  • Requires a Maven 2.0 project to be executed.
  • Requires dependency resolution of artifacts in scope: test.

Optional Parameters

Name Type Since Description
excludeArtifactIds String - Comma separated list of ArtifactIds to exclude when indexing.
excludeClassifiers String - Comma Separated list of Classifiers to exclude when indexing.
excludeGroupIds String - Comma separated list of GroupIds to exclude when indexing.
excludeScope String - Scope to exclude. Empty string indicates no scopes (default).
excludeTransitive boolean - If we should exclude transitive dependencies when indexing.
Default value is: false.
excludeTypes String - Comma Separated list of Types to exclude when indexing.
includeArtifactIds String - Comma separated list of ArtifactIds to include when indexing.
includeClassifiers String - Comma Separated list of Classifiers to include when indexing.
includeDependencies boolean - If we should include project dependencies when indexing.
Default value is: true.
includeGroupIds String - Comma separated list of GroupIds to include when indexing.
includeScope String - Scope to include. Empty string indicates all scopes (default).
includeTypes String - Comma Separated list of Types to include when indexing.
outputDirectory File - (no description)
Default value is: ${project.build.outputDirectory}.

Parameter Details

excludeArtifactIds:

Comma separated list of ArtifactIds to exclude when indexing.
  • Type: java.lang.String
  • Required: No
  • Expression: ${excludeArtifactIds}

excludeClassifiers:

Comma Separated list of Classifiers to exclude when indexing.
  • Type: java.lang.String
  • Required: No
  • Expression: ${excludeClassifiers}

excludeGroupIds:

Comma separated list of GroupIds to exclude when indexing.
  • Type: java.lang.String
  • Required: No
  • Expression: ${excludeGroupIds}

excludeScope:

Scope to exclude. Empty string indicates no scopes (default).
  • Type: java.lang.String
  • Required: No
  • Expression: ${excludeScope}

excludeTransitive:

If we should exclude transitive dependencies when indexing.
  • Type: boolean
  • Required: No
  • Expression: ${excludeTransitive}
  • Default: false

excludeTypes:

Comma Separated list of Types to exclude when indexing.
  • Type: java.lang.String
  • Required: No
  • Expression: ${excludeTypes}

includeArtifactIds:

Comma separated list of ArtifactIds to include when indexing.
  • Type: java.lang.String
  • Required: No
  • Expression: ${includeArtifactIds}

includeClassifiers:

Comma Separated list of Classifiers to include when indexing.
  • Type: java.lang.String
  • Required: No
  • Expression: ${includeClassifiers}

includeDependencies:

If we should include project dependencies when indexing.
  • Type: boolean
  • Required: No
  • Expression: ${includeDependencies}
  • Default: true

includeGroupIds:

Comma separated list of GroupIds to include when indexing.
  • Type: java.lang.String
  • Required: No
  • Expression: ${includeGroupIds}

includeScope:

Scope to include. Empty string indicates all scopes (default).
  • Type: java.lang.String
  • Required: No
  • Expression: ${includeScope}

includeTypes:

Comma Separated list of Types to include when indexing.
  • Type: java.lang.String
  • Required: No
  • Expression: ${includeTypes}

outputDirectory:

(no description)
  • Type: java.io.File
  • Required: No
  • Expression: ${outputDirectory}
  • Default: ${project.build.outputDirectory}