Package org.apache.maven.plugins.jar

Class TestJarMojo

  • All Implemented Interfaces:
    org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo
    @Mojo(name="test-jar",
      defaultPhase=PACKAGE,
      requiresProject=true,
      threadSafe=true,
      requiresDependencyResolution=TEST)
public class TestJarMojo
extends AbstractJarMojo
    Build a JAR of the test classes for the current project.
    Version:
    $Id$

    • Field Summary

      Fields 
      Modifier and Type Field Description
      private java.lang.String classifier
      Classifier to used for test-jar.
      private boolean skip
      Set this to true to bypass test-jar generation.
      private java.io.File testClassesDirectory
      Directory containing the test classes and resource files that should be packaged into the JAR.

      • Fields inherited from interface org.apache.maven.plugin.Mojo

        ROLE

    • Constructor Summary

      Constructors 
      Constructor Description
      TestJarMojo()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void execute()
      Generates the JAR.
      protected java.io.File getClassesDirectory()
      Return the specific output directory to serve as the root for the archive.
      protected java.lang.String getClassifier()
      Overload this to produce a jar with another classifier, for example a test-jar.
      protected java.lang.String getType()
      Overload this to produce a test-jar, for example.

      • Methods inherited from class org.apache.maven.plugin.AbstractMojo

        getLog, getPluginContext, setLog, setPluginContext

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Field Detail

      • skip

        @Parameter(property="maven.test.skip")
private boolean skip
        Set this to true to bypass test-jar generation. Its use is NOT RECOMMENDED, but quite convenient on occasion.

      • testClassesDirectory

        @Parameter(defaultValue="${project.build.testOutputDirectory}",
           required=true)
private java.io.File testClassesDirectory
        Directory containing the test classes and resource files that should be packaged into the JAR.

      • classifier

        @Parameter(defaultValue="tests")
private java.lang.String classifier
        Classifier to used for test-jar.

    • Constructor Detail

      • TestJarMojo

        public TestJarMojo()

    • Method Detail

      • getClassifier

        protected java.lang.String getClassifier()
        Overload this to produce a jar with another classifier, for example a test-jar.
        Specified by:
        getClassifier in class AbstractJarMojo
        Returns:
        get the classifier.

      • getType

        protected java.lang.String getType()
        Overload this to produce a test-jar, for example.
        Specified by:
        getType in class AbstractJarMojo
        Returns:
        return the type.

      • getClassesDirectory

        protected java.io.File getClassesDirectory()
        Return the specific output directory to serve as the root for the archive.
        Specified by:
        getClassesDirectory in class AbstractJarMojo
        Returns:
        get classes directory.

      • execute

        public void execute()
             throws org.apache.maven.plugin.MojoExecutionException
        Generates the JAR.
        Specified by:
        execute in interface org.apache.maven.plugin.Mojo
        Overrides:
        execute in class AbstractJarMojo
        Throws:
        org.apache.maven.plugin.MojoExecutionException - in case of an error.