public class View extends java.lang.Object implements OptionProvider
Modifier and Type | Field and Description |
---|---|
(package private) java.util.List<java.lang.String[]> |
globalOptions |
(package private) java.util.Map<ClassMatcher,java.util.List<java.lang.String[]>> |
optionOverrides |
(package private) OptionProvider |
provider |
(package private) com.sun.javadoc.RootDoc |
root |
(package private) com.sun.javadoc.ClassDoc |
viewDoc |
Constructor and Description |
---|
View(com.sun.javadoc.RootDoc root,
com.sun.javadoc.ClassDoc c,
OptionProvider provider)
Builds a view given the class that contains its definition
|
Modifier and Type | Method and Description |
---|---|
private ClassMatcher |
buildMatcher(java.lang.String tagText)
Factory method that builds the appropriate matcher for @match tags
|
java.lang.String |
getDisplayName()
Returns user displayable name for this option provider.
|
Options |
getGlobalOptions()
Returns the global options (the class independent definition)
|
Options |
getOptionsFor(com.sun.javadoc.ClassDoc cd)
Returns the options for the specified class.
|
Options |
getOptionsFor(java.lang.String name)
Returns the options for the specified class.
|
void |
overrideForClass(Options opt,
com.sun.javadoc.ClassDoc cd)
Gets a base Options and applies the overrides for the specified class
|
void |
overrideForClass(Options opt,
java.lang.String className)
Gets a base Options and applies the overrides for the specified class
|
java.util.Map<ClassMatcher,java.util.List<java.lang.String[]>> optionOverrides
com.sun.javadoc.ClassDoc viewDoc
OptionProvider provider
java.util.List<java.lang.String[]> globalOptions
com.sun.javadoc.RootDoc root
public View(com.sun.javadoc.RootDoc root, com.sun.javadoc.ClassDoc c, OptionProvider provider)
private ClassMatcher buildMatcher(java.lang.String tagText)
public Options getOptionsFor(com.sun.javadoc.ClassDoc cd)
OptionProvider
getOptionsFor
in interface OptionProvider
public Options getOptionsFor(java.lang.String name)
OptionProvider
getOptionsFor
in interface OptionProvider
public Options getGlobalOptions()
OptionProvider
getGlobalOptions
in interface OptionProvider
public void overrideForClass(Options opt, com.sun.javadoc.ClassDoc cd)
OptionProvider
overrideForClass
in interface OptionProvider
public void overrideForClass(Options opt, java.lang.String className)
OptionProvider
overrideForClass
in interface OptionProvider
public java.lang.String getDisplayName()
OptionProvider
Will be used to provide progress feedback on the console
getDisplayName
in interface OptionProvider