net.dpml.cli.builder

Class CommandBuilder

public class CommandBuilder extends Object

Builds Command instances

Version: @PROJECT-VERSION@

Author: @PUBLISHER-NAME@

Constructor Summary
CommandBuilder()
Creates a new CommandBuilder instance.
Method Summary
Commandcreate()
Creates a new Command instance using the properties of the CommandBuilder.
CommandBuilderreset()
Resets the CommandBuilder to the defaults for a new Command.
CommandBuilderwithArgument(Argument newArgument)
Specifies the argument for the next Command that is created.
CommandBuilderwithChildren(Group newChildren)
Specifies the children for the next Command that is created.
CommandBuilderwithDescription(String newDescription)
Specifies the description for the next Command that is created.
CommandBuilderwithId(int newId)
Specifies the id for the next Command that is created.
CommandBuilderwithName(String name)
Specifies the name for the next Command that is created.
CommandBuilderwithRequired(boolean newRequired)
Specifies whether the next Command created is required or not.

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.

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.

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.

withDescription

public CommandBuilder withDescription(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.

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.

withName

public CommandBuilder withName(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.

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.