jar:test-jar

Full name:

org.apache.maven.plugins:maven-jar-plugin:2.3.2:test-jar

Description:

Build a JAR of the test classes for the current project.

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.
  • Binds by default to the lifecycle phase: package.

Required Parameters

Name Type Since Description
finalName String - Name of the generated JAR.
Default value is: ${project.build.finalName}.
outputDirectory File - Directory containing the generated JAR.
Default value is: ${project.build.directory}.
testClassesDirectory File - Directory containing the test classes and resource files that should be packaged into the JAR.
Default value is: ${project.build.testOutputDirectory}.

Optional Parameters

Name Type Since Description
archive MavenArchiveConfiguration - The archive configuration to use. See Maven Archiver Reference.
excludes String[] - List of files to exclude. Specified as fileset patterns which are relative to the input directory whose contents is being packaged into the JAR.
forceCreation boolean - Whether creating the archive should be forced.
Default value is: false.
includes String[] - List of files to include. Specified as fileset patterns which are relative to the input directory whose contents is being packaged into the JAR.
skip boolean - Set this to true to bypass unit tests entirely. Its use is NOT RECOMMENDED, but quite convenient on occasion.
useDefaultManifestFile boolean 2.2 Set this to true to enable the use of the defaultManifestFile.
Default value is: false.

Parameter Details

archive:

The archive configuration to use. See Maven Archiver Reference.
  • Type: org.apache.maven.archiver.MavenArchiveConfiguration
  • Required: No

excludes:

List of files to exclude. Specified as fileset patterns which are relative to the input directory whose contents is being packaged into the JAR.
  • Type: java.lang.String[]
  • Required: No

finalName:

Name of the generated JAR.
  • Type: java.lang.String
  • Required: Yes
  • Expression: ${jar.finalName}
  • Default: ${project.build.finalName}

forceCreation:

Whether creating the archive should be forced.
  • Type: boolean
  • Required: No
  • Expression: ${jar.forceCreation}
  • Default: false

includes:

List of files to include. Specified as fileset patterns which are relative to the input directory whose contents is being packaged into the JAR.
  • Type: java.lang.String[]
  • Required: No

outputDirectory:

Directory containing the generated JAR.
  • Type: java.io.File
  • Required: Yes
  • Default: ${project.build.directory}

skip:

Set this to true to bypass unit tests entirely. Its use is NOT RECOMMENDED, but quite convenient on occasion.
  • Type: boolean
  • Required: No
  • Expression: ${maven.test.skip}

testClassesDirectory:

Directory containing the test classes and resource files that should be packaged into the JAR.
  • Type: java.io.File
  • Required: Yes
  • Default: ${project.build.testOutputDirectory}

useDefaultManifestFile:

Set this to true to enable the use of the defaultManifestFile.
  • Type: boolean
  • Since: 2.2
  • Required: No
  • Expression: ${jar.useDefaultManifestFile}
  • Default: false