@Mojo(name="help",
requiresProject=false,
threadSafe=true)
public class HelpMojo
extends org.apache.maven.plugin.AbstractMojo
mvn johnzon:help -Ddetail=true -Dgoal=<goal-name> to display parameter details.| Modifier and Type | Field and Description |
|---|---|
private static int |
DEFAULT_LINE_LENGTH |
private boolean |
detail
If
true, display all settable properties for each goal. |
private java.lang.String |
goal
The name of the goal for which to show help.
|
private int |
indentSize
The number of spaces per indentation level, should be positive.
|
private int |
lineLength
The maximum length of a display line, should be positive.
|
private static java.lang.String |
PLUGIN_HELP_PATH |
| Constructor and Description |
|---|
HelpMojo() |
| Modifier and Type | Method and Description |
|---|---|
private void |
append(java.lang.StringBuilder sb,
java.lang.String description,
int indent)
Append a description to the buffer by respecting the indentSize and lineLength parameters.
|
private org.w3c.dom.Document |
build() |
void |
execute() |
private static java.util.List<org.w3c.dom.Node> |
findNamedChild(org.w3c.dom.Node node,
java.lang.String elementName) |
private static org.w3c.dom.Node |
findSingleChild(org.w3c.dom.Node node,
java.lang.String elementName) |
private static int |
getIndentLevel(java.lang.String line)
Gets the indentation level of the specified line.
|
private static java.lang.String |
getPropertyFromExpression(java.lang.String expression) |
private static org.w3c.dom.Node |
getSingleChild(org.w3c.dom.Node node,
java.lang.String elementName) |
private static java.lang.String |
getValue(org.w3c.dom.Node node,
java.lang.String elementName) |
private static boolean |
isNotEmpty(java.lang.String string) |
private static java.lang.String |
repeat(java.lang.String str,
int repeat)
Repeat a String
n times to form a new string. |
private static void |
toLines(java.util.List<java.lang.String> lines,
java.lang.String line,
int indentSize,
int lineLength)
Adds the specified line to the output sequence, performing line wrapping if necessary.
|
private static java.util.List<java.lang.String> |
toLines(java.lang.String text,
int indent,
int indentSize,
int lineLength)
Splits the specified text into lines of convenient display length.
|
private void |
writeGoal(java.lang.StringBuilder sb,
java.lang.String goalPrefix,
org.w3c.dom.Element mojo) |
private void |
writeParameter(java.lang.StringBuilder sb,
org.w3c.dom.Node parameter,
org.w3c.dom.Node configurationElement) |
@Parameter(property="detail",
defaultValue="false")
private boolean detail
true, display all settable properties for each goal.@Parameter(property="goal") private java.lang.String goal
@Parameter(property="lineLength",
defaultValue="80")
private int lineLength
@Parameter(property="indentSize",
defaultValue="2")
private int indentSize
private static final java.lang.String PLUGIN_HELP_PATH
private static final int DEFAULT_LINE_LENGTH
private org.w3c.dom.Document build()
throws org.apache.maven.plugin.MojoExecutionException
org.apache.maven.plugin.MojoExecutionExceptionpublic void execute()
throws org.apache.maven.plugin.MojoExecutionException
org.apache.maven.plugin.MojoExecutionExceptionprivate static boolean isNotEmpty(java.lang.String string)
private static java.lang.String getValue(org.w3c.dom.Node node,
java.lang.String elementName)
throws org.apache.maven.plugin.MojoExecutionException
org.apache.maven.plugin.MojoExecutionExceptionprivate static org.w3c.dom.Node getSingleChild(org.w3c.dom.Node node,
java.lang.String elementName)
throws org.apache.maven.plugin.MojoExecutionException
org.apache.maven.plugin.MojoExecutionExceptionprivate static java.util.List<org.w3c.dom.Node> findNamedChild(org.w3c.dom.Node node,
java.lang.String elementName)
private static org.w3c.dom.Node findSingleChild(org.w3c.dom.Node node,
java.lang.String elementName)
throws org.apache.maven.plugin.MojoExecutionException
org.apache.maven.plugin.MojoExecutionExceptionprivate void writeGoal(java.lang.StringBuilder sb,
java.lang.String goalPrefix,
org.w3c.dom.Element mojo)
throws org.apache.maven.plugin.MojoExecutionException
org.apache.maven.plugin.MojoExecutionExceptionprivate void writeParameter(java.lang.StringBuilder sb,
org.w3c.dom.Node parameter,
org.w3c.dom.Node configurationElement)
throws org.apache.maven.plugin.MojoExecutionException
org.apache.maven.plugin.MojoExecutionExceptionprivate static java.lang.String repeat(java.lang.String str,
int repeat)
Repeat a String n times to form a new string.
str - String to repeatrepeat - number of times to repeat strjava.lang.NegativeArraySizeException - if repeat < 0java.lang.NullPointerException - if str is nullprivate void append(java.lang.StringBuilder sb,
java.lang.String description,
int indent)
sb - The buffer to append the description, not null.description - The description, not null.indent - The base indentation level of each line, must not be negative.private static java.util.List<java.lang.String> toLines(java.lang.String text,
int indent,
int indentSize,
int lineLength)
text - The text to split into lines, must not be null.indent - The base indentation level of each line, must not be negative.indentSize - The size of each indentation, must not be negative.lineLength - The length of the line, must not be negative.null.java.lang.NegativeArraySizeException - if indent < 0private static void toLines(java.util.List<java.lang.String> lines,
java.lang.String line,
int indentSize,
int lineLength)
lines - The sequence of display lines, must not be null.line - The line to add, must not be null.indentSize - The size of each indentation, must not be negative.lineLength - The length of the line, must not be negative.private static int getIndentLevel(java.lang.String line)
line - The line whose indentation level should be retrieved, must not be null.private static java.lang.String getPropertyFromExpression(java.lang.String expression)
Copyright © 2014–2023 The Apache Software Foundation. All rights reserved.