Display help information on findbugs-maven-plugin.
Call mvn findbugs:help -Ddetail=true -Dgoal=<goal-name> to display parameter details.
| Modifiers | Name | Description |
|---|---|---|
private static int |
DEFAULT_LINE_LENGTH |
|
private static java.lang.String |
PLUGIN_HELP_PATH |
|
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. |
| Fields inherited from class | Fields |
|---|---|
class org.apache.maven.plugin.AbstractMojo |
ROLE |
| Constructor and description |
|---|
HelpMojo
() |
| Type Params | Return Type | Name 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(){@inheritDoc} |
|
private java.util.List<org.w3c.dom.Node> |
findNamedChild(org.w3c.dom.Node node, java.lang.String elementName) |
|
private 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 java.lang.String |
getPropertyFromExpression(java.lang.String expression) |
|
private org.w3c.dom.Node |
getSingleChild(org.w3c.dom.Node node, java.lang.String elementName) |
|
private 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) |
|
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 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 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) |
| Methods inherited from class | Name |
|---|---|
class org.apache.maven.plugin.AbstractMojo |
org.apache.maven.plugin.AbstractMojo#getPluginContext(), org.apache.maven.plugin.AbstractMojo#setPluginContext(java.util.Map), org.apache.maven.plugin.AbstractMojo#setLog(org.apache.maven.plugin.logging.Log), org.apache.maven.plugin.AbstractMojo#getLog(), org.apache.maven.plugin.AbstractMojo#wait(long, int), org.apache.maven.plugin.AbstractMojo#wait(long), org.apache.maven.plugin.AbstractMojo#wait(), org.apache.maven.plugin.AbstractMojo#equals(java.lang.Object), org.apache.maven.plugin.AbstractMojo#toString(), org.apache.maven.plugin.AbstractMojo#hashCode(), org.apache.maven.plugin.AbstractMojo#getClass(), org.apache.maven.plugin.AbstractMojo#notify(), org.apache.maven.plugin.AbstractMojo#notifyAll(), org.apache.maven.plugin.AbstractMojo#execute() |
class java.lang.Object |
java.lang.Object#wait(long, int), java.lang.Object#wait(long), java.lang.Object#wait(), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll() |
If true, display all settable properties for each goal.
The name of the goal for which to show help. If unspecified, all goals will be displayed.
The number of spaces per indentation level, should be positive.
The maximum length of a display line, should be positive.
Append a description to the buffer by respecting the indentSize and lineLength parameters. Note: The last character is always a new line.
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.{@inheritDoc}
Gets the indentation level of the specified line.
line - The line whose indentation level should be retrieved, must not be null.
Repeat a String n times to form a new string.
repeat < 0nullstr - String to repeatrepeat - number of times to repeat strSplits the specified text into lines of convenient display length.
indent < 0text - 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.Adds the specified line to the output sequence, performing line wrapping if necessary.
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.