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 (unlessinvokeGroovyDoc
isfalse
).- Since:
- 1.7.1
-
-
Field Summary
Fields Modifier and Type Field Description protected org.apache.maven.archiver.MavenArchiveConfiguration
archive
The archive configuration to use.private java.lang.String
artifactType
The artifact type for the GroovyDoc jar.protected boolean
attach
Specifies whether to attach the generated artifact to the project helper.private java.lang.String
classifier
The classifier for the GroovyDoc jar.protected java.io.File
defaultManifestFile
Path to the default MANIFEST file to use.protected java.lang.String
finalName
Specifies the filename that will be used for the generated jar file.protected boolean
invokeGroovyDoc
Whether to invoke thegroovydoc
goal before creating jar.protected org.codehaus.plexus.archiver.jar.JarArchiver
jarArchiver
The Jar archiver.protected java.lang.String
jarOutputDirectory
Specifies the directory where the generated jar file will be put.private org.apache.maven.project.MavenProjectHelper
projectHelper
Used for attaching the artifact in the project.private boolean
useDefaultManifestFile
Set this totrue
to enable the use of thedefaultManifestFile
.-
Fields inherited from class org.codehaus.gmavenplus.mojo.GroovyDocMojo
groovyDocJavaSources, groovyDocOutputDirectory, sources
-
Fields inherited from class org.codehaus.gmavenplus.mojo.AbstractGroovyDocMojo
attachGroovyDocAnnotation, classpathResourceManagerClass, defaultClassTemplates, defaultDocTemplates, defaultPackageTemplates, displayAuthor, docTitle, fileOutputToolClass, footer, GROOVY_1_5_2, GROOVY_1_5_8, GROOVY_1_6_0_RC1, GROOVY_1_6_0_RC2, GROOVY_3_0_0_ALPHA_4, groovyDocToolClass, header, includeClasspath, linkArgumentClass, links, outputToolClass, overviewFile, resourceManagerClass, scope, skipGroovyDoc, stylesheetEncoding, stylesheetFile, windowTitle
-
Fields inherited from class org.codehaus.gmavenplus.mojo.AbstractGroovySourcesMojo
MAIN, TEST
-
Fields inherited from class org.codehaus.gmavenplus.mojo.AbstractGroovyMojo
classWrangler, GROOVY_1_5_0, GROOVY_SOURCES_PATTERN, JAVA_1_7, JAVA_1_8, JAVA_12, JAVA_SOURCES_PATTERN, minGroovyVersion, mojoExecution, pluginArtifacts, project, session
-
-
Constructor Summary
Constructors Constructor Description GroovyDocJarMojo()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
execute()
Executes this mojo.protected java.io.File
generateArchive(java.io.File groovydocFiles, java.lang.String jarFileName)
Method that creates the jar file-
Methods inherited from class org.codehaus.gmavenplus.mojo.AbstractGroovyDocMojo
copyStylesheet, createGroovyDocTool, doGroovyDocGeneration, generateGroovyDoc, setupGroovyDocSources, setupLinks, setupProperties
-
Methods inherited from class org.codehaus.gmavenplus.mojo.AbstractGroovySourcesMojo
getFiles, getFilesets, getTestFiles, getTestFilesets
-
Methods inherited from class org.codehaus.gmavenplus.mojo.AbstractGroovyMojo
getJavaVersion, getJavaVersionString, groovyAtLeast, groovyIs, groovyNewerThan, groovyOlderThan, groovyVersionSupportsAction, isGroovyIndy, isJavaSupportIndy, isJavaSupportParameters, isJavaSupportPreviewFeatures, logPluginClasspath, setupClassWrangler
-
-
-
-
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 ifuseDefaultManifestFile
is set totrue
.
-
useDefaultManifestFile
@Parameter(defaultValue="false") private boolean useDefaultManifestFile
Set this totrue
to enable the use of thedefaultManifestFile
.
-
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 thegroovydoc
goal before creating jar.
-
-
Method Detail
-
execute
public void execute() throws org.apache.maven.plugin.MojoExecutionException
Executes this mojo.- Specified by:
execute
in interfaceorg.apache.maven.plugin.Mojo
- Overrides:
execute
in classGroovyDocMojo
- 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 putjarFileName
- 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 filejava.io.IOException
- When an IO issue occurs preventing Maven Archiver from creating the jar file
-
-