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 an
HelpMojo
class from help-class-source.vm
template.
The generated mojo reads help content from META-INF/maven/${groupId}/${artifactId}/plugin-help.xml
resource, which is generated by this PluginDescriptorFilesGenerator
.- Since:
- 2.4
-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
private String
getHelpClassSources
(String pluginHelpPath) private String
(package private) static String
getPluginHelpPath
(org.apache.maven.project.MavenProject mavenProject) setGoalPrefix
(String goalPrefix) setHelpPackageName
(String helpPackageName) setMavenProject
(org.apache.maven.project.MavenProject mavenProject) Methods inherited from class org.codehaus.plexus.logging.AbstractLogEnabled
enableLogging, getLogger, setupLogger, setupLogger, setupLogger
-
Field Details
-
HELP_MOJO_CLASS_NAME
Default generated class name- See Also:
-
helpPackageName
-
goalPrefix
-
mavenProject
private org.apache.maven.project.MavenProject mavenProject -
useMaven4Api
private boolean useMaven4Api
-
-
Constructor Details
-
PluginHelpGenerator
public PluginHelpGenerator()Default constructor
-
-
Method Details
-
execute
- Throws:
GeneratorException
-
setHelpPackageName
-
setGoalPrefix
-
setMavenProject
-
getHelpClassSources
- Throws:
IOException
-
getImplementation
- Returns:
- The implementation.
-
getPluginHelpPath
-