Class 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 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
    • Constructor Detail

      • PluginHelpGenerator

        public PluginHelpGenerator()
        Default constructor
    • Method Detail

      • setHelpPackageName

        public PluginHelpGenerator setHelpPackageName​(java.lang.String helpPackageName)
      • 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)