com.ibm.pdp.product.tools.extension
Class RppOption

java.lang.Object
  extended by com.ibm.pdp.product.tools.extension.RppOption
All Implemented Interfaces:
IRppOption

public class RppOption
extends java.lang.Object
implements IRppOption

Concrete IRppOption class.


Field Summary
static java.lang.String copyright
           
 
Method Summary
static IRppOption createCommandOption(java.lang.String optionName, java.lang.String optionShortcut, java.lang.String optionComments)
          Creates a new command option.
static IRppOption createOption(java.lang.String optionName, java.lang.String optionShortcut, java.lang.String optionComments, boolean isBoolean, boolean isRepeated, boolean isRequired, java.lang.String[] allowedValues)
          Creates a new sub command option.
 java.lang.String[] getAllowedValues()
          Returns the allowed values for this option.
 java.lang.String getOptionComments()
          Returns the option comments.
 java.lang.String getOptionName()
          Returns the option name.
 java.lang.String getOptionShortcut()
          Returns the option shortcut.
 boolean isBoolean()
          Returns true if the option is a boolean option
 boolean isLightweight()
          Returns the is lightweight value.
 boolean isPrivate()
          Returns true is the option is private
 boolean isRepeated()
          Returns true is this option can be repeated in the commande line.
 boolean isRequired()
          Returns true if the option is mandatory.
 void setLightweight(boolean isLightweight)
          Sets the is lightweight value.
 void setPrivate(boolean isPrivate)
          Makes the option private.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

copyright

public static final java.lang.String copyright
See Also:
Constant Field Values
Method Detail

createCommandOption

public static IRppOption createCommandOption(java.lang.String optionName,
                                             java.lang.String optionShortcut,
                                             java.lang.String optionComments)
Creates a new command option.

Parameters:
optionName -
optionShortcut -
optionComments -
Returns:

createOption

public static IRppOption createOption(java.lang.String optionName,
                                      java.lang.String optionShortcut,
                                      java.lang.String optionComments,
                                      boolean isBoolean,
                                      boolean isRepeated,
                                      boolean isRequired,
                                      java.lang.String[] allowedValues)
Creates a new sub command option.

Parameters:
optionName -
optionShortcut -
optionComments -
isBoolean -
isRepeated -
isRequired -
allowedValues -
Returns:

getAllowedValues

public java.lang.String[] getAllowedValues()
Returns the allowed values for this option.

Specified by:
getAllowedValues in interface IRppOption
Returns:

getOptionComments

public java.lang.String getOptionComments()
Returns the option comments.

Specified by:
getOptionComments in interface IRppOption
Returns:

getOptionName

public java.lang.String getOptionName()
Returns the option name.

Specified by:
getOptionName in interface IRppOption
Returns:

getOptionShortcut

public java.lang.String getOptionShortcut()
Returns the option shortcut.

Specified by:
getOptionShortcut in interface IRppOption
Returns:

isBoolean

public boolean isBoolean()
Returns true if the option is a boolean option. - a boolean option have no associated value.

Specified by:
isBoolean in interface IRppOption
Returns:

isLightweight

public boolean isLightweight()
Returns the is lightweight value.

Specified by:
isLightweight in interface IRppOption
Returns:

isPrivate

public boolean isPrivate()
Returns true is the option is private. - A private option will not be displayed in the syntaxe.

Specified by:
isPrivate in interface IRppOption
Returns:

isRepeated

public boolean isRepeated()
Returns true is this option can be repeated in the commande line.

Specified by:
isRepeated in interface IRppOption
Returns:

isRequired

public boolean isRequired()
Returns true if the option is mandatory.

Specified by:
isRequired in interface IRppOption
Returns:

setLightweight

public void setLightweight(boolean isLightweight)
Sets the is lightweight value.

Parameters:
isLightweight -

setPrivate

public void setPrivate(boolean isPrivate)
Makes the option private.

Parameters:
isPrivate -