public class PackageView extends java.lang.Object implements OptionProvider
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).
Modifier and Type | Field and Description |
---|---|
private ClassMatcher |
matcher |
private java.lang.String |
outputPath |
private OptionProvider |
parent |
private com.sun.javadoc.PackageDoc |
pd |
Constructor and Description |
---|
PackageView(java.lang.String outputFolder,
com.sun.javadoc.PackageDoc pd,
com.sun.javadoc.RootDoc root,
OptionProvider parent) |
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(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
|
private com.sun.javadoc.PackageDoc pd
private OptionProvider parent
private ClassMatcher matcher
private java.lang.String outputPath
public PackageView(java.lang.String outputFolder, com.sun.javadoc.PackageDoc pd, com.sun.javadoc.RootDoc root, OptionProvider parent)
public java.lang.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(com.sun.javadoc.ClassDoc cd)
OptionProvider
getOptionsFor
in interface OptionProvider
public Options getOptionsFor(java.lang.String name)
OptionProvider
getOptionsFor
in interface OptionProvider
public void overrideForClass(Options opt, com.sun.javadoc.ClassDoc cd)
OptionProvider
overrideForClass
in interface OptionProvider
public void overrideForClass(Options opt, java.lang.String className)
OptionProvider
overrideForClass
in interface OptionProvider