org.apache.commons.cli2.builder
Class DefaultOptionBuilder

java.lang.Object
  extended by org.apache.commons.cli2.builder.DefaultOptionBuilder

public class DefaultOptionBuilder
extends java.lang.Object

Builds DefaultOption instances.


Field Summary
private  java.util.Set aliases
           
private  Argument argument
           
private  java.util.Set burstAliases
           
private  boolean burstEnabled
           
private  Group children
           
private  java.lang.String description
           
private  int id
           
private  java.lang.String longPrefix
           
private  java.lang.String preferredName
           
private  boolean required
           
private  java.lang.String shortPrefix
           
 
Constructor Summary
DefaultOptionBuilder()
          Creates a new DefaultOptionBuilder using defaults
DefaultOptionBuilder(java.lang.String shortPrefix, java.lang.String longPrefix, boolean burstEnabled)
          Creates a new DefaultOptionBuilder
 
Method Summary
 DefaultOption create()
          Creates a DefaultOption instance
 DefaultOptionBuilder reset()
          Resets the builder
 DefaultOptionBuilder withArgument(Argument newArgument)
          Use this Argument
 DefaultOptionBuilder withChildren(Group newChildren)
          Use this child Group
 DefaultOptionBuilder withDescription(java.lang.String newDescription)
          Use this option description
 DefaultOptionBuilder withId(int newId)
          Sets the id
 DefaultOptionBuilder withLongName(java.lang.String longName)
          Use this long option name.
 DefaultOptionBuilder withRequired(boolean newRequired)
          Use this optionality
 DefaultOptionBuilder withShortName(java.lang.String shortName)
          Use this short option name.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

shortPrefix

private final java.lang.String shortPrefix

longPrefix

private final java.lang.String longPrefix

burstEnabled

private final boolean burstEnabled

preferredName

private java.lang.String preferredName

aliases

private java.util.Set aliases

burstAliases

private java.util.Set burstAliases

required

private boolean required

description

private java.lang.String description

argument

private Argument argument

children

private Group children

id

private int id
Constructor Detail

DefaultOptionBuilder

public DefaultOptionBuilder()
Creates a new DefaultOptionBuilder using defaults

See Also:
DefaultOption.DEFAULT_SHORT_PREFIX, DefaultOption.DEFAULT_LONG_PREFIX, DefaultOption.DEFAULT_BURST_ENABLED

DefaultOptionBuilder

public DefaultOptionBuilder(java.lang.String shortPrefix,
                            java.lang.String longPrefix,
                            boolean burstEnabled)
                     throws java.lang.IllegalArgumentException
Creates a new DefaultOptionBuilder

Parameters:
shortPrefix - the prefix to use for short options
longPrefix - the prefix to use for long options
burstEnabled - whether to allow gnu style bursting
Throws:
java.lang.IllegalArgumentException - if either prefix is less than on character long
Method Detail

create

public DefaultOption create()
                     throws java.lang.IllegalStateException
Creates a DefaultOption instance

Returns:
the new instance
Throws:
java.lang.IllegalStateException - if no names have been supplied

reset

public DefaultOptionBuilder reset()
Resets the builder


withShortName

public DefaultOptionBuilder withShortName(java.lang.String shortName)
Use this short option name. The first name is used as the preferred display name for the Command and then later names are used as aliases.

Parameters:
shortName - the name to use
Returns:
this builder

withLongName

public DefaultOptionBuilder withLongName(java.lang.String longName)
Use this long option name. The first name is used as the preferred display name for the Command and then later names are used as aliases.

Parameters:
longName - the name to use
Returns:
this builder

withDescription

public DefaultOptionBuilder withDescription(java.lang.String newDescription)
Use this option description

Parameters:
newDescription - the description to use
Returns:
this builder

withRequired

public DefaultOptionBuilder withRequired(boolean newRequired)
Use this optionality

Parameters:
newRequired - true iff the Option is required
Returns:
this builder

withChildren

public DefaultOptionBuilder withChildren(Group newChildren)
Use this child Group

Parameters:
newChildren - the child Group to use
Returns:
this builder

withArgument

public DefaultOptionBuilder withArgument(Argument newArgument)
Use this Argument

Parameters:
newArgument - the argument to use
Returns:
this builder

withId

public final DefaultOptionBuilder withId(int newId)
Sets the id

Parameters:
newId - the id of the DefaultOption
Returns:
this DefaultOptionBuilder