Class GeneratorUtils
- java.lang.Object
-
- org.apache.maven.tools.plugin.generator.GeneratorUtils
-
public final class GeneratorUtils extends java.lang.Object
Convenience methods to play with Maven plugins.- Author:
- jdcasey
-
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static java.lang.String
discoverPackageName(org.apache.maven.plugin.descriptor.PluginDescriptor pluginDescriptor)
Find the best package name, based on the number of hits of actual Mojo classes.static void
element(org.codehaus.plexus.util.xml.XMLWriter w, java.lang.String name, java.lang.String value)
static void
element(org.codehaus.plexus.util.xml.XMLWriter w, java.lang.String name, java.lang.String value, boolean asText)
static boolean
isMavenReport(java.lang.String impl, org.apache.maven.project.MavenProject project)
static java.lang.String
makeHtmlValid(java.lang.String description)
Fixes some javadoc comment to become a valid XHTML snippet.static java.util.List<org.codehaus.plexus.component.repository.ComponentDependency>
toComponentDependencies(java.util.List<org.apache.maven.model.Dependency> dependencies)
static java.lang.String
toText(java.lang.String html)
Converts a HTML fragment as extracted from a javadoc comment to a plain text string.static void
writeDependencies(org.codehaus.plexus.util.xml.XMLWriter w, org.apache.maven.plugin.descriptor.PluginDescriptor pluginDescriptor)
-
-
-
Method Detail
-
writeDependencies
public static void writeDependencies(org.codehaus.plexus.util.xml.XMLWriter w, org.apache.maven.plugin.descriptor.PluginDescriptor pluginDescriptor)
- Parameters:
w
- not null writerpluginDescriptor
- not null
-
element
public static void element(org.codehaus.plexus.util.xml.XMLWriter w, java.lang.String name, java.lang.String value)
- Parameters:
w
- not null writername
- not nullvalue
- could be null
-
element
public static void element(org.codehaus.plexus.util.xml.XMLWriter w, java.lang.String name, java.lang.String value, boolean asText)
-
toComponentDependencies
public static java.util.List<org.codehaus.plexus.component.repository.ComponentDependency> toComponentDependencies(java.util.List<org.apache.maven.model.Dependency> dependencies)
- Parameters:
dependencies
- not null list ofDependency
- Returns:
- list of component dependencies
-
makeHtmlValid
public static java.lang.String makeHtmlValid(java.lang.String description)
Fixes some javadoc comment to become a valid XHTML snippet.- Parameters:
description
- Javadoc description with HTML tags, may benull
.- Returns:
- The description with valid XHTML tags, never
null
.
-
toText
public static java.lang.String toText(java.lang.String html)
Converts a HTML fragment as extracted from a javadoc comment to a plain text string. This method tries to retain as much of the text formatting as possible by means of the following transformations:- List items are converted to leading tabs (U+0009), followed by the item number/bullet, another tab and finally the item contents. Each tab denotes an increase of indentation.
- Flow breaking elements as well as literal line terminators in preformatted text are converted to a newline (U+000A) to denote a mandatory line break.
- Consecutive spaces and line terminators from character data outside of preformatted text will be normalized to a single space. The resulting space denotes a possible point for line wrapping.
- Each space in preformatted text will be converted to a non-breaking space (U+00A0).
- Parameters:
html
- The HTML fragment to convert to plain text, may benull
.- Returns:
- A string with HTML tags converted into pure text, never
null
. - Since:
- 2.4.3
-
discoverPackageName
public static java.lang.String discoverPackageName(org.apache.maven.plugin.descriptor.PluginDescriptor pluginDescriptor)
Find the best package name, based on the number of hits of actual Mojo classes.- Parameters:
pluginDescriptor
- not null- Returns:
- the best name of the package for the generated mojo
-
isMavenReport
public static boolean isMavenReport(java.lang.String impl, org.apache.maven.project.MavenProject project) throws java.lang.IllegalArgumentException
- Parameters:
impl
- a Mojo implementation, not nullproject
- a MavenProject instance, could be null- Returns:
true
is the Mojo implementation implementsMavenReport
,false
otherwise.- Throws:
java.lang.IllegalArgumentException
- if any
-
-