Package org.exolab.castor.util
Class CmdLineOption
java.lang.Object
org.exolab.castor.util.CmdLineOption
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionReturns the comment for this option.getFlag()
Returns the flag associated with this command line option.boolean
Returns whether or not this CmdLineOption is optional or not.Returns the text to print after the flag when printing the usage line.void
setComment
(String comment) Sets a comment for the flag.void
setOptional
(boolean optional) Sets whether or not this CmdLineOption is optional or not.void
setUsageText
(String usageText) Sets the text to print after the flag when printing the usage line.
-
Constructor Details
-
CmdLineOption
CmdLineOption(String flag) Creates a new CmdLineOption.- Parameters:
flag
- The flag associated with this command line option.
-
-
Method Details
-
getFlag
Returns the flag associated with this command line option.- Returns:
- the flag associated with this command line option.
-
getOptional
public boolean getOptional()Returns whether or not this CmdLineOption is optional or not.- Returns:
- true if this CmdLineOption is optional, otherwise false.
-
getComment
Returns the comment for this option.- Returns:
- the comment for this command line option.
-
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.
-
setOptional
public void 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.
-
setComment
Sets a comment for the flag.- Parameters:
comment
- the comment to use when printing help for the given flag.
-
setUsageText
Sets the text to print after the flag when printing the usage line.- Parameters:
usageText
- the usage text.
-