org.umlgraph.doclet
Class PackageView

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

public class PackageView
extends java.lang.Object
implements OptionProvider

A view designed for UMLDoc, filters out everything that it's not contained in the specified package.

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


Field Summary
private  ClassMatcher matcher
           
private  java.lang.String outputPath
           
private  OptionProvider parent
           
private  com.sun.javadoc.PackageDoc pd
           
 
Constructor Summary
PackageView(java.lang.String outputFolder, com.sun.javadoc.PackageDoc pd, com.sun.javadoc.RootDoc root, OptionProvider 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
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

pd

private com.sun.javadoc.PackageDoc pd

parent

private OptionProvider parent

matcher

private ClassMatcher matcher

outputPath

private java.lang.String outputPath
Constructor Detail

PackageView

public PackageView(java.lang.String outputFolder,
                   com.sun.javadoc.PackageDoc pd,
                   com.sun.javadoc.RootDoc root,
                   OptionProvider parent)
Method Detail

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