Package org.apache.maven.plugin.plugin
Class HelpGeneratorMojo
- java.lang.Object
-
- org.apache.maven.plugin.AbstractMojo
-
- org.apache.maven.plugin.plugin.AbstractGeneratorMojo
-
- org.apache.maven.plugin.plugin.HelpGeneratorMojo
-
- All Implemented Interfaces:
org.apache.maven.plugin.ContextEnabled
,org.apache.maven.plugin.Mojo
@Mojo(name="helpmojo", defaultPhase=GENERATE_SOURCES, threadSafe=true, requiresDependencyResolution=COMPILE) public class HelpGeneratorMojo extends AbstractGeneratorMojo
Generates aHelpMojo
class. Relies at runtime on one output file fromDescriptorGeneratorMojo
.- Since:
- 2.4
-
-
Field Summary
Fields Modifier and Type Field Description private java.lang.String
helpPackageName
The name of the package for the generatedHelpMojo
.protected java.io.File
outputDirectory
The directory where the generatedHelpMojo
file will be put.-
Fields inherited from class org.apache.maven.plugin.plugin.AbstractGeneratorMojo
goalPrefix, LS, project
-
-
Constructor Summary
Constructors Constructor Description HelpGeneratorMojo()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected void
generate()
(package private) java.lang.String
getHelpPackageName()
private java.lang.String
prefixSpecialCase(java.lang.String name)
-
Methods inherited from class org.apache.maven.plugin.plugin.AbstractGeneratorMojo
execute, getDefaultGoalPrefix
-
-
-
-
Field Detail
-
outputDirectory
@Parameter(defaultValue="${project.build.directory}/generated-sources/plugin") protected java.io.File outputDirectory
The directory where the generatedHelpMojo
file will be put.
-
helpPackageName
@Parameter private java.lang.String helpPackageName
The name of the package for the generatedHelpMojo
.By default, the package name will be calculated as
groupId + "." + artifactId
with additional-
(dashes) will be replaced by_
(underscores)_
(underscore) will be added before each number or Java keyword at the beginning of name
- Since:
- 2.6
-
-
Method Detail
-
getHelpPackageName
java.lang.String getHelpPackageName()
-
prefixSpecialCase
private java.lang.String prefixSpecialCase(java.lang.String name)
-
generate
protected void generate() throws org.apache.maven.plugin.MojoExecutionException
- Specified by:
generate
in classAbstractGeneratorMojo
- Throws:
org.apache.maven.plugin.MojoExecutionException
-
-