protected static class FilterDocletBase.Option extends AbstractOption
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
namePrefix
all filter doclet options start with this string.
|
private static java.util.Map<java.lang.String,AbstractOption> |
options
holds a (sorted) map of all known options
|
defaultValue, description, isBoolean, isTag, LF, LI, name, TAG_DELIMITER, value
Constructor and Description |
---|
FilterDocletBase.Option(java.lang.String name,
java.lang.String description)
Create a new option, that has no value (boolean option).
|
FilterDocletBase.Option(java.lang.String name,
java.lang.String defaultValue,
boolean isTag,
java.lang.String description)
Create a new option, that has a value.
|
Modifier and Type | Method and Description |
---|---|
static AbstractOption |
get(java.lang.String name)
Get an option by name.
|
static java.lang.String |
getDescriptions()
Get a string made from the descriptions of all registered options.
|
static java.util.Set<java.lang.String> |
getTags()
Get all tags
|
static void |
initJavaBeanProperties(java.lang.Object bean)
Assign option values to matching bean properties.
|
static void |
initOptions(java.lang.String[][] docletoptions)
Initialize the option values.
|
static int |
optionLength(java.lang.String name)
Get the number of parameters this option takes.
|
static void |
register(AbstractOption option)
Register an option.
|
get, getDescriptions, getTags, initJavaBeanProperties, initOptions, isSet, optionLength, register, toString
public static final java.lang.String namePrefix
private static java.util.Map<java.lang.String,AbstractOption> options
public FilterDocletBase.Option(java.lang.String name, java.lang.String defaultValue, boolean isTag, java.lang.String description)
name
- the namedefaultValue
- the default valueisTag
- set to true
, if the value of the option names
a tag.description
- the description of the optionpublic FilterDocletBase.Option(java.lang.String name, java.lang.String description)
name
- the namedescription
- the description of the option.public static void register(AbstractOption option)
option
- the option to register.public static AbstractOption get(java.lang.String name)
name
- the name of the option.null
, if no option with the given
name was registered.public static java.lang.String getDescriptions()
public static java.util.Set<java.lang.String> getTags()
isTag
is set.public static int optionLength(java.lang.String name)
name
- the name of the option.public static void initOptions(java.lang.String[][] docletoptions)
docletoptions
- the options as provided by the javadoc core.Doclet.validOptions(java.lang.String[][], com.sun.javadoc.DocErrorReporter)
,
RootDoc.options()
public static void initJavaBeanProperties(java.lang.Object bean) throws java.lang.Throwable
String
, boolen
and
int
are supported.bean
- a java beanjava.lang.Throwable