org.asciidoctor.asciidoclet

Class DocletOptions

java.lang.Object

org.asciidoctor.asciidoclet.DocletOptions

public class DocletOptions
extends Object

Provides an interface to the doclet options we are interested in.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ATTRIBUTE
static String	ATTRIBUTE_LONG
static String	ATTRIBUTES_FILE
static String	BASEDIR
static String	DESTDIR
static String	ENCODING
static String	GEM_PATH
static DocletOptions	NONE
static String	OVERVIEW
static String	REQUIRE
static String	REQUIRE_LONG
static String	STYLESHEET

Constructor Summary

Constructors

Constructor and Description
DocletOptions(com.sun.javadoc.RootDoc rootDoc)
DocletOptions(String[][] options)

Method Summary

Modifier and Type	Method and Description
List<String>	attributes()
com.google.common.base.Optional<File>	baseDir()
com.google.common.base.Optional<File>	destDir()
Charset	encoding()
String	gemPath()
static int	optionLength(String option, StandardAdapter standardDoclet)
com.google.common.base.Optional<File>	overview()
List<String>	requires()
com.google.common.base.Optional<File>	stylesheet()
static boolean	validOptions(String[][] options, com.sun.javadoc.DocErrorReporter errorReporter, StandardAdapter standardDoclet)

Methods inherited from class java.lang.Object

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

Field Detail

ENCODING

public static final String ENCODING

See Also:

Constant Field Values

OVERVIEW

public static final String OVERVIEW

See Also:

Constant Field Values

BASEDIR

public static final String BASEDIR

See Also:

Constant Field Values

STYLESHEET

public static final String STYLESHEET

See Also:

Constant Field Values

DESTDIR

public static final String DESTDIR

See Also:

Constant Field Values

ATTRIBUTE

public static final String ATTRIBUTE

See Also:

Constant Field Values

ATTRIBUTE_LONG

public static final String ATTRIBUTE_LONG

See Also:

Constant Field Values

ATTRIBUTES_FILE

public static final String ATTRIBUTES_FILE

See Also:

Constant Field Values

GEM_PATH

public static final String GEM_PATH

See Also:

Constant Field Values

REQUIRE

public static final String REQUIRE

See Also:

Constant Field Values

REQUIRE_LONG

public static final String REQUIRE_LONG

See Also:

Constant Field Values

NONE

public static final DocletOptions NONE

Constructor Detail

DocletOptions

public DocletOptions(com.sun.javadoc.RootDoc rootDoc)

DocletOptions

public DocletOptions(String[][] options)

Method Detail

overview

public com.google.common.base.Optional<File> overview()

stylesheet

public com.google.common.base.Optional<File> stylesheet()

baseDir

public com.google.common.base.Optional<File> baseDir()

destDir

public com.google.common.base.Optional<File> destDir()

encoding

public Charset encoding()

attributes

public List<String> attributes()

gemPath

public String gemPath()

requires

public List<String> requires()

validOptions

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

optionLength

public static int optionLength(String option,
                               StandardAdapter standardDoclet)