Package org.codehaus.gmavenplus.mojo

Class GroovyDocJarMojo

java.lang.Object
org.apache.maven.plugin.AbstractMojo
org.codehaus.gmavenplus.mojo.AbstractGroovyMojo
org.codehaus.gmavenplus.mojo.AbstractGroovySourcesMojo
org.codehaus.gmavenplus.mojo.AbstractGroovyDocMojo
org.codehaus.gmavenplus.mojo.GroovyDocMojo
org.codehaus.gmavenplus.mojo.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
Author:
Keegan Witt

  • Field Details

    • finalName

      @Parameter(property="project.build.finalName") protected 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 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.

    • defaultManifestFile

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

    • invokeGroovyDoc

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

  • Constructor Details

    • GroovyDocJarMojo

      public GroovyDocJarMojo()

  • Method Details

    • 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 File generateArchive(File groovydocFiles, String jarFileName) throws org.codehaus.plexus.archiver.ArchiverException, 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
      IOException - When an IO issue occurs preventing Maven Archiver from creating the jar file