org.jdrupes.mdoclet

Class Options

java.lang.Object

org.jdrupes.mdoclet.Options

public class Options
extends Object

Processes and stores the command line options.

Field Summary

Fields

Modifier and Type	Field and Description
static String	OPT_DISABLE_AUTO_HIGHLIGHT
static String	OPT_DISABLE_HIGHLIGHT
static String	OPT_ENCODING
static String	OPT_HIGHLIGHT_STYLE
static String	OPT_MARKDOWN_PROCESSOR
static String	OPT_OUTPUT_DIR
static String	OPT_OVERVIEW
static String	OPT_STYLESHEETFILE
static String	OPT_TAG

Constructor Summary

Constructors

Constructor and Description
Options()

Method Summary

Modifier and Type	Method and Description
File	getDestinationDir() Gets the destination directory.
Charset	getEncoding() Gets the source encoding.
String	getHighlightStyle()
String[]	getMarkedDownTags() Returns the names of the tags that have been seen in the -tag options with an “M” flag.
File	getOverviewFile() Gets the overview file.
MarkdownProcessor	getProcessor() Returns the processor selected by the options.
String[][]	getProcessorOptions() Returns the markdown processor options filtered out in load(String[][], DocErrorReporter).
File	getStylesheetFile() Gets the CSS stylesheet file.
protected boolean	handleOption(Iterator<String[]> optionsIter, com.sun.javadoc.DocErrorReporter errorReporter)
boolean	isHighlightEnabled()
String[][]	load(String[][] options, com.sun.javadoc.DocErrorReporter errorReporter) Loads the options from the command line.
static int	optionLength(String option)
void	setDestinationDir(File destinationDir) Sets the destination directory.
void	setEncoding(Charset encoding) Sets the source encoding.
void	setHighlightEnabled(boolean highlightEnabled)
void	setHighlightStyle(String highlightStyle)
void	setOverviewFile(File overviewFile) Sets the overview file.
void	setStylesheetFile(File stylesheetFile) Sets the CSS stylesheet file.
static boolean	validOptions(String[][] options, com.sun.javadoc.DocErrorReporter errorReporter) As specified by the Doclet specification.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

OPT_MARKDOWN_PROCESSOR

public static final String OPT_MARKDOWN_PROCESSOR

See Also:

Constant Field Values

OPT_DISABLE_HIGHLIGHT

public static final String OPT_DISABLE_HIGHLIGHT

See Also:

Constant Field Values

OPT_DISABLE_AUTO_HIGHLIGHT

public static final String OPT_DISABLE_AUTO_HIGHLIGHT

See Also:

Constant Field Values

OPT_HIGHLIGHT_STYLE

public static final String OPT_HIGHLIGHT_STYLE

See Also:

Constant Field Values

OPT_ENCODING

public static final String OPT_ENCODING

See Also:

Constant Field Values

OPT_OVERVIEW

public static final String OPT_OVERVIEW

See Also:

Constant Field Values

OPT_OUTPUT_DIR

public static final String OPT_OUTPUT_DIR

See Also:

Constant Field Values

OPT_STYLESHEETFILE

public static final String OPT_STYLESHEETFILE

See Also:

Constant Field Values

OPT_TAG

public static final String OPT_TAG

See Also:

Constant Field Values

Constructor Detail

Options

public Options()

Method Detail

optionLength

public static int optionLength(String option)

validOptions

public static boolean validOptions(String[][] options,
                                   com.sun.javadoc.DocErrorReporter errorReporter)

As specified by the Doclet specification.

Parameters:

options - The command line options.

errorReporter - An error reporter to print messages.

Returns:

true if the options are valid.

See Also:

Doclet.validOptions(String[][], com.sun.javadoc.DocErrorReporter)

load

public String[][] load(String[][] options,
                       com.sun.javadoc.DocErrorReporter errorReporter)

Loads the options from the command line.

Parameters:

options - The command line options.

errorReporter - The error reporter for printing messages.

Returns:

The options to be forwarded to the standard doclet.

handleOption

protected boolean handleOption(Iterator<String[]> optionsIter,
                               com.sun.javadoc.DocErrorReporter errorReporter)

getProcessor

public MarkdownProcessor getProcessor()

Returns the processor selected by the options.

Returns:

the processor

getProcessorOptions

public String[][] getProcessorOptions()

Returns the markdown processor options filtered out in load(String[][], DocErrorReporter).

Returns:

the options

getMarkedDownTags

public String[] getMarkedDownTags()

Returns the names of the tags that have been seen in the -tag options with an “M” flag.

Returns:

the tags

getOverviewFile

public File getOverviewFile()

Gets the overview file.

Returns:

The overview file.

setOverviewFile

public void setOverviewFile(File overviewFile)

Sets the overview file.

Parameters:

overviewFile - The overview file.

getEncoding

public Charset getEncoding()

Gets the source encoding.

Returns:

The source encoding.

setEncoding

public void setEncoding(Charset encoding)

Sets the source encoding.

Parameters:

encoding - The source encoding.

getDestinationDir

public File getDestinationDir()

Gets the destination directory.

Returns:

The destination directory.

setDestinationDir

public void setDestinationDir(File destinationDir)

Sets the destination directory.

Parameters:

destinationDir - The destination directory

getStylesheetFile

public File getStylesheetFile()

Gets the CSS stylesheet file.

Returns:

The stylesheet file.

setStylesheetFile

public void setStylesheetFile(File stylesheetFile)

Sets the CSS stylesheet file.

Parameters:

stylesheetFile - The stylesheet file.

isHighlightEnabled

public boolean isHighlightEnabled()

setHighlightEnabled

public void setHighlightEnabled(boolean highlightEnabled)

getHighlightStyle

public String getHighlightStyle()

setHighlightStyle

public void setHighlightStyle(String highlightStyle)