|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectgr.spinellis.umlgraph.doclet.PackageView
public class PackageView
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 String |
outputPath
|
private OptionProvider |
parent
|
private PackageDoc |
pd
|
Constructor Summary | |
---|---|
PackageView(String outputFolder,
PackageDoc pd,
RootDoc root,
OptionProvider parent)
|
Method Summary | |
---|---|
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 |
---|
private PackageDoc pd
private OptionProvider parent
private ClassMatcher matcher
private String outputPath
Constructor Detail |
---|
public PackageView(String outputFolder, PackageDoc pd, RootDoc root, OptionProvider parent)
Method Detail |
---|
public String getDisplayName()
OptionProvider
Will be used to provide progress feedback on the console
getDisplayName
in interface OptionProvider
public Options getGlobalOptions()
OptionProvider
getGlobalOptions
in interface OptionProvider
public Options getOptionsFor(ClassDoc cd)
OptionProvider
getOptionsFor
in interface OptionProvider
public Options getOptionsFor(String name)
OptionProvider
getOptionsFor
in interface OptionProvider
public void overrideForClass(Options opt, ClassDoc cd)
OptionProvider
overrideForClass
in interface OptionProvider
public void overrideForClass(Options opt, String className)
OptionProvider
overrideForClass
in interface OptionProvider
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |