gr.spinellis.umlgraph.doclet
Class View

Package class diagram package View
java.lang.Object
  extended by gr.spinellis.umlgraph.doclet.View
All Implemented Interfaces:
OptionProvider

public class View
extends 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
(package private)  List<String[]> globalOptions
           
(package private)  Map<ClassMatcher,List<String[]>> optionOverrides
           
(package private)  OptionProvider provider
           
(package private)  RootDoc root
           
(package private)  ClassDoc viewDoc
           
 
Constructor Summary
View(RootDoc root, ClassDoc c, OptionProvider provider)
          Builds a view given the class that contains its definition
 
Method Summary
private  ClassMatcher buildMatcher(String tagText)
          Factory method that builds the appropriate matcher for @match tags
 String getDisplayName()
          Returns user displayable name for this option provider.
 Options getGlobalOptions()
          Returns the global options (the class independent definition)
 Options getOptionsFor(ClassDoc cd)
          Returns the options for the specified class.
 Options getOptionsFor(String name)
          Returns the options for the specified class.
 void overrideForClass(Options opt, ClassDoc cd)
          Gets a base Options and applies the overrides for the specified class
 void overrideForClass(Options opt, 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

Map<ClassMatcher,List<String[]>> optionOverrides

viewDoc

ClassDoc viewDoc

provider

OptionProvider provider

globalOptions

List<String[]> globalOptions

root

RootDoc root
Constructor Detail

View

public View(RootDoc root,
            ClassDoc c,
            OptionProvider provider)
Builds a view given the class that contains its definition

Method Detail

buildMatcher

private ClassMatcher buildMatcher(String tagText)
Factory method that builds the appropriate matcher for @match tags


getOptionsFor

public Options getOptionsFor(ClassDoc cd)
Description copied from interface: OptionProvider
Returns the options for the specified class.

Specified by:
getOptionsFor in interface OptionProvider

getOptionsFor

public Options getOptionsFor(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,
                             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,
                             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 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