GfxdOptionBuilder (GemFire XD Java API Documentation)

java.lang.Object
- com.pivotal.gemfirexd.tools.internal.GfxdOptionBuilder

```
public final class GfxdOptionBuilder
extends Object
```
OptionBuilder allows the user to create Options using descriptive methods.
Details on the Builder pattern can be found at http://c2.com/cgi-bin/wiki?BuilderPattern.

Since:

1.0

Constructor Summary

Constructors
Constructor and Description

GfxdOptionBuilder()

Constructors
Constructor and Description
`GfxdOptionBuilder()`

Method Summary

Methods
Modifier and Type	Method and Description
`GfxdOption`	`create()` Create an Option using the current settings
`GfxdOption`	`create(char opt)` Create an Option using the current settings and with the specified Option `char`.
`GfxdOption`	`create(String opt)` Create an Option using the current settings and with the specified Option `char`.
`GfxdOptionBuilder`	`hasArg()` The next Option created will require an argument value.
`GfxdOptionBuilder`	`hasArg(boolean hasArg)` The next Option created will require an argument value if `hasArg` is true.
`GfxdOptionBuilder`	`hasArgs()` The next Option created can have unlimited argument values.
`GfxdOptionBuilder`	`hasArgs(int num)` The next Option created can have `num` argument values.
`GfxdOptionBuilder`	`hasOptionalArg()` The next Option can have an optional argument.
`GfxdOptionBuilder`	`hasOptionalArgs()` The next Option can have an unlimited number of optional arguments.
`GfxdOptionBuilder`	`hasOptionalArgs(int numArgs)` The next Option can have the specified number of optional arguments.
`GfxdOptionBuilder`	`isRequired()` The next Option created will be required.
`GfxdOptionBuilder`	`isRequired(boolean newRequired)` The next Option created will be required if `required` is true.
`GfxdOptionBuilder`	`withArgName(String name)` The next Option created will have the specified argument value name.
`GfxdOptionBuilder`	`withDescription(String newDescription)` The next Option created will have the specified description
`GfxdOptionBuilder`	`withLongOpt(String newLongopt)` The next Option created will have the following long option value.
`GfxdOptionBuilder`	`withType(Object newType)` The next Option created will have a value that will be an instance of `type`.
`GfxdOptionBuilder`	`withValueSeparator()` The next Option created uses '`=`' as a means to separate argument values.
`GfxdOptionBuilder`	`withValueSeparator(char sep)` The next Option created uses `sep` as a means to separate argument values.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - GfxdOptionBuilder
```
public GfxdOptionBuilder()
```
- Method Detail
  - withLongOpt
```
public GfxdOptionBuilder withLongOpt(String newLongopt)
```
    The next Option created will have the following long option value.
    
    Parameters:
    newLongopt - the long option value
    
    Returns:
    the OptionBuilder instance
  - hasArg
```
public GfxdOptionBuilder hasArg()
```
    The next Option created will require an argument value.
    
    Returns:
    the OptionBuilder instance
  - hasArg
```
public GfxdOptionBuilder hasArg(boolean hasArg)
```
    The next Option created will require an argument value if hasArg is true.
    
    Parameters:
    hasArg - if true then the Option has an argument value
    
    Returns:
    the OptionBuilder instance
  - withArgName
```
public GfxdOptionBuilder withArgName(String name)
```
    The next Option created will have the specified argument value name.
    
    Parameters:
    name - the name for the argument value
    
    Returns:
    the OptionBuilder instance
  - isRequired
```
public GfxdOptionBuilder isRequired()
```
    The next Option created will be required.
    
    Returns:
    the OptionBuilder instance
  - withValueSeparator
```
public GfxdOptionBuilder withValueSeparator(char sep)
```
    The next Option created uses sep as a means to separate argument values. Example:
```
 Option opt = this.withValueSeparator(':').create('D');
 
 CommandLine line = parser.parse(args);
 
 String propertyName = opt.getValue(0);
 String propertyValue = opt.getValue(1);
 
```
    Parameters:
    sep - The value separator to be used for the argument values.
    
    Returns:
    the OptionBuilder instance
  - withValueSeparator
```
public GfxdOptionBuilder withValueSeparator()
```
    The next Option created uses '=' as a means to separate argument values. Example:
```
 Option opt = this.withValueSeparator().create('D');
 
 CommandLine line = parser.parse(args);
 
 String propertyName = opt.getValue(0);
 String propertyValue = opt.getValue(1);
 
```
    Returns:
    the OptionBuilder instance
  - isRequired
```
public GfxdOptionBuilder isRequired(boolean newRequired)
```
    The next Option created will be required if required is true.
    
    Parameters:
    newRequired - if true then the Option is required
    
    Returns:
    the OptionBuilder instance
  - hasArgs
```
public GfxdOptionBuilder hasArgs()
```
    The next Option created can have unlimited argument values.
    
    Returns:
    the OptionBuilder instance
  - hasArgs
```
public GfxdOptionBuilder hasArgs(int num)
```
    The next Option created can have num argument values.
    
    Parameters:
    num - the number of args that the option can have
    
    Returns:
    the OptionBuilder instance
  - hasOptionalArg
```
public GfxdOptionBuilder hasOptionalArg()
```
    The next Option can have an optional argument.
    
    Returns:
    the OptionBuilder instance
  - hasOptionalArgs
```
public GfxdOptionBuilder hasOptionalArgs()
```
    The next Option can have an unlimited number of optional arguments.
    
    Returns:
    the OptionBuilder instance
  - hasOptionalArgs
```
public GfxdOptionBuilder hasOptionalArgs(int numArgs)
```
    The next Option can have the specified number of optional arguments.
    
    Parameters:
    numArgs - - the maximum number of optional arguments the next Option created can have.
    
    Returns:
    the OptionBuilder instance
  - withType
```
public GfxdOptionBuilder withType(Object newType)
```
    The next Option created will have a value that will be an instance of type.
    
    Parameters:
    newType - the type of the Options argument value
    
    Returns:
    the OptionBuilder instance
  - withDescription
```
public GfxdOptionBuilder withDescription(String newDescription)
```
    The next Option created will have the specified description
    
    Parameters:
    newDescription - a description of the Option's purpose
    
    Returns:
    the OptionBuilder instance
  - create
```
public GfxdOption create(char opt)
                  throws IllegalArgumentException
```
    Create an Option using the current settings and with the specified Option char.
    
    Parameters:
    opt - the character representation of the Option
    
    Returns:
    the Option instance
    
    Throws:
    
    IllegalArgumentException - if opt is not a valid character. See Option.
  - create
```
public GfxdOption create()
                  throws IllegalArgumentException
```
    Create an Option using the current settings
    
    Returns:
    the Option instance
    
    Throws:
    
    IllegalArgumentException - if longOpt has not been set.
  - create
```
public GfxdOption create(String opt)
                  throws IllegalArgumentException
```
    Create an Option using the current settings and with the specified Option char.
    
    Parameters:
    opt - the java.lang.String representation of the Option
    
    Returns:
    the Option instance
    
    Throws:
    
    IllegalArgumentException - if opt is not a valid character. See Option.

Class GfxdOptionBuilder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

GfxdOptionBuilder

Method Detail

withLongOpt

hasArg

hasArg

withArgName

isRequired

withValueSeparator

withValueSeparator

isRequired

hasArgs

hasArgs

hasOptionalArg

hasOptionalArgs

hasOptionalArgs

withType

withDescription

create

create

create