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.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description private static class
GeneratorUtils.MojoParserCallback
ParserCallback implementation.
-
Constructor Summary
Constructors Modifier Constructor Description private
GeneratorUtils()
-
Method Summary
All Methods Static Methods Concrete Methods Deprecated Methods Modifier and Type Method Description (package private) static java.lang.String
decodeJavadocTags(java.lang.String description)
Deprecated.Only used for non java extractorstatic 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)
private static java.lang.String
quoteReplacement(java.lang.String s)
Returns a literal replacementString
for the specifiedString
.static java.util.List<org.codehaus.plexus.component.repository.ComponentDependency>
toComponentDependencies(java.util.Collection<org.apache.maven.artifact.Artifact> artifacts)
static java.lang.String
toText(java.lang.String html)
Deprecated.Replaced byHtmlToPlainTextConverter
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
-
toComponentDependencies
public static java.util.List<org.codehaus.plexus.component.repository.ComponentDependency> toComponentDependencies(java.util.Collection<org.apache.maven.artifact.Artifact> artifacts)
- Parameters:
artifacts
- not null collection ofArtifact
- Returns:
- list of component dependencies, without in provided scope
-
quoteReplacement
private static java.lang.String quoteReplacement(java.lang.String s)
Returns a literal replacementString
for the specifiedString
. This method produces aString
that will work as a literal replacements
in theappendReplacement
method of theMatcher
class. TheString
produced will match the sequence of characters ins
treated as a literal sequence. Slashes ('\') and dollar signs ('$') will be given no special meaning. TODO: copied from Matcher class of Java 1.5, remove once target platform can be upgraded- Parameters:
s
- The string to be literalized- Returns:
- A literal string replacement
- See Also:
- java.util.regex.Matcher
-
decodeJavadocTags
@Deprecated static java.lang.String decodeJavadocTags(java.lang.String description)
Deprecated.Only used for non java extractorDecodes javadoc inline tags into equivalent HTML tags. For instance, the inline tag "<A&B>
" should be rendered as "<A&B>
".- Parameters:
description
- The javadoc description to decode, may benull
.- Returns:
- The decoded description, never
null
.
-
toText
@Deprecated public static java.lang.String toText(java.lang.String html)
Deprecated.Replaced byHtmlToPlainTextConverter
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
-
-