Fork me on GitHub
Built by Maven

sisu:index

Full name:

org.eclipse.sisu:sisu-maven-plugin:0.9.0-SNAPSHOT: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: excludeArtifactIds
<excludeClassifiers> String - Comma Separated list of Classifiers to exclude when indexing.
User Property: excludeClassifiers
<excludeGroupIds> String - Comma separated list of GroupIds to exclude when indexing.
User Property: excludeGroupIds
<excludeScope> String - Scope to exclude. Empty string indicates no scopes (default).
User Property: excludeScope
<excludeTransitive> boolean - If we should exclude transitive dependencies when indexing.
Default: false
User Property: excludeTransitive
<excludeTypes> String - Comma Separated list of Types to exclude when indexing.
User Property: excludeTypes
<includeArtifactIds> String - Comma separated list of ArtifactIds to include when indexing.
User Property: includeArtifactIds
<includeClassifiers> String - Comma Separated list of Classifiers to include when indexing.
User Property: includeClassifiers
<includeDependencies> boolean - If we should include project dependencies when indexing.
Default: true
User Property: includeDependencies
<includeGroupIds> String - Comma separated list of GroupIds to include when indexing.
User Property: includeGroupIds
<includeScope> String - Scope to include. Empty string indicates all scopes (default).
User Property: includeScope
<includeTypes> String - Comma Separated list of Types to include when indexing.
User Property: includeTypes
<outputDirectory> File - The output directory.
Default: ${project.build.outputDirectory}
User Property: 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}