minijar:ueberjar

Full name:

org.codehaus.mojo:minijar-maven-plugin:1.0-alpha-4-SNAPSHOT:ueberjar

Description:

Creates an ueberjar including all dependencies into one jar.

Attributes:

  • Requires a Maven 2.0 project to be executed.
  • Requires dependency resolution of artifacts in scope: compile.
  • Invokes the execution of the lifecycle phase package prior to executing itself.

Optional Parameters

Name Type Since Description
excludeDependencies HashSet - If provided the default is to include all dependencies but remove the ones specified. This parameter is mutual exclusive to includeDependencies.
excludeDependenciesInRelocation HashSet - If provided the default is to relocate all dependencies but exclude the ones specified. This parameter is mutual exclusive to includeDependenciesInRelocation.
includeArtifact boolean - Defines whether the original artifact should be include so that the ueberjar is basically self contained. If set to false the ueberjar will only include the dependencies of the project.
Default value is: true.
includeDependencies HashSet - If provided the default is to include no dependencies but the ones specified. This parameter is mutual exclusive to excludeDependencies.
includeDependenciesInRelocation HashSet - If provided the default is to relocate no dependencies but the ones specified. This parameter is mutual exclusive to excludeDependenciesInRelocation.
keepUnusedClasses HashSet - Explicitly mark classes matching the given patterns to be kept - no matter whether the analysis of minijar suggests otherwise.
keepUnusedClassesFromArtifacts HashSet - Explicitly mark all classes from the specified artifacts to be kept - no matter whether the analysis of minijar would suggest to remove (some of) them.
name String - Defines the pattern of the name of final ueber jar. Possible substitutions are [artifactId] [version] and [groupId].
Default value is: [artifactId]-[version]-ueber.jar.
replaceArtifact boolean - By default the new ueberjar gets attached as an additional artifact. If you want to replace the orignal artifact set this to true.
Default value is: false.
stripUnusedClasses boolean - By default minijar will analyse the class dependencies and remove classes that are not required for the execution of the project. See the "keep.." parameters to explicitly override the behaviour for classes or resource that only loaded via reflection or set this parameter to false to turn off the magic.
Default value is: true.

Parameter Details

excludeDependencies:

If provided the default is to include all dependencies but remove the ones specified. This parameter is mutual exclusive to includeDependencies.
  • Type: java.util.HashSet
  • Required: No
  • Expression: ${excludeDependencies}

excludeDependenciesInRelocation:

If provided the default is to relocate all dependencies but exclude the ones specified. This parameter is mutual exclusive to includeDependenciesInRelocation.
  • Type: java.util.HashSet
  • Required: No
  • Expression: ${excludeDependenciesInRelocation}

includeArtifact:

Defines whether the original artifact should be include so that the ueberjar is basically self contained. If set to false the ueberjar will only include the dependencies of the project.
  • Type: boolean
  • Required: No
  • Expression: ${includeArtifact}
  • Default: true

includeDependencies:

If provided the default is to include no dependencies but the ones specified. This parameter is mutual exclusive to excludeDependencies.
  • Type: java.util.HashSet
  • Required: No
  • Expression: ${includeDependencies}

includeDependenciesInRelocation:

If provided the default is to relocate no dependencies but the ones specified. This parameter is mutual exclusive to excludeDependenciesInRelocation.
  • Type: java.util.HashSet
  • Required: No
  • Expression: ${includeDependenciesInRelocation}

keepUnusedClasses:

Explicitly mark classes matching the given patterns to be kept - no matter whether the analysis of minijar suggests otherwise.
  • Type: java.util.HashSet
  • Required: No
  • Expression: ${keepUnusedClasses}

keepUnusedClassesFromArtifacts:

Explicitly mark all classes from the specified artifacts to be kept - no matter whether the analysis of minijar would suggest to remove (some of) them.
  • Type: java.util.HashSet
  • Required: No
  • Expression: ${keepUnusedClassesFromArtifacts}

name:

Defines the pattern of the name of final ueber jar. Possible substitutions are [artifactId] [version] and [groupId].
  • Type: java.lang.String
  • Required: No
  • Expression: ${name}
  • Default: [artifactId]-[version]-ueber.jar

replaceArtifact:

By default the new ueberjar gets attached as an additional artifact. If you want to replace the orignal artifact set this to true.
  • Type: boolean
  • Required: No
  • Expression: ${replaceArtifact}
  • Default: false

stripUnusedClasses:

By default minijar will analyse the class dependencies and remove classes that are not required for the execution of the project. See the "keep.." parameters to explicitly override the behaviour for classes or resource that only loaded via reflection or set this parameter to false to turn off the magic.
  • Type: boolean
  • Required: No
  • Expression: ${stripUnusedClasses}
  • Default: true