Class PluginHelpGenerator
- java.lang.Object
-
- org.codehaus.plexus.logging.AbstractLogEnabled
-
- org.apache.maven.tools.plugin.generator.PluginHelpGenerator
-
- All Implemented Interfaces:
org.codehaus.plexus.logging.LogEnabled
public class PluginHelpGenerator extends org.codehaus.plexus.logging.AbstractLogEnabled
Generates anHelpMojo
class fromhelp-class-source.vm
template. The generated mojo reads help content fromMETA-INF/maven/${groupId}/${artifactId}/plugin-help.xml
resource, which is generated by thisPluginDescriptorFilesGenerator
.- Since:
- 2.4
-
-
Field Summary
Fields Modifier and Type Field Description private java.lang.String
goalPrefix
private static java.lang.String
HELP_MOJO_CLASS_NAME
Default generated class nameprivate java.lang.String
helpPackageName
private org.apache.maven.project.MavenProject
mavenProject
private boolean
useMaven4Api
-
Constructor Summary
Constructors Constructor Description PluginHelpGenerator()
Default constructor
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description void
execute(java.io.File destinationDirectory)
private java.lang.String
getHelpClassSources(java.lang.String pluginHelpPath)
private java.lang.String
getImplementation()
(package private) static java.lang.String
getPluginHelpPath(org.apache.maven.project.MavenProject mavenProject)
PluginHelpGenerator
setGoalPrefix(java.lang.String goalPrefix)
PluginHelpGenerator
setHelpPackageName(java.lang.String helpPackageName)
PluginHelpGenerator
setMavenProject(org.apache.maven.project.MavenProject mavenProject)
-
-
-
Field Detail
-
HELP_MOJO_CLASS_NAME
private static final java.lang.String HELP_MOJO_CLASS_NAME
Default generated class name- See Also:
- Constant Field Values
-
helpPackageName
private java.lang.String helpPackageName
-
goalPrefix
private java.lang.String goalPrefix
-
mavenProject
private org.apache.maven.project.MavenProject mavenProject
-
useMaven4Api
private boolean useMaven4Api
-
-
Method Detail
-
execute
public void execute(java.io.File destinationDirectory) throws GeneratorException
- Throws:
GeneratorException
-
setHelpPackageName
public PluginHelpGenerator setHelpPackageName(java.lang.String helpPackageName)
-
setGoalPrefix
public PluginHelpGenerator setGoalPrefix(java.lang.String goalPrefix)
-
setMavenProject
public PluginHelpGenerator setMavenProject(org.apache.maven.project.MavenProject mavenProject)
-
getHelpClassSources
private java.lang.String getHelpClassSources(java.lang.String pluginHelpPath) throws java.io.IOException
- Throws:
java.io.IOException
-
getImplementation
private java.lang.String getImplementation()
- Returns:
- The implementation.
-
getPluginHelpPath
static java.lang.String getPluginHelpPath(org.apache.maven.project.MavenProject mavenProject)
-
-