com.pivotal.gemfirexd.tools.internal

Class GfxdOption

java.lang.Object

org.apache.commons.cli.Option

com.pivotal.gemfirexd.tools.internal.GfxdOption

All Implemented Interfaces:

Serializable, Cloneable

public class GfxdOption
extends org.apache.commons.cli.Option

A dirty hack to override commons Option for GemFireXD to allow for '-' in option names. We should ship a modified commons-cli with source instead.

Since:

7.0

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.commons.cli.Option

org.apache.commons.cli.Option.Builder

Field Summary

Fields inherited from class org.apache.commons.cli.Option

UNINITIALIZED, UNLIMITED_VALUES

Constructor Summary

Constructors

Constructor and Description
GfxdOption(String opt, boolean hasArg, String description) Creates an Option using the specified parameters.
GfxdOption(String opt, String description)
GfxdOption(String opt, String longOpt, boolean hasArg, String description) Creates an Option using the specified parameters.

Method Summary

Methods

Modifier and Type	Method and Description
String	getOptionValue(String opt) Get a single value for this option if the given option string matches this option (either long or short).
String	getOptKey() Returns the 'unique' Option identifier.

Methods inherited from class org.apache.commons.cli.Option

addValue, builder, builder, clone, equals, getArgName, getArgs, getDescription, getId, getLongOpt, getOpt, getType, getValue, getValue, getValue, getValues, getValueSeparator, getValuesList, hasArg, hasArgName, hasArgs, hashCode, hasLongOpt, hasOptionalArg, hasValueSeparator, isRequired, setArgName, setArgs, setDescription, setLongOpt, setOptionalArg, setRequired, setType, setType, setValueSeparator, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

GfxdOption

public GfxdOption(String opt,
          String description)
           throws IllegalArgumentException

Throws:

IllegalArgumentException

GfxdOption

public GfxdOption(String opt,
          boolean hasArg,
          String description)
           throws IllegalArgumentException

Creates an Option using the specified parameters.

Parameters:

opt - short representation of the option

hasArg - specifies whether the Option takes an argument or not

description - describes the function of the option

Throws:

IllegalArgumentException - if there are any non valid Option characters in opt.

GfxdOption

public GfxdOption(String opt,
          String longOpt,
          boolean hasArg,
          String description)
           throws IllegalArgumentException

Creates an Option using the specified parameters.

Parameters:

opt - short representation of the option

longOpt - the long representation of the option

hasArg - specifies whether the Option takes an argument or not

description - describes the function of the option

Throws:

IllegalArgumentException - if there are any non valid Option characters in opt.

Method Detail

getOptionValue

public final String getOptionValue(String opt)

Get a single value for this option if the given option string matches this option (either long or short).

getOptKey

public final String getOptKey()

Returns the 'unique' Option identifier.

Returns:

the 'unique' Option identifier