org.apache.commons.cli2.builder
Class CommandBuilder

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

public class CommandBuilder
extends java.lang.Object

Builds Command instances


Field Summary
private  java.util.Set aliases
          the aliases of the command
private  Argument argument
          the argument of the command
private  Group children
          the children of the command
private  java.lang.String description
          the description of the command
private  int id
          the id of the command
private  java.lang.String preferredName
          the preferred name of the command
private  boolean required
          whether the command is required or not
 
Constructor Summary
CommandBuilder()
          Creates a new CommandBuilder instance.
 
Method Summary
 Command create()
          Creates a new Command instance using the properties of the CommandBuilder.
 CommandBuilder reset()
          Resets the CommandBuilder to the defaults for a new Command.
 CommandBuilder withArgument(Argument newArgument)
          Specifies the argument for the next Command that is created.
 CommandBuilder withChildren(Group newChildren)
          Specifies the children for the next Command that is created.
 CommandBuilder withDescription(java.lang.String newDescription)
          Specifies the description for the next Command that is created.
 CommandBuilder withId(int newId)
          Specifies the id for the next Command that is created.
 CommandBuilder withName(java.lang.String name)
          Specifies the name for the next Command that is created.
 CommandBuilder withRequired(boolean newRequired)
          Specifies whether the next Command created is required or not.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

preferredName

private java.lang.String preferredName
the preferred name of the command


description

private java.lang.String description
the description of the command


aliases

private java.util.Set aliases
the aliases of the command


required

private boolean required
whether the command is required or not


argument

private Argument argument
the argument of the command


children

private Group children
the children of the command


id

private int id
the id of the command

Constructor Detail

CommandBuilder

public CommandBuilder()
Creates a new CommandBuilder instance.

Method Detail

create

public Command create()
Creates a new Command instance using the properties of the CommandBuilder.

Returns:
the new Command instance

reset

public CommandBuilder reset()
Resets the CommandBuilder to the defaults for a new Command. This method is called automatically at the end of the create method.


withName

public CommandBuilder withName(java.lang.String name)
Specifies the name for the next Command that is created. The first name is used as the preferred display name for the Command and then later names are used as aliases.

Parameters:
name - the name for the next Command that is created.
Returns:
this CommandBuilder.

withDescription

public CommandBuilder withDescription(java.lang.String newDescription)
Specifies the description for the next Command that is created. This description is used to produce help documentation for the Command.

Parameters:
newDescription - the description for the next Command that is created.
Returns:
this CommandBuilder.

withRequired

public CommandBuilder withRequired(boolean newRequired)
Specifies whether the next Command created is required or not.

Parameters:
newRequired - whether the next Command created is required or not.
Returns:
this CommandBuilder.

withChildren

public CommandBuilder withChildren(Group newChildren)
Specifies the children for the next Command that is created.

Parameters:
newChildren - the child options for the next Command that is created.
Returns:
this CommandBuilder.

withArgument

public CommandBuilder withArgument(Argument newArgument)
Specifies the argument for the next Command that is created.

Parameters:
newArgument - the argument for the next Command that is created.
Returns:
this CommandBuilder.

withId

public final CommandBuilder withId(int newId)
Specifies the id for the next Command that is created.

Parameters:
newId - the id for the next Command that is created.
Returns:
this CommandBuilder.