sisu:index

Full name:

org.eclipse.sisu:sisu-maven-plugin:0.3.5:index

Description:

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

Attributes:

  • Requires a Maven project to be executed.
  • Requires dependency resolution of artifacts in scope: test.
  • The goal is thread-safe and supports parallel builds.

Optional Parameters

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

Parameter Details

excludeArtifactIds:

Comma separated list of ArtifactIds to exclude when indexing.
  • Type: java.lang.String
  • Required: No
  • User Property: excludeArtifactIds

excludeClassifiers:

Comma Separated list of Classifiers to exclude when indexing.
  • Type: java.lang.String
  • Required: No
  • User Property: excludeClassifiers

excludeGroupIds:

Comma separated list of GroupIds to exclude when indexing.
  • Type: java.lang.String
  • Required: No
  • User Property: excludeGroupIds

excludeScope:

Scope to exclude. Empty string indicates no scopes (default).
  • Type: java.lang.String
  • Required: No
  • User Property: excludeScope

excludeTransitive:

If we should exclude transitive dependencies when indexing.
  • Type: boolean
  • Required: No
  • User Property: excludeTransitive
  • Default: false

excludeTypes:

Comma Separated list of Types to exclude when indexing.
  • Type: java.lang.String
  • Required: No
  • User Property: excludeTypes

includeArtifactIds:

Comma separated list of ArtifactIds to include when indexing.
  • Type: java.lang.String
  • Required: No
  • User Property: includeArtifactIds

includeClassifiers:

Comma Separated list of Classifiers to include when indexing.
  • Type: java.lang.String
  • Required: No
  • User Property: includeClassifiers

includeDependencies:

If we should include project dependencies when indexing.
  • Type: boolean
  • Required: No
  • User Property: includeDependencies
  • Default: true

includeGroupIds:

Comma separated list of GroupIds to include when indexing.
  • Type: java.lang.String
  • Required: No
  • User Property: includeGroupIds

includeScope:

Scope to include. Empty string indicates all scopes (default).
  • Type: java.lang.String
  • Required: No
  • User Property: includeScope

includeTypes:

Comma Separated list of Types to include when indexing.
  • Type: java.lang.String
  • Required: No
  • User Property: includeTypes

outputDirectory:

The output directory.
  • Type: java.io.File
  • Required: No
  • User Property: outputDirectory
  • Default: ${project.build.outputDirectory}