org.exolab.castor.util.CmdLineOption Class Reference

List of all members.

Public Member Functions
String	getFlag ()
boolean	getOptional ()
String	getComment ()
String	getUsageText ()
void	setOptional (boolean optional)
void	setComment (String comment)
void	setUsageText (String usageText)
Package Functions
	CmdLineOption (String flag)
Package Attributes
boolean	optional = false
String	usageText = null
String	comment = null
String	flag = null

---

Constructor & Destructor Documentation

org.exolab.castor.util.CmdLineOption.CmdLineOption

(

String

flag

)

[package]

Creates a new CmdLineOption

Parameters:

the

flag associated with this command line option

---

Member Function Documentation

String org.exolab.castor.util.CmdLineOption.getComment

(

)

Returns the comment for this option

Returns:

the comment for this command line option

References org.exolab.castor.util.CmdLineOption.comment.

Referenced by org.exolab.castor.util.CommandLineOptions.printHelp().

String org.exolab.castor.util.CmdLineOption.getFlag

(

)

Returns the flag associated with this command line option

Returns:

the flag associated with this command line option

References org.exolab.castor.util.CmdLineOption.flag.

boolean org.exolab.castor.util.CmdLineOption.getOptional

(

)

Returns whether or not this CmdLineOption is optional or not

Returns:

true if this CmdLineOption is optional, otherwise false

References org.exolab.castor.util.CmdLineOption.optional.

Referenced by org.exolab.castor.util.CommandLineOptions.printUsage().

String org.exolab.castor.util.CmdLineOption.getUsageText

(

)

Returns the text to print after the flag when printing the usage line

Returns:

the text to print after the flag when printing the usage line

References org.exolab.castor.util.CmdLineOption.usageText.

Referenced by org.exolab.castor.util.CommandLineOptions.printUsage().

void org.exolab.castor.util.CmdLineOption.setComment

(

String

comment

)

Sets a comment for the flag

Parameters:

comment

the comment to use when printing help for the given flag

Referenced by org.exolab.castor.util.CommandLineOptions.addFlag(), and org.exolab.castor.util.CommandLineOptions.setComment().

void org.exolab.castor.util.CmdLineOption.setOptional

(

boolean

optional

)

Sets whether or not this CmdLineOption is optional or not

Parameters:

optional

the flag indicating whether or not this CmdLineOption is optional

Referenced by org.exolab.castor.util.CommandLineOptions.addFlag(), and org.exolab.castor.util.CommandLineOptions.setOptional().

void org.exolab.castor.util.CmdLineOption.setUsageText

(

String

usageText

)

Sets the text to print after the flag when printing the usage line

Parameters:

usageText

the usage text

Referenced by org.exolab.castor.util.CommandLineOptions.addFlag(), and org.exolab.castor.util.CommandLineOptions.setUsageInfo().

---

Member Data Documentation

String org.exolab.castor.util.CmdLineOption.comment = null [package]

Referenced by org.exolab.castor.util.CmdLineOption.getComment().

String org.exolab.castor.util.CmdLineOption.flag = null [package]

Referenced by org.exolab.castor.util.CmdLineOption.getFlag().

boolean org.exolab.castor.util.CmdLineOption.optional = false [package]

Referenced by org.exolab.castor.util.CmdLineOption.getOptional().

String org.exolab.castor.util.CmdLineOption.usageText = null [package]

Referenced by org.exolab.castor.util.CmdLineOption.getUsageText().

---

The documentation for this class was generated from the following file:

• CommandLineOptions.java