class JJDoc extends ToolFacade
Modifier and Type | Class and Description |
---|---|
(package private) class |
JJDoc.MojoLogStreamConsumer
Consume and log command line output from the JJDoc process.
|
Modifier and Type | Field and Description |
---|---|
private java.lang.Boolean |
bnf
The option BNF.
|
private java.lang.String |
cssHref
The option CSS.
|
private java.lang.String |
grammarEncoding
The option GRAMMAR_ENCODING.
|
private java.io.File |
inputFile
The input grammar.
|
private java.lang.Boolean |
oneTable
The option ONE_TABLE.
|
private java.io.File |
outputFile
The option OUTPUT_FILE.
|
private java.lang.Boolean |
text
The option TEXT.
|
Constructor and Description |
---|
JJDoc() |
Modifier and Type | Method and Description |
---|---|
protected int |
execute()
Runs the tool using the previously set parameters.
|
private java.lang.String[] |
generateArguments()
Assembles the command line arguments for the invocation of JJDoc according to the configuration.
|
void |
setBnf(java.lang.Boolean value)
Sets the option BNF.
|
void |
setCssHref(java.lang.String value)
Sets the option CSS, i.e the hypertext reference to a CSS file for the generated HTML output.
|
void |
setGrammarEncoding(java.lang.String value)
Sets the option GRAMMAR_ENCODING.
|
void |
setInputFile(java.io.File value)
Sets the absolute path to the grammar file to pass into JJDoc for documentation.
|
void |
setOneTable(java.lang.Boolean value)
Sets the option value ONE_TABLE.
|
void |
setOutputFile(java.io.File value)
Sets the absolute path to the output file.
|
void |
setText(java.lang.Boolean value)
Sets the option TEXT.
|
java.lang.String |
toString()
Gets a string representation of the command line arguments.
|
getLog, getToolName, run, setLog
private java.io.File inputFile
private java.io.File outputFile
private java.lang.String grammarEncoding
private java.lang.String cssHref
private java.lang.Boolean text
private java.lang.Boolean bnf
private java.lang.Boolean oneTable
public void setInputFile(java.io.File value)
value
- The absolute path to the grammar file to pass into JJDoc for documentation.public void setOutputFile(java.io.File value)
value
- The absolute path to the HTML/text file to generate.public void setGrammarEncoding(java.lang.String value)
value
- The option value, may be null
to use the value provided in the grammar or the default.public void setCssHref(java.lang.String value)
value
- The option value, may be null
to use the default style.public void setText(java.lang.Boolean value)
value
- The option value, may be null
to use the default value.public void setBnf(java.lang.Boolean value)
value
- The option value, may be null
to use the default value.public void setOneTable(java.lang.Boolean value)
value
- The option value, may be null
to use the default value.protected int execute() throws java.lang.Exception
execute
in class ToolFacade
java.lang.Exception
- If the tool could not be invoked.private java.lang.String[] generateArguments()
public java.lang.String toString()
toString
in class java.lang.Object