org.cyclopsgroup.jcli.spi

Class CommandLineBuilder

java.lang.Object

org.cyclopsgroup.jcli.spi.CommandLineBuilder

public final class CommandLineBuilder
extends Object

A builder class to create CommandLine

Author:

Jiaqi Guo

Constructor Summary

Constructors

Constructor and Description
CommandLineBuilder()

Method Summary

Modifier and Type	Method and Description
CommandLine	toCommandLine()
CommandLineBuilder	withArgument(String argument)
CommandLineBuilder	withArguments(Collection<String> arguments)
CommandLineBuilder	withLongFlag(String name) Add a flag option with its long name
CommandLineBuilder	withLongOption(String name, String value) Add an option with its long name
CommandLineBuilder	withShortFlag(String name) Add a flag option with its short name
CommandLineBuilder	withShortOption(String name, String value) Add an option with its short name

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CommandLineBuilder

public CommandLineBuilder()

Method Detail

toCommandLine

public CommandLine toCommandLine()

Returns:

The command line instance with information that has been added so far

withArgument

public CommandLineBuilder withArgument(String argument)

Parameters:

argument - Add an argument expression

Returns:

Builder itself

withArguments

public CommandLineBuilder withArguments(Collection<String> arguments)

Parameters:

arguments - Add a list of arguments

Returns:

Builder itself

withLongFlag

public CommandLineBuilder withLongFlag(String name)

Add a flag option with its long name

Parameters:

name - Long name of the flag option to add

Returns:

Builder itself

withLongOption

public CommandLineBuilder withLongOption(String name,
                                         String value)

Add an option with its long name

Parameters:

name - Long name of the option to add

value - Value of the option to add

Returns:

Builder itself

withShortFlag

public CommandLineBuilder withShortFlag(String name)

Add a flag option with its short name

Parameters:

name - Short name of option to add

Returns:

Builder itself

withShortOption

public CommandLineBuilder withShortOption(String name,
                                          String value)

Add an option with its short name

Parameters:

name - Short name of the option to add

value - Value of option to add

Returns:

Builder itself