org.umlgraph.doclet
Class ContextView

Show UML class diagram
java.lang.Object
  extended by org.umlgraph.doclet.ContextView
All Implemented Interfaces:
OptionProvider

public class ContextView
extends java.lang.Object
implements OptionProvider

A view designed for UMLDoc, filters out everything that it's not directly connected to the center class of the context.

As such, can be viewed as a simplified version of a View using a single ContextMatcher, but provides some extra configuration such as context highlighting and output path configuration (and it is specified in code rather than in javadoc comments).


Field Summary
private  com.sun.javadoc.ClassDoc cd
           
private  Options centerOptions
           
private  Options globalOptions
           
private static java.lang.String[] HIDE_OPTIONS
           
private  Options hideOptions
           
private  ContextMatcher matcher
           
private  Options myGlobalOptions
           
private  Options packageOptions
           
 
Constructor Summary
ContextView(java.lang.String outputFolder, com.sun.javadoc.ClassDoc cd, com.sun.javadoc.RootDoc root, Options parent)
           
 
Method Summary
 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
 void setContextCenter(com.sun.javadoc.ClassDoc contextCenter)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

cd

private com.sun.javadoc.ClassDoc cd

matcher

private ContextMatcher matcher

globalOptions

private Options globalOptions

myGlobalOptions

private Options myGlobalOptions

hideOptions

private Options hideOptions

centerOptions

private Options centerOptions

packageOptions

private Options packageOptions

HIDE_OPTIONS

private static final java.lang.String[] HIDE_OPTIONS
Constructor Detail

ContextView

public ContextView(java.lang.String outputFolder,
                   com.sun.javadoc.ClassDoc cd,
                   com.sun.javadoc.RootDoc root,
                   Options parent)
            throws java.io.IOException
Throws:
java.io.IOException
Method Detail

setContextCenter

public void setContextCenter(com.sun.javadoc.ClassDoc contextCenter)

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

getGlobalOptions

public Options getGlobalOptions()
Description copied from interface: OptionProvider
Returns the global options (the class independent definition)

Specified by:
getGlobalOptions in interface OptionProvider

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

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