org.umlgraph.doclet

Class View

Show UML class diagram

java.lang.Object

org.umlgraph.doclet.View

All Implemented Interfaces:

OptionProvider

public class View
extends java.lang.Object
implements OptionProvider

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

Fields

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 Summary

Constructors

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

Method Summary

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

Methods inherited from class java.lang.Object

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

Field Detail

optionOverrides

java.util.Map<ClassMatcher,java.util.List<java.lang.String[]>> optionOverrides

viewDoc

com.sun.javadoc.ClassDoc viewDoc

provider

OptionProvider provider

globalOptions

java.util.List<java.lang.String[]> globalOptions

root

com.sun.javadoc.RootDoc root

Constructor Detail

View

public View(com.sun.javadoc.RootDoc root,
            com.sun.javadoc.ClassDoc c,
            OptionProvider provider)

Builds a view given the class that contains its definition

Method Detail

buildMatcher

private ClassMatcher buildMatcher(java.lang.String tagText)

Factory method that builds the appropriate matcher for @match tags

getOptionsFor

public Options getOptionsFor(com.sun.javadoc.ClassDoc cd)

Description copied from interface: OptionProvider

Returns the options for the specified class.

Specified by:

getOptionsFor in interface OptionProvider

getOptionsFor

public Options getOptionsFor(java.lang.String name)

Description copied from interface: OptionProvider

Returns the options for the specified class.

Specified by:

getOptionsFor in interface OptionProvider

getGlobalOptions

public Options getGlobalOptions()

Description copied from interface: OptionProvider

Returns the global options (the class independent definition)

Specified by:

getGlobalOptions in interface OptionProvider

overrideForClass

public void overrideForClass(Options opt,
                             com.sun.javadoc.ClassDoc cd)

Description copied from interface: OptionProvider

Gets a base Options and applies the overrides for the specified class

Specified by:

overrideForClass in interface OptionProvider

overrideForClass

public void overrideForClass(Options opt,
                             java.lang.String className)

Description copied from interface: OptionProvider

Gets a base Options and applies the overrides for the specified class

Specified by:

overrideForClass in interface OptionProvider

getDisplayName

public java.lang.String getDisplayName()

Description copied from interface: OptionProvider

Returns user displayable name for this option provider.

Will be used to provide progress feedback on the console

Specified by:

getDisplayName in interface OptionProvider