public class Options extends java.lang.Object implements java.lang.Cloneable, OptionProvider
Modifier and Type | Field and Description |
---|---|
private static java.util.regex.Pattern |
allPattern |
(package private) java.util.Map<java.util.regex.Pattern,java.lang.String> |
apiDocMap |
(package private) java.lang.String |
apiDocRoot |
(package private) java.lang.String |
bgColor |
(package private) boolean |
collapsibleDiagrams |
private java.util.Vector<java.util.regex.Pattern> |
collPackages |
(package private) boolean |
compact |
(package private) RelationPattern |
contextRelationPattern |
protected static java.lang.String |
DEFAULT_EXTERNAL_APIDOC |
private static java.lang.String |
defaultFont |
private static java.lang.String |
defaultItalicFont |
(package private) java.lang.String |
dotExecutable |
(package private) java.lang.String |
edgeColor |
(package private) java.lang.String |
edgeFontColor |
(package private) java.lang.String |
edgeFontName |
(package private) double |
edgeFontSize |
(package private) boolean |
findViews |
(package private) java.lang.String |
guilClose
Guillemot right (close)
|
(package private) java.lang.String |
guilOpen
Guillemot left (open)
|
(package private) java.util.Vector<java.util.regex.Pattern> |
hidePatterns |
(package private) boolean |
horizontal |
(package private) boolean |
inferDependencies |
(package private) Visibility |
inferDependencyVisibility |
(package private) boolean |
inferDepInPackage |
(package private) boolean |
inferRelationships |
(package private) RelationType |
inferRelationshipType |
(package private) java.lang.String |
nodeFillColor |
(package private) java.lang.String |
nodeFontAbstractName |
(package private) java.lang.String |
nodeFontClassAbstractName |
(package private) java.lang.String |
nodeFontClassName |
(package private) double |
nodeFontClassSize |
(package private) java.lang.String |
nodeFontColor |
(package private) java.lang.String |
nodeFontName |
(package private) java.lang.String |
nodeFontPackageName |
(package private) double |
nodeFontPackageSize |
(package private) double |
nodeFontSize |
(package private) java.lang.String |
nodeFontTagName |
(package private) double |
nodeFontTagSize |
(package private) double |
nodeSep |
java.lang.String |
outputDirectory |
(package private) java.lang.String |
outputEncoding |
java.lang.String |
outputFileName |
(package private) boolean |
postfixPackage |
(package private) double |
rankSep |
(package private) boolean |
relativeLinksForSourcePackages |
(package private) Shape |
shape |
(package private) boolean |
showAttributes |
(package private) boolean |
showComment |
(package private) boolean |
showConstructors |
(package private) boolean |
showEnumConstants |
(package private) boolean |
showEnumerations |
(package private) boolean |
showOperations |
(package private) boolean |
showQualified |
(package private) boolean |
showType |
(package private) boolean |
showVisibility |
(package private) boolean |
strictMatching |
(package private) boolean |
useGuillemot |
(package private) boolean |
useImports |
(package private) java.lang.String |
viewName |
Constructor and Description |
---|
Options() |
Modifier and Type | Method and Description |
---|---|
private void |
addApiDocRoots(java.lang.String packageListUrl)
Adds api doc roots from a link.
|
private void |
addApiDocRootsOffline(java.lang.String docUrl,
java.lang.String packageListUrl)
Adds api doc roots from an offline link.
|
java.lang.Object |
clone() |
private java.lang.String |
fixApiDocRoot(java.lang.String str)
Trim and append a file separator to the string
|
java.lang.String |
getApiDocRoot(java.lang.String className)
Returns the appropriate URL "root" for an external class name.
|
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.
|
boolean |
matchesCollPackageExpression(java.lang.String s)
Check if the supplied string matches an entity specified
with the -hide parameter.
|
boolean |
matchesHideExpression(java.lang.String s)
Check if the supplied string matches an entity specified
with the -hide parameter.
|
static int |
optionLength(java.lang.String option)
Return the number of arguments associated with the specified option.
|
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
|
void |
setAll()
Most complete output
|
(package private) void |
setApiDocMapFile(java.lang.String apiDocMapFileName)
Loads the property file referred by
apiDocMapFileName and fills the apiDocMap
accordingly |
(package private) void |
setOption(java.lang.String[] opt)
Set the options based on a single option and its arguments
|
void |
setOptions(com.sun.javadoc.ClassDoc p)
Set the options based on the tag elements of the ClassDoc parameter
|
void |
setOptions(java.lang.String[][] options)
Set the options based on the command line parameters
|
java.lang.String |
toString() |
private static java.lang.String defaultFont
private static java.lang.String defaultItalicFont
private static final java.util.regex.Pattern allPattern
protected static final java.lang.String DEFAULT_EXTERNAL_APIDOC
java.util.Vector<java.util.regex.Pattern> hidePatterns
boolean showQualified
boolean showAttributes
boolean showEnumerations
boolean showEnumConstants
boolean showOperations
boolean showConstructors
boolean showVisibility
boolean horizontal
boolean showType
boolean showComment
java.lang.String edgeFontName
java.lang.String edgeFontColor
java.lang.String edgeColor
double edgeFontSize
java.lang.String nodeFontName
java.lang.String nodeFontAbstractName
java.lang.String nodeFontColor
double nodeFontSize
java.lang.String nodeFillColor
double nodeFontClassSize
java.lang.String nodeFontClassName
java.lang.String nodeFontClassAbstractName
double nodeFontTagSize
java.lang.String nodeFontTagName
double nodeFontPackageSize
java.lang.String nodeFontPackageName
Shape shape
java.lang.String bgColor
public java.lang.String outputFileName
java.lang.String outputEncoding
java.util.Map<java.util.regex.Pattern,java.lang.String> apiDocMap
java.lang.String apiDocRoot
boolean postfixPackage
boolean useGuillemot
boolean findViews
java.lang.String viewName
double nodeSep
double rankSep
public java.lang.String outputDirectory
java.lang.String guilOpen
java.lang.String guilClose
boolean inferRelationships
boolean inferDependencies
boolean collapsibleDiagrams
RelationPattern contextRelationPattern
boolean useImports
Visibility inferDependencyVisibility
boolean inferDepInPackage
RelationType inferRelationshipType
private java.util.Vector<java.util.regex.Pattern> collPackages
boolean compact
boolean relativeLinksForSourcePackages
boolean strictMatching
java.lang.String dotExecutable
public java.lang.Object clone()
clone
in class java.lang.Object
public void setAll()
public static int optionLength(java.lang.String option)
void setOption(java.lang.String[] opt)
private void addApiDocRoots(java.lang.String packageListUrl)
packageListUrl
- private void addApiDocRootsOffline(java.lang.String docUrl, java.lang.String packageListUrl)
docUrl
- folder containing the javadocpackageListUrl
- folder containing the package-listvoid setApiDocMapFile(java.lang.String apiDocMapFileName)
apiDocMapFileName
and fills the apiDocMap
accordinglyapiDocMapFileName
- public java.lang.String getApiDocRoot(java.lang.String className)
apiDocMap
; if a match is found, the associated URL
will be returned.
NOTE: The match order of the match attempts is the one specified by the
constructor of the api doc root, so it depends on the order of "-link" and "-apiDocMap"
parameters.private java.lang.String fixApiDocRoot(java.lang.String str)
public void setOptions(java.lang.String[][] options)
public void setOptions(com.sun.javadoc.ClassDoc p)
public boolean matchesHideExpression(java.lang.String s)
public boolean matchesCollPackageExpression(java.lang.String s)
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 Options getGlobalOptions()
OptionProvider
getGlobalOptions
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
public java.lang.String getDisplayName()
OptionProvider
Will be used to provide progress feedback on the console
getDisplayName
in interface OptionProvider
public java.lang.String toString()
toString
in class java.lang.Object