org.umlgraph.doclet
Interface OptionProvider

Show UML class diagram
All Known Implementing Classes:
ContextView, Options, PackageView, View

public interface OptionProvider

A factory class that builds Options object for general use or for a specific class


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
 

Method Detail

getOptionsFor

Options getOptionsFor(com.sun.javadoc.ClassDoc cd)
Returns the options for the specified class.


getOptionsFor

Options getOptionsFor(java.lang.String name)
Returns the options for the specified class.


getGlobalOptions

Options getGlobalOptions()
Returns the global options (the class independent definition)


overrideForClass

void overrideForClass(Options opt,
                      com.sun.javadoc.ClassDoc cd)
Gets a base Options and applies the overrides for the specified class


overrideForClass

void overrideForClass(Options opt,
                      java.lang.String className)
Gets a base Options and applies the overrides for the specified class


getDisplayName

java.lang.String getDisplayName()
Returns user displayable name for this option provider.

Will be used to provide progress feedback on the console