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 a
HelpMojo
class.
Relies at runtime on one output file from DescriptorGeneratorMojo
.- Since:
- 2.4
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate String
The name of the package for the generatedHelpMojo
.protected File
The directory where the generatedHelpMojo
file will be put.Fields inherited from class org.apache.maven.plugin.plugin.AbstractGeneratorMojo
goalPrefix, LS, project
Fields inherited from interface org.apache.maven.plugin.Mojo
ROLE
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected void
generate()
(package private) String
private String
prefixSpecialCase
(String name) Methods inherited from class org.apache.maven.plugin.plugin.AbstractGeneratorMojo
execute, getDefaultGoalPrefix
Methods inherited from class org.apache.maven.plugin.AbstractMojo
getLog, getPluginContext, setLog, setPluginContext
-
Field Details
-
outputDirectory
@Parameter(defaultValue="${project.build.directory}/generated-sources/plugin") protected File outputDirectoryThe directory where the generatedHelpMojo
file will be put. -
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
-
-
Constructor Details
-
HelpGeneratorMojo
public HelpGeneratorMojo()
-
-
Method Details
-
getHelpPackageName
String getHelpPackageName() -
prefixSpecialCase
-
generate
protected void generate() throws org.apache.maven.plugin.MojoExecutionException- Specified by:
generate
in classAbstractGeneratorMojo
- Throws:
org.apache.maven.plugin.MojoExecutionException
-