org.umlgraph.doclet

Class Options

java.lang.Object

org.umlgraph.doclet.Options

All Implemented Interfaces:

java.lang.Cloneable, OptionProvider

public class Options
extends java.lang.Object
implements java.lang.Cloneable, OptionProvider

Represent the program options

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	DEFAULT_EXTERNAL_APIDOC
java.lang.String	outputDirectory
java.lang.String	outputFileName

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.Object	clone()
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(ClassDoc cd) 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, ClassDoc cd) Gets a base Options and applies the overrides for the specified class
void	setAll() Most complete output
void	setOptions(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()

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

DEFAULT_EXTERNAL_APIDOC

protected static final java.lang.String DEFAULT_EXTERNAL_APIDOC

See Also:

Constant Field Values

outputFileName

public java.lang.String outputFileName

outputDirectory

public java.lang.String outputDirectory

Method Detail

clone

public java.lang.Object clone()

Overrides:

clone in class java.lang.Object

setAll

public void setAll()

Most complete output

optionLength

public static int optionLength(java.lang.String option)

Return the number of arguments associated with the specified option. The return value includes the actual option. Will return 0 if the option is not supported.

getApiDocRoot

public java.lang.String getApiDocRoot(java.lang.String className)

Returns the appropriate URL "root" for an external class name. It will match the class name against the regular expressions specified in the 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.

setOptions

public void setOptions(java.lang.String[][] options)

Set the options based on the command line parameters

setOptions

public void setOptions(ClassDoc p)

Set the options based on the tag elements of the ClassDoc parameter

matchesHideExpression

public boolean matchesHideExpression(java.lang.String s)

Check if the supplied string matches an entity specified with the -hide parameter.

Returns:

true if the string matches.

matchesCollPackageExpression

public boolean matchesCollPackageExpression(java.lang.String s)

Check if the supplied string matches an entity specified with the -hide parameter.

Returns:

true if the string matches.

getOptionsFor

public Options getOptionsFor(ClassDoc cd)

Description copied from interface: OptionProvider

Returns the options for the specified class.

Specified by:

getOptionsFor 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

overrideForClass

public void overrideForClass(Options opt,
                    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

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

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object