org.umlgraph.doclet

Class ContextView

java.lang.Object

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).

Constructor Summary

Constructors

Constructor and Description
ContextView(java.lang.String outputFolder, ClassDoc cd, RootDoc root, Options parent)

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.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.
void	overrideForClass(Options opt, ClassDoc cd) Gets a base Options and applies the overrides for the specified class
void	setContextCenter(ClassDoc contextCenter)

Methods inherited from class java.lang.Object

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

Constructor Detail

ContextView

public ContextView(java.lang.String outputFolder,
           ClassDoc cd,
           RootDoc root,
           Options parent)
            throws java.io.IOException

Throws:

java.io.IOException

Method Detail

setContextCenter

public void setContextCenter(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(ClassDoc cd)

Description copied from interface: OptionProvider

Returns the options for the specified class.

Specified by:

getOptionsFor 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