Package org.codehaus.gmavenplus.mojo

Class GroovyDocJarMojo

  • All Implemented Interfaces:
    org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo
    @Mojo(name="groovydoc-jar",
      defaultPhase=PACKAGE,
      requiresDependencyResolution=COMPILE,
      threadSafe=true)
public class GroovyDocJarMojo
extends GroovyDocMojo
    Create a GroovyDoc jar for the main sources. Note by default this will also invoke the groovydoc 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 -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.

      • classifier

        @Parameter(defaultValue="groovydoc")
private java.lang.String classifier
        The classifier for the GroovyDoc jar.

      • artifactType

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

      • invokeGroovyDoc

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

    • Constructor Detail

      • GroovyDocJarMojo

        public GroovyDocJarMojo()

    • 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 GroovyDocMojo
        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