Package org.apache.maven.tools.plugin.generator

Class PluginXdocGenerator

  • All Implemented Interfaces:
    Generator
    public class PluginXdocGenerator
extends java.lang.Object
implements Generator
    Generate xdoc documentation for each mojo.

    • Field Summary

      Fields 
      Modifier and Type Field Description
      private java.util.Locale locale
      locale
      private org.apache.maven.project.MavenProject project
      project

    • Constructor Summary

      Constructors 
      Constructor Description
      PluginXdocGenerator()
      Default constructor using Locale.ENGLISH as locale.
      PluginXdocGenerator​(org.apache.maven.project.MavenProject project)
      Constructor using Locale.ENGLISH as locale.
      PluginXdocGenerator​(org.apache.maven.project.MavenProject project, java.util.Locale locale)  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      private boolean addUl​(org.codehaus.plexus.util.xml.XMLWriter w, boolean addedUl)  
      private boolean addUl​(org.codehaus.plexus.util.xml.XMLWriter w, boolean addedUl, java.lang.String content)  
      private java.lang.String escapeXml​(java.lang.String text)  
      void execute​(java.io.File destinationDirectory, PluginToolsRequest request)
      Execute the generation for a given plugin descriptor.
      private java.util.List<org.apache.maven.plugin.descriptor.Parameter> filterParameters​(java.util.List<org.apache.maven.plugin.descriptor.Parameter> parameterList)
      Filter parameters to only retain those which must be documented, ie not components nor readonly.
      private java.lang.String format​(java.lang.String key, java.lang.Object arg1)
      Convenience method.
      private java.lang.String format​(java.lang.String key, java.lang.Object[] args)
      Looks up the value for key in the ResourceBundle, then formats that value for the specified Locale using args.
      private java.util.ResourceBundle getBundle()
      Gets the resource bundle for the locale instance variable.
      private java.lang.String getMojoFilename​(org.apache.maven.plugin.descriptor.MojoDescriptor mojo, java.lang.String ext)  
      private java.util.List<org.apache.maven.plugin.descriptor.Parameter> getParametersByRequired​(boolean required, java.util.List<org.apache.maven.plugin.descriptor.Parameter> parameterList)  
      private java.lang.String getPropertyFromExpression​(java.lang.String expression)  
      private java.lang.String getString​(java.lang.String key)  
      protected void processMojoDescriptor​(org.apache.maven.plugin.descriptor.MojoDescriptor mojoDescriptor, java.io.File destinationDirectory)  
      private void writeBody​(org.apache.maven.plugin.descriptor.MojoDescriptor mojoDescriptor, org.codehaus.plexus.util.xml.XMLWriter w)  
      private void writeDetail​(java.lang.String param, java.lang.String value, org.codehaus.plexus.util.xml.XMLWriter w)  
      private void writeGoalAttributes​(org.apache.maven.plugin.descriptor.MojoDescriptor mojoDescriptor, org.codehaus.plexus.util.xml.XMLWriter w)  
      private void writeGoalParameterTable​(org.apache.maven.plugin.descriptor.MojoDescriptor mojoDescriptor, org.codehaus.plexus.util.xml.XMLWriter w)  
      private void writeParameterDetails​(org.apache.maven.plugin.descriptor.MojoDescriptor mojoDescriptor, java.util.List<org.apache.maven.plugin.descriptor.Parameter> parameterList, org.codehaus.plexus.util.xml.XMLWriter w)  
      private void writeParameterList​(org.apache.maven.plugin.descriptor.MojoDescriptor mojoDescriptor, java.lang.String title, java.util.List<org.apache.maven.plugin.descriptor.Parameter> parameterList, org.codehaus.plexus.util.xml.XMLWriter w)  
      private void writeParameterSummary​(org.apache.maven.plugin.descriptor.MojoDescriptor mojoDescriptor, java.util.List<org.apache.maven.plugin.descriptor.Parameter> parameterList, org.codehaus.plexus.util.xml.XMLWriter w)  
      private void writeReportNotice​(org.apache.maven.plugin.descriptor.MojoDescriptor mojoDescriptor, org.codehaus.plexus.util.xml.XMLWriter w)  

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Field Detail

      • locale

        private final java.util.Locale locale
        locale

      • project

        private final org.apache.maven.project.MavenProject project
        project

    • Constructor Detail

      • PluginXdocGenerator

        public PluginXdocGenerator()
        Default constructor using Locale.ENGLISH as locale. Used only in test cases.

      • PluginXdocGenerator

        public PluginXdocGenerator​(org.apache.maven.project.MavenProject project)
        Constructor using Locale.ENGLISH as locale.
        Parameters:
        project - not null Maven project.

      • PluginXdocGenerator

        public PluginXdocGenerator​(org.apache.maven.project.MavenProject project,
                           java.util.Locale locale)
        Parameters:
        project - not null.
        locale - not null wanted locale.

    • Method Detail

      • processMojoDescriptor

        protected void processMojoDescriptor​(org.apache.maven.plugin.descriptor.MojoDescriptor mojoDescriptor,
                                     java.io.File destinationDirectory)
                              throws java.io.IOException
        Parameters:
        mojoDescriptor - not null
        destinationDirectory - not null
        Throws:
        java.io.IOException - if any

      • getMojoFilename

        private java.lang.String getMojoFilename​(org.apache.maven.plugin.descriptor.MojoDescriptor mojo,
                                         java.lang.String ext)
        Parameters:
        mojo - not null
        ext - not null
        Returns:
        the output file name

      • writeBody

        private void writeBody​(org.apache.maven.plugin.descriptor.MojoDescriptor mojoDescriptor,
                       org.codehaus.plexus.util.xml.XMLWriter w)
        Parameters:
        mojoDescriptor - not null
        w - not null

      • writeReportNotice

        private void writeReportNotice​(org.apache.maven.plugin.descriptor.MojoDescriptor mojoDescriptor,
                               org.codehaus.plexus.util.xml.XMLWriter w)
        Parameters:
        mojoDescriptor - not null
        w - not null

      • writeGoalAttributes

        private void writeGoalAttributes​(org.apache.maven.plugin.descriptor.MojoDescriptor mojoDescriptor,
                                 org.codehaus.plexus.util.xml.XMLWriter w)
        Parameters:
        mojoDescriptor - not null
        w - not null

      • writeGoalParameterTable

        private void writeGoalParameterTable​(org.apache.maven.plugin.descriptor.MojoDescriptor mojoDescriptor,
                                     org.codehaus.plexus.util.xml.XMLWriter w)
        Parameters:
        mojoDescriptor - not null
        w - not null

      • filterParameters

        private java.util.List<org.apache.maven.plugin.descriptor.Parameter> filterParameters​(java.util.List<org.apache.maven.plugin.descriptor.Parameter> parameterList)
        Filter parameters to only retain those which must be documented, ie not components nor readonly.
        Parameters:
        parameterList - not null
        Returns:
        the parameters list without components.

      • writeParameterDetails

        private void writeParameterDetails​(org.apache.maven.plugin.descriptor.MojoDescriptor mojoDescriptor,
                                   java.util.List<org.apache.maven.plugin.descriptor.Parameter> parameterList,
                                   org.codehaus.plexus.util.xml.XMLWriter w)
        Parameters:
        mojoDescriptor - not null
        parameterList - not null
        w - not null

      • addUl

        private boolean addUl​(org.codehaus.plexus.util.xml.XMLWriter w,
                      boolean addedUl,
                      java.lang.String content)

      • addUl

        private boolean addUl​(org.codehaus.plexus.util.xml.XMLWriter w,
                      boolean addedUl)

      • getPropertyFromExpression

        private java.lang.String getPropertyFromExpression​(java.lang.String expression)

      • writeDetail

        private void writeDetail​(java.lang.String param,
                         java.lang.String value,
                         org.codehaus.plexus.util.xml.XMLWriter w)
        Parameters:
        param - not null
        value - could be null
        w - not null

      • writeParameterSummary

        private void writeParameterSummary​(org.apache.maven.plugin.descriptor.MojoDescriptor mojoDescriptor,
                                   java.util.List<org.apache.maven.plugin.descriptor.Parameter> parameterList,
                                   org.codehaus.plexus.util.xml.XMLWriter w)
        Parameters:
        mojoDescriptor - not null
        parameterList - not null
        w - not null

      • writeParameterList

        private void writeParameterList​(org.apache.maven.plugin.descriptor.MojoDescriptor mojoDescriptor,
                                java.lang.String title,
                                java.util.List<org.apache.maven.plugin.descriptor.Parameter> parameterList,
                                org.codehaus.plexus.util.xml.XMLWriter w)
        Parameters:
        mojoDescriptor - not null
        title - not null
        parameterList - not null
        w - not null

      • getParametersByRequired

        private java.util.List<org.apache.maven.plugin.descriptor.Parameter> getParametersByRequired​(boolean required,
                                                                                             java.util.List<org.apache.maven.plugin.descriptor.Parameter> parameterList)
        Parameters:
        required - true for required parameters, false otherwise.
        parameterList - not null
        Returns:
        list of parameters depending the value of required

      • getBundle

        private java.util.ResourceBundle getBundle()
        Gets the resource bundle for the locale instance variable.
        Returns:
        The resource bundle for the locale instance variable.

      • getString

        private java.lang.String getString​(java.lang.String key)
        Parameters:
        key - not null
        Returns:
        Localized, text identified by key.
        See Also:
        getBundle()

      • format

        private java.lang.String format​(java.lang.String key,
                                java.lang.Object arg1)
        Convenience method.
        Parameters:
        key - not null
        arg1 - not null
        Returns:
        Localized, formatted text identified by key.
        See Also:
        format(String, Object[])

      • format

        private java.lang.String format​(java.lang.String key,
                                java.lang.Object[] args)
        Looks up the value for key in the ResourceBundle, then formats that value for the specified Locale using args.
        Parameters:
        key - not null
        args - not null
        Returns:
        Localized, formatted text identified by key.

      • escapeXml

        private java.lang.String escapeXml​(java.lang.String text)
        Parameters:
        text - the string to escape
        Returns:
        A string escaped with XML entities