Class GroovyDocTestsJarMojo

  • All Implemented Interfaces:
    org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo

    @Mojo(name="groovydocTests-jar",
          defaultPhase=PACKAGE,
          requiresDependencyResolution=TEST,
          threadSafe=true)
    public class GroovyDocTestsJarMojo
    extends GroovyDocTestsMojo
    Create a GroovyDoc jar for the test sources. Note by default this will also invoke the groovydocTests goal (unless invokeGroovyDoc is false).
    Since:
    1.7.1
    • Field Detail

      • finalName

        @Parameter(property="project.build.finalName")
        protected java.lang.String finalName
        Specifies the filename that will be used for the generated jar file. Please note that -test-groovydoc will be appended to the file name.
      • jarOutputDirectory

        @Parameter(property="project.build.directory")
        protected java.lang.String jarOutputDirectory
        Specifies the directory where the generated jar file will be put.
      • jarArchiver

        @Component(role=org.codehaus.plexus.archiver.Archiver.class,
                   hint="jar")
        protected org.codehaus.plexus.archiver.jar.JarArchiver jarArchiver
        The Jar archiver.
      • archive

        @Parameter
        protected final org.apache.maven.archiver.MavenArchiveConfiguration archive
        The archive configuration to use. See Maven Archiver Reference.
      • attach

        @Parameter(property="attach",
                   defaultValue="true")
        protected boolean attach
        Specifies whether to attach the generated artifact to the project helper.
      • projectHelper

        @Component
        private org.apache.maven.project.MavenProjectHelper projectHelper
        Used for attaching the artifact in the project.
      • defaultManifestFile

        @Parameter(defaultValue="${project.build.outputDirectory}/META-INF/MANIFEST.MF",
                   required=true,
                   readonly=true)
        protected java.io.File defaultManifestFile
        Path to the default MANIFEST file to use. It will be used if useDefaultManifestFile is set to true.
      • useDefaultManifestFile

        @Parameter(defaultValue="false")
        private boolean useDefaultManifestFile
        Set this to true to enable the use of the defaultManifestFile.
      • testClassifier

        @Parameter(defaultValue="test-groovydoc")
        private java.lang.String testClassifier
        The classifier for the test GroovyDoc jar.
      • testArtifactType

        @Parameter(defaultValue="javadoc")
        private java.lang.String testArtifactType
        The artifact type for the test GroovyDoc jar.
        Since:
        1.10.0
      • invokeGroovyDoc

        @Parameter(defaultValue="true")
        protected boolean invokeGroovyDoc
        Whether to invoke the groovydocTests goal before creating jar.
    • Constructor Detail

      • GroovyDocTestsJarMojo

        public GroovyDocTestsJarMojo()
    • Method Detail

      • execute

        public void execute()
                     throws org.apache.maven.plugin.MojoExecutionException
        Executes this mojo.
        Specified by:
        execute in interface org.apache.maven.plugin.Mojo
        Overrides:
        execute in class GroovyDocTestsMojo
        Throws:
        org.apache.maven.plugin.MojoExecutionException - If an unexpected problem occurs (causes a "BUILD ERROR" message to be displayed)
      • generateArchive

        protected java.io.File generateArchive​(java.io.File groovydocFiles,
                                               java.lang.String jarFileName)
                                        throws org.codehaus.plexus.archiver.ArchiverException,
                                               java.io.IOException
        Method that creates the jar file
        Parameters:
        groovydocFiles - the directory where the generated jar file will be put
        jarFileName - the filename of the generated jar file
        Returns:
        a File object that contains the generated jar file
        Throws:
        org.codehaus.plexus.archiver.ArchiverException - When an issue occurs preventing Maven Archiver from creating the jar file
        java.io.IOException - When an IO issue occurs preventing Maven Archiver from creating the jar file