|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.umlgraph.doclet.View
public class View
Contains the definition of a View. A View is a set of option overrides that will lead to the creation of a UML class diagram. Multiple views can be defined on the same source tree, effectively allowing to create multiple class diagram out of it.
Field Summary | |
---|---|
(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 Summary | |
---|---|
View(com.sun.javadoc.RootDoc root,
com.sun.javadoc.ClassDoc c,
OptionProvider provider)
Builds a view given the class that contains its definition |
Method Summary | |
---|---|
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 |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
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
Constructor Detail |
---|
public View(com.sun.javadoc.RootDoc root, com.sun.javadoc.ClassDoc c, OptionProvider provider)
Method Detail |
---|
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
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |