org.exolab.castor.util

Class CmdLineOption


(package private) class CmdLineOption
extends java.lang.Object

Field Summary

(package private) String
comment
(package private) String
flag
(package private) boolean
optional
(package private) String
usageText

Constructor Summary

CmdLineOption(String flag)
Creates a new CmdLineOption

Method Summary

String
getComment()
Returns the comment for this option
String
getFlag()
Returns the flag associated with this command line option
boolean
getOptional()
Returns whether or not this CmdLineOption is optional or not
String
getUsageText()
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

Field Details

comment

(package private)  String comment


flag

(package private)  String flag


optional

(package private)  boolean optional


usageText

(package private)  String usageText

Constructor Details

CmdLineOption

(package private)  CmdLineOption(String flag)
Creates a new CmdLineOption

Parameters:

Method Details

getComment

public String getComment()
Returns the comment for this option

Returns:
the comment for this command line option


getFlag

public String 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


getUsageText

public String 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


setComment

public void setComment(String comment)
Sets a comment for the flag

Parameters:
comment - the comment to use when printing help for the given flag


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


setUsageText

public void setUsageText(String usageText)
Sets the text to print after the flag when printing the usage line

Parameters:
usageText - the usage text


Intalio Inc. (C) 1999-2003. All rights reserved http://www.intalio.com