Modifier and Type | Field and Description |
---|---|
private java.util.Locale |
locale
locale
|
private org.apache.maven.project.MavenProject |
project
project
|
Constructor and 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) |
Modifier and Type | Method and 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) |
private final java.util.Locale locale
private final org.apache.maven.project.MavenProject project
public PluginXdocGenerator()
Locale.ENGLISH
as locale.
Used only in test cases.public PluginXdocGenerator(org.apache.maven.project.MavenProject project)
Locale.ENGLISH
as locale.project
- not null Maven project.public PluginXdocGenerator(org.apache.maven.project.MavenProject project, java.util.Locale locale)
project
- not null.locale
- not null wanted locale.public void execute(java.io.File destinationDirectory, PluginToolsRequest request) throws GeneratorException
execute
in interface Generator
destinationDirectory
- requiredrequest
- requiredGeneratorException
- if anyprotected void processMojoDescriptor(org.apache.maven.plugin.descriptor.MojoDescriptor mojoDescriptor, java.io.File destinationDirectory) throws java.io.IOException
mojoDescriptor
- not nulldestinationDirectory
- not nulljava.io.IOException
- if anyprivate java.lang.String getMojoFilename(org.apache.maven.plugin.descriptor.MojoDescriptor mojo, java.lang.String ext)
mojo
- not nullext
- not nullprivate void writeBody(org.apache.maven.plugin.descriptor.MojoDescriptor mojoDescriptor, org.codehaus.plexus.util.xml.XMLWriter w)
mojoDescriptor
- not nullw
- not nullprivate void writeReportNotice(org.apache.maven.plugin.descriptor.MojoDescriptor mojoDescriptor, org.codehaus.plexus.util.xml.XMLWriter w)
mojoDescriptor
- not nullw
- not nullprivate void writeGoalAttributes(org.apache.maven.plugin.descriptor.MojoDescriptor mojoDescriptor, org.codehaus.plexus.util.xml.XMLWriter w)
mojoDescriptor
- not nullw
- not nullprivate void writeGoalParameterTable(org.apache.maven.plugin.descriptor.MojoDescriptor mojoDescriptor, org.codehaus.plexus.util.xml.XMLWriter w)
mojoDescriptor
- not nullw
- not nullprivate java.util.List<org.apache.maven.plugin.descriptor.Parameter> filterParameters(java.util.List<org.apache.maven.plugin.descriptor.Parameter> parameterList)
parameterList
- not nullprivate 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)
mojoDescriptor
- not nullparameterList
- not nullw
- not nullprivate boolean addUl(org.codehaus.plexus.util.xml.XMLWriter w, boolean addedUl, java.lang.String content)
private boolean addUl(org.codehaus.plexus.util.xml.XMLWriter w, boolean addedUl)
private java.lang.String getPropertyFromExpression(java.lang.String expression)
private void writeDetail(java.lang.String param, java.lang.String value, org.codehaus.plexus.util.xml.XMLWriter w)
param
- not nullvalue
- could be nullw
- not nullprivate 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)
mojoDescriptor
- not nullparameterList
- not nullw
- not nullprivate 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)
mojoDescriptor
- not nulltitle
- not nullparameterList
- not nullw
- not nullprivate java.util.List<org.apache.maven.plugin.descriptor.Parameter> getParametersByRequired(boolean required, java.util.List<org.apache.maven.plugin.descriptor.Parameter> parameterList)
required
- true
for required parameters, false
otherwise.parameterList
- not nullrequired
private java.util.ResourceBundle getBundle()
locale
instance variable.locale
instance variable.private java.lang.String getString(java.lang.String key)
key
- not nullkey
.getBundle()
private java.lang.String format(java.lang.String key, java.lang.Object arg1)
key
- not nullarg1
- not nullkey
.format(String, Object[])
private java.lang.String format(java.lang.String key, java.lang.Object[] args)
key
in the ResourceBundle
,
then formats that value for the specified Locale
using args
.key
- not nullargs
- not nullkey
.private java.lang.String escapeXml(java.lang.String text)
text
- the string to escape