|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.umlgraph.doclet.Options
public class Options
Represent the program options
Field Summary | |
---|---|
private static Pattern |
allPattern
|
(package private) Map<Pattern,String> |
apiDocMap
|
(package private) String |
apiDocRoot
|
(package private) String |
bgColor
|
(package private) boolean |
collapsibleDiagrams
|
private Vector<Pattern> |
collPackages
|
(package private) boolean |
compact
|
(package private) RelationPattern |
contextRelationPattern
|
protected static String |
DEFAULT_EXTERNAL_APIDOC
|
private static String |
defaultFont
|
private static String |
defaultItalicFont
|
(package private) String |
dotExecutable
|
(package private) String |
edgeColor
|
(package private) String |
edgeFontColor
|
(package private) String |
edgeFontName
|
(package private) double |
edgeFontSize
|
(package private) boolean |
findViews
|
(package private) String |
guilClose
Guillemot right (close) |
(package private) String |
guilOpen
Guillemot left (open) |
(package private) Vector<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) String |
nodeFillColor
|
(package private) String |
nodeFontAbstractName
|
(package private) String |
nodeFontClassAbstractName
|
(package private) String |
nodeFontClassName
|
(package private) double |
nodeFontClassSize
|
(package private) String |
nodeFontColor
|
(package private) String |
nodeFontName
|
(package private) String |
nodeFontPackageName
|
(package private) double |
nodeFontPackageSize
|
(package private) double |
nodeFontSize
|
(package private) String |
nodeFontTagName
|
(package private) double |
nodeFontTagSize
|
(package private) double |
nodeSep
|
String |
outputDirectory
|
(package private) String |
outputEncoding
|
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) String |
viewName
|
Constructor Summary | |
---|---|
Options()
|
Method Summary | |
---|---|
private void |
addApiDocRoots(String packageListUrl)
Adds api doc roots from a link. |
private void |
addApiDocRootsOffline(String docUrl,
String packageListUrl)
Adds api doc roots from an offline link. |
Object |
clone()
|
private String |
fixApiDocRoot(String str)
Trim and append a file separator to the string |
String |
getApiDocRoot(String className)
Returns the appropriate URL "root" for an external class name. |
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. |
boolean |
matchesCollPackageExpression(String s)
Check if the supplied string matches an entity specified with the -hide parameter. |
boolean |
matchesHideExpression(String s)
Check if the supplied string matches an entity specified with the -hide parameter. |
static int |
optionLength(String option)
Return the number of arguments associated with the specified option. |
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 |
void |
setAll()
Most complete output |
(package private) void |
setApiDocMapFile(String apiDocMapFileName)
Loads the property file referred by apiDocMapFileName and fills the apiDocMap
accordingly |
(package private) void |
setOption(String[] opt)
Set the options based on a single option and its arguments |
void |
setOptions(ClassDoc p)
Set the options based on the tag elements of the ClassDoc parameter |
void |
setOptions(String[][] options)
Set the options based on the command line parameters |
String |
toString()
|
Methods inherited from class java.lang.Object |
---|
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
private static String defaultFont
private static String defaultItalicFont
private static final Pattern allPattern
protected static final String DEFAULT_EXTERNAL_APIDOC
Vector<Pattern> hidePatterns
boolean showQualified
boolean showAttributes
boolean showEnumerations
boolean showEnumConstants
boolean showOperations
boolean showConstructors
boolean showVisibility
boolean horizontal
boolean showType
boolean showComment
String edgeFontName
String edgeFontColor
String edgeColor
double edgeFontSize
String nodeFontName
String nodeFontAbstractName
String nodeFontColor
double nodeFontSize
String nodeFillColor
double nodeFontClassSize
String nodeFontClassName
String nodeFontClassAbstractName
double nodeFontTagSize
String nodeFontTagName
double nodeFontPackageSize
String nodeFontPackageName
Shape shape
String bgColor
public String outputFileName
String outputEncoding
Map<Pattern,String> apiDocMap
String apiDocRoot
boolean postfixPackage
boolean useGuillemot
boolean findViews
String viewName
double nodeSep
double rankSep
public String outputDirectory
String guilOpen
String guilClose
boolean inferRelationships
boolean inferDependencies
boolean collapsibleDiagrams
RelationPattern contextRelationPattern
boolean useImports
Visibility inferDependencyVisibility
boolean inferDepInPackage
RelationType inferRelationshipType
private Vector<Pattern> collPackages
boolean compact
boolean relativeLinksForSourcePackages
boolean strictMatching
String dotExecutable
Constructor Detail |
---|
Options()
Method Detail |
---|
public Object clone()
clone
in class Object
public void setAll()
public static int optionLength(String option)
void setOption(String[] opt)
private void addApiDocRoots(String packageListUrl)
packageListUrl
- private void addApiDocRootsOffline(String docUrl, String packageListUrl)
docUrl
- folder containing the javadocpackageListUrl
- folder containing the package-listvoid setApiDocMapFile(String apiDocMapFileName)
apiDocMapFileName
and fills the apiDocMap
accordingly
apiDocMapFileName
- public String getApiDocRoot(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 String fixApiDocRoot(String str)
public void setOptions(String[][] options)
public void setOptions(ClassDoc p)
public boolean matchesHideExpression(String s)
public boolean matchesCollPackageExpression(String s)
public Options getOptionsFor(ClassDoc cd)
OptionProvider
getOptionsFor
in interface OptionProvider
public Options getOptionsFor(String name)
OptionProvider
getOptionsFor
in interface OptionProvider
public Options getGlobalOptions()
OptionProvider
getGlobalOptions
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
public String getDisplayName()
OptionProvider
Will be used to provide progress feedback on the console
getDisplayName
in interface OptionProvider
public String toString()
toString
in class Object
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |