|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectde.kruis.padoclet.util.AbstractOption
de.kruis.padoclet.RefCheckDoclet.Option
protected static class RefCheckDoclet.Option
Option handling for doclets. This class holds static methods and data about the options given to the doclet. Additionally instances oft the class represent single options.
Field Summary | |
---|---|
static java.lang.String |
namePrefix
all doclet options start with this string. |
private static java.util.Map<java.lang.String,AbstractOption> |
options
holds a (sorted) map of all known options |
Fields inherited from class de.kruis.padoclet.util.AbstractOption |
---|
defaultValue, description, isBoolean, isTag, LF, LI, name, TAG_DELIMITER, value |
Constructor Summary | |
---|---|
RefCheckDoclet.Option(java.lang.String name,
java.lang.String description)
Create a new option, that has no value (boolean option). |
|
RefCheckDoclet.Option(java.lang.String name,
java.lang.String defaultValue,
boolean isTag,
java.lang.String description)
Create a new option, that has a value. |
Method Summary | |
---|---|
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. |
Methods inherited from class de.kruis.padoclet.util.AbstractOption |
---|
get, getDescriptions, getTags, initJavaBeanProperties, initOptions, isSet, optionLength, register, toString |
Field Detail |
---|
public static final java.lang.String namePrefix
private static java.util.Map<java.lang.String,AbstractOption> options
Constructor Detail |
---|
public RefCheckDoclet.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 RefCheckDoclet.Option(java.lang.String name, java.lang.String description)
name
- the namedescription
- the description of the option.Method Detail |
---|
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 bean
java.lang.Throwable
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |