Module org.refcodes.cli

Package org.refcodes.cli

Class CliSugar

java.lang.Object

org.refcodes.cli.CliSugar

public class CliSugar
extends Object

Declarative syntactic sugar which may be statically imported in order to allow declarative definitions for the command line Flag, ArgsSyntax, Option and Operand elements.

Constructor Summary

Constructors

Constructor	Description
CliSugar()

Method Summary

Modifier and Type	Method	Description
static ArgsSyntax	all(Syntaxable aArg)	Instantiates a new AllCondition with the Syntaxable (ArgsSyntax) instance to be nested.
static ArgsSyntax	and(Syntaxable... aArgs)	Instantiates a new AndCondition with the Syntaxable (ArgsSyntax) instances to be nested.
static ArgsSyntax	any(Syntaxable... aArgs)	Instantiates a new AnyCondition with the Syntaxable (ArgsSyntax) instances to be nested.
static <T> ArrayOperand<T>	asArray(Operand<T> aOperand)	Creates an array representation facade for the encapsulated Operand.
static <T> ArrayOperand<T>	asArray(Operand<T> aOperand, int aLength)	Creates an array representation facade for the encapsulated Operand.
static <T> ArrayOperand<T>	asArray(Operand<T> aOperand, int aMinLength, int aMaxLength)	Creates an array representation facade for the encapsulated Operand.
static <T> ArrayOption<T>	asArray(Option<T> aOption)	Creates an array representation facade for the encapsulated Option.
static <T> ArrayOption<T>	asArray(Option<T> aOption, int aLength)	Creates an array representation facade for the encapsulated Option.
static <T> ArrayOption<T>	asArray(Option<T> aOption, int aMinLength, int aMaxLength)	Creates an array representation facade for the encapsulated Option.
static ArgsSyntax	cases(Syntaxable... aArgs)	Instantiates a new CasesCondition with the Syntaxable (ArgsSyntax) instances to be nested.
static CharOption	charOption(String aLongOption, String aAlias, String aDescription)	Character option.
static CharOption	charOption(String aShortOption, String aLongOption, String aAlias, String aDescription)	Character option.
static CleanFlag	cleanFlag()	Constructs the predefined clean Flag.
static CleanFlag	cleanFlag(boolean hasShortOption)	Constructs the predefined clean Flag.
static CleanFlag	cleanFlag(String aDescription)	Constructs the predefined clean Flag.
static ConfigOption	configOption()	Creates a ConfigOption representing value specifying a configuration resource (file).
static ConfigOption	configOption(String aDescription)	Creates a ConfigOption representing a value specifying a configuration resource (file).
static DaemonFlag	daemonFlag()	Constructs the predefined daemon Flag.
static DaemonFlag	daemonFlag(boolean hasShortOption)	Constructs the predefined daemon Flag.
static DaemonFlag	daemonFlag(String aDescription)	Constructs the predefined daemon Flag.
static DebugFlag	debugFlag()	Constructs the predefined debug Flag.
static DebugFlag	debugFlag(boolean hasShortOption)	Constructs the predefined debug Flag.
static DebugFlag	debugFlag(String aDescription)	Constructs the predefined debug Flag.
static DoubleOption	doubleOption(String aLongOption, String aAlias, String aDescription)	Double option.
static DoubleOption	doubleOption(String aShortOption, String aLongOption, String aAlias, String aDescription)	Double option.
static <T extends Enum<T>> EnumOption<T>	enumOption(String aLongOption, Class<T> aType, String aAlias, String aDescription)	Instantiates a new enum option.
static <T extends Enum<T>> EnumOption<T>	enumOption(String aShortOption, String aLongOption, Class<T> aType, String aAlias, String aDescription)	Instantiates a new enum option.
static Example	example(String aDescription, Operand<?>... aOperands)	Sugar for creating an Example from a description and the according Operand elements.
static Example[]	examples(Example... aExamples)	Sugar for creating an Example array from a varargs argument.
static FileOption	fileOption(String aLongOption, String aAlias, String aDescription)	Creates a FileOption for getting a File instance from a path.
static FileOption	fileOption(String aShortOption, String aLongOption, String aAlias, String aDescription)	Creates a FileOption for getting a File instance from a path.
static Flag	flag(String aLongOption, String aAlias, String aDescription)	As "switch" is a reserved word in Java, we use "flag" :-(.
static Flag	flag(String aShortOption, String aLongOption, String aAlias, String aDescription)	As "switch" is a reserved word in Java, we use "flag" :-(.
static FloatOption	floatOption(String aLongOption, String aAlias, String aDescription)	Float option.
static FloatOption	floatOption(String aShortOption, String aLongOption, String aAlias, String aDescription)	Float option.
static ForceFlag	forceFlag()	Constructs the predefined force Flag.
static ForceFlag	forceFlag(boolean hasShortOption)	Constructs the predefined force Flag.
static ForceFlag	forceFlag(String aDescription)	Constructs the predefined force Flag.
static HelpFlag	helpFlag()	Constructs the predefined help Flag.
static HelpFlag	helpFlag(boolean hasShortOption)	Constructs the predefined help Flag.
static HelpFlag	helpFlag(String aDescription)	Constructs the predefined help Flag.
static InitFlag	initFlag()	Constructs the predefined init Flag.
static InitFlag	initFlag(boolean hasShortOption)	Constructs the predefined init Flag.
static InitFlag	initFlag(String aDescription)	Constructs the predefined init Flag.
static IntOption	intOption(String aLongOption, String aAlias, String aDescription)	Int option.
static IntOption	intOption(String aShortOption, String aLongOption, String aAlias, String aDescription)	Int option.
static LongOption	longOption(String aLongOption, String aAlias, String aDescription)	Long option.
static LongOption	longOption(String aShortOption, String aLongOption, String aAlias, String aDescription)	Long option.
static NoneOperand	none(String aDescription)	Instantiates a new NoneOperand.
static NoneOperand	none(String aAlias, String aDescription)	Instantiates a new NoneOperand.
static NoneOperand	none(org.refcodes.struct.Relation<String,Boolean> aProperty)	Instantiates a new NoneOperand.
static Operation	operation(String aOperation, String aDescription)	Constructs a Operation with the given arguments.
static Operation	operation(String aOperation, String aAlias, String aDescription)	Constructs a Operation with the given arguments.
static ArgsSyntax	optional(Syntaxable... aArgs)	Semantically identical synonym for the optional(Syntaxable...) declaration.
static ArgsSyntax	or(Syntaxable... aArgs)	Instantiates a new OrCondition with the Syntaxable (ArgsSyntax) instances to be nested.
static QuietFlag	quietFlag()	Constructs the predefined quiet Flag.
static QuietFlag	quietFlag(boolean hasShortOption)	Constructs the predefined quiet Flag.
static QuietFlag	quietFlag(String aDescription)	Constructs the predefined quiet Flag.
static StringOperand	stringOperand(String aIdentifier, String aDescription)	String operand.
static StringOption	stringOption(String aLongOption, String aAlias, String aDescription)	String option.
static StringOption	stringOption(String aShortOption, String aLongOption, String aAlias, String aDescription)	String option.
static SysInfoFlag	sysInfoFlag()	Constructs the predefined system info Flag.
static SysInfoFlag	sysInfoFlag(boolean hasShortOption)	Constructs the predefined system info Flag.
static SysInfoFlag	sysInfoFlag(String aDescription)	Constructs the predefined system info Flag.
static VerboseFlag	verboseFlag()	Constructs the predefined verbose Flag.
static VerboseFlag	verboseFlag(boolean hasShortOption)	Constructs the predefined verbose Flag.
static VerboseFlag	verboseFlag(String aDescription)	Constructs the predefined verbose Flag.
static ArgsSyntax	xor(Syntaxable... aArgs)	Instantiates a new XorCondition with the Syntaxable (ArgsSyntax) instances to be nested.

Methods inherited from class java.lang.Object

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

Constructor Detail

CliSugar

public CliSugar()

Method Detail

examples

public static Example[] examples(Example... aExamples)

Sugar for creating an Example array from a varargs argument.

Parameters:

aExamples - the Example varargs argument.

Returns:

The according array representation.

example

public static Example example(String aDescription,
                              Operand<?>... aOperands)

Sugar for creating an Example from a description and the according Operand elements.

Parameters:

aDescription - The explanatory text of the example.

aOperands - The operands required for the Example.

Returns:

The according Example instance.

operation

public static Operation operation(String aOperation,
                                  String aDescription)

Constructs a Operation with the given arguments.

Parameters:

aOperation - The operation to declare.

aDescription - A description without any line breaks.

Returns:

The accordingly created Operation.

operation

public static Operation operation(String aOperation,
                                  String aAlias,
                                  String aDescription)

Constructs a Operation with the given arguments.

Parameters:

aOperation - The operation to declare.

aAlias - The operation's name to be used when constructing the syntax.

aDescription - A description without any line breaks.

Returns:

The accordingly created Operation.

and

public static ArgsSyntax and(Syntaxable... aArgs)

Instantiates a new AndCondition with the Syntaxable (ArgsSyntax) instances to be nested.

Parameters:

aArgs - The Syntaxable (ArgsSyntax) instances to be nested.

Returns:

The according AND condition.

See Also:

AndCondition

all

public static ArgsSyntax all(Syntaxable aArg)

Instantiates a new AllCondition with the Syntaxable (ArgsSyntax) instance to be nested.

Parameters:

aArg - The Syntaxable (ArgsSyntax) instance to be nested.

Returns:

The according ALL condition.

See Also:

AllCondition

or

public static ArgsSyntax or(Syntaxable... aArgs)

Instantiates a new OrCondition with the Syntaxable (ArgsSyntax) instances to be nested.

Parameters:

aArgs - The Syntaxable (ArgsSyntax) instances to be nested.

Returns:

The according OR condition.

See Also:

OrCondition

xor

public static ArgsSyntax xor(Syntaxable... aArgs)

Instantiates a new XorCondition with the Syntaxable (ArgsSyntax) instances to be nested.

Parameters:

aArgs - The Syntaxable (ArgsSyntax) instances to be nested.

Returns:

The according XOR condition.

See Also:

XorCondition

cases

public static ArgsSyntax cases(Syntaxable... aArgs)

Instantiates a new CasesCondition with the Syntaxable (ArgsSyntax) instances to be nested.

Parameters:

aArgs - The Syntaxable (ArgsSyntax) instances to be nested.

Returns:

The according CasesCondition (special XOR) condition.

See Also:

CasesCondition

any

public static ArgsSyntax any(Syntaxable... aArgs)

Instantiates a new AnyCondition with the Syntaxable (ArgsSyntax) instances to be nested. Any of the nested ArgsSyntax conditions may match for the AnyCondition to match, e.g. all of the nested conditions are optional.

Parameters:

aArgs - The Syntaxable (ArgsSyntax) instances to be nested

Returns:

The according AbstractCondition.

See Also:

AnyCondition

optional

public static ArgsSyntax optional(Syntaxable... aArgs)

Semantically identical synonym for the optional(Syntaxable...) declaration.

Parameters:

aArgs - The Syntaxable (ArgsSyntax) instances to be nested

Returns:

The according AbstractCondition.

See Also:

AnyCondition

none

public static NoneOperand none(String aAlias,
                               String aDescription)

Instantiates a new NoneOperand.

Parameters:

aAlias - The identifier to be used when printing the syntax via the Syntaxable.toSyntax(SyntaxNotation, String, String, String) method.

aDescription - A description without any line breaks.

Returns:

the none operand

See Also:

NoneOperand

none

public static NoneOperand none(String aDescription)

Instantiates a new NoneOperand.

Parameters:

aDescription - A description without any line breaks.

Returns:

the none operand

See Also:

NoneOperand

none

public static NoneOperand none(org.refcodes.struct.Relation<String,Boolean> aProperty)

Instantiates a new NoneOperand.

Parameters:

aProperty - The key (= alias) and the value for the operand.

Returns:

the none operand

See Also:

NoneOperand

enumOption

public static <T extends Enum<T>> EnumOption<T> enumOption(String aShortOption,
                                                           String aLongOption,
                                                           Class<T> aType,
                                                           String aAlias,
                                                           String aDescription)

Instantiates a new enum option.

Type Parameters:

T - the generic type

Parameters:

aShortOption - the short option

aLongOption - the long option

aType - the type

aAlias - the option arg name

aDescription - The description to use when printing out the help text.

Returns:

the option

See Also:

EnumOption

enumOption

public static <T extends Enum<T>> EnumOption<T> enumOption(String aLongOption,
                                                           Class<T> aType,
                                                           String aAlias,
                                                           String aDescription)

Instantiates a new enum option.

Type Parameters:

T - the generic type

Parameters:

aLongOption - the long option

aType - the type

aAlias - the option arg name

aDescription - The description to use when printing out the help text.

Returns:

the option

See Also:

EnumOption

flag

public static Flag flag(String aLongOption,
                        String aAlias,
                        String aDescription)

As "switch" is a reserved word in Java, we use "flag" :-(.

Parameters:

aLongOption - the long option

aAlias - The alias of the flag

aDescription - The description to use when printing out the help text.

Returns:

The according Flag.

See Also:

Flag

flag

public static Flag flag(String aShortOption,
                        String aLongOption,
                        String aAlias,
                        String aDescription)

As "switch" is a reserved word in Java, we use "flag" :-(.

Parameters:

aShortOption - the short option

aLongOption - the long option

aAlias - The alias of the flag

aDescription - The description to use when printing out the help text.

Returns:

The according Flag.

See Also:

Flag

daemonFlag

public static DaemonFlag daemonFlag(String aDescription)

Constructs the predefined daemon Flag.

Parameters:

aDescription - The description to use when printing out the help text.

Returns:

The according Flag.

See Also:

DaemonFlag

daemonFlag

public static DaemonFlag daemonFlag()

Constructs the predefined daemon Flag.

Returns:

The according Flag.

See Also:

DaemonFlag

daemonFlag

public static DaemonFlag daemonFlag(boolean hasShortOption)

Constructs the predefined daemon Flag.

Parameters:

hasShortOption - True in case to also enable the short option, else only the long option takes effect.

Returns:

The according Flag.

See Also:

DaemonFlag

forceFlag

public static ForceFlag forceFlag(String aDescription)

Constructs the predefined force Flag.

Parameters:

aDescription - The description to use when printing out the help text.

Returns:

The according Flag.

See Also:

ForceFlag

forceFlag

public static ForceFlag forceFlag()

Constructs the predefined force Flag.

Returns:

The according Flag.

See Also:

ForceFlag

forceFlag

public static ForceFlag forceFlag(boolean hasShortOption)

Constructs the predefined force Flag.

Parameters:

hasShortOption - True in case to also enable the short option, else only the long option takes effect.

Returns:

The according Flag.

See Also:

ForceFlag

helpFlag

public static HelpFlag helpFlag(String aDescription)

Constructs the predefined help Flag.

Parameters:

aDescription - The description to use when printing out the help text.

Returns:

The according Flag.

See Also:

HelpFlag

helpFlag

public static HelpFlag helpFlag()

Constructs the predefined help Flag.

Returns:

The according Flag.

See Also:

HelpFlag

helpFlag

public static HelpFlag helpFlag(boolean hasShortOption)

Constructs the predefined help Flag.

Parameters:

hasShortOption - True in case to also enable the short option, else only the long option takes effect.

Returns:

The according Flag.

See Also:

HelpFlag

initFlag

public static InitFlag initFlag(String aDescription)

Constructs the predefined init Flag.

Parameters:

aDescription - The description to use when printing out the help text.

Returns:

The according Flag.

See Also:

InitFlag

initFlag

public static InitFlag initFlag()

Constructs the predefined init Flag.

Returns:

The according Flag.

See Also:

InitFlag

initFlag

public static InitFlag initFlag(boolean hasShortOption)

Constructs the predefined init Flag.

Parameters:

hasShortOption - True in case to also enable the short option, else only the long option takes effect.

Returns:

The according Flag.

See Also:

InitFlag

cleanFlag

public static CleanFlag cleanFlag(String aDescription)

Constructs the predefined clean Flag.

Parameters:

aDescription - The description to use when printing out the help text.

Returns:

The according Flag.

See Also:

CleanFlag

cleanFlag

public static CleanFlag cleanFlag()

Constructs the predefined clean Flag.

Returns:

The according Flag.

See Also:

CleanFlag

cleanFlag

public static CleanFlag cleanFlag(boolean hasShortOption)

Constructs the predefined clean Flag.

Parameters:

hasShortOption - True in case to also enable the short option, else only the long option takes effect.

Returns:

The according Flag.

See Also:

CleanFlag

sysInfoFlag

public static SysInfoFlag sysInfoFlag(String aDescription)

Constructs the predefined system info Flag.

Parameters:

aDescription - The description to use when printing out the help text.

Returns:

The according Flag.

See Also:

SysInfoFlag

sysInfoFlag

public static SysInfoFlag sysInfoFlag()

Constructs the predefined system info Flag.

Returns:

The according Flag.

See Also:

SysInfoFlag

sysInfoFlag

public static SysInfoFlag sysInfoFlag(boolean hasShortOption)

Constructs the predefined system info Flag.

Parameters:

hasShortOption - True in case to also enable the short option, else only the long option takes effect.

Returns:

The according Flag.

See Also:

SysInfoFlag

quietFlag

public static QuietFlag quietFlag(String aDescription)

Constructs the predefined quiet Flag.

Parameters:

aDescription - The description to use when printing out the help text.

Returns:

The according Flag.

See Also:

QuietFlag

quietFlag

public static QuietFlag quietFlag()

Constructs the predefined quiet Flag.

Returns:

The according Flag.

See Also:

QuietFlag

quietFlag

public static QuietFlag quietFlag(boolean hasShortOption)

Constructs the predefined quiet Flag.

Parameters:

hasShortOption - True in case to also enable the short option, else only the long option takes effect.

Returns:

The according Flag.

See Also:

QuietFlag

verboseFlag

public static VerboseFlag verboseFlag(String aDescription)

Constructs the predefined verbose Flag.

Parameters:

aDescription - The description to use when printing out the help text.

Returns:

The according Flag.

See Also:

VerboseFlag

verboseFlag

public static VerboseFlag verboseFlag()

Constructs the predefined verbose Flag.

Returns:

The according Flag.

See Also:

VerboseFlag

verboseFlag

public static VerboseFlag verboseFlag(boolean hasShortOption)

Constructs the predefined verbose Flag.

Parameters:

hasShortOption - True in case to also enable the short option, else only the long option takes effect.

Returns:

The according Flag.

See Also:

VerboseFlag

debugFlag

public static DebugFlag debugFlag(String aDescription)

Constructs the predefined debug Flag.

Parameters:

aDescription - The description to use when printing out the help text.

Returns:

The according Flag.

See Also:

DebugFlag

debugFlag

public static DebugFlag debugFlag()

Constructs the predefined debug Flag.

Returns:

The according Flag.

See Also:

DebugFlag

debugFlag

public static DebugFlag debugFlag(boolean hasShortOption)

Constructs the predefined debug Flag.

Parameters:

hasShortOption - True in case to also enable the short option, else only the long option takes effect.

Returns:

The according Flag.

See Also:

DebugFlag

intOption

public static IntOption intOption(String aLongOption,
                                  String aAlias,
                                  String aDescription)

Int option.

Parameters:

aLongOption - the long option

aAlias - the option arg name

aDescription - The description to use when printing out the help text.

Returns:

the option

See Also:

IntOption

intOption

public static IntOption intOption(String aShortOption,
                                  String aLongOption,
                                  String aAlias,
                                  String aDescription)

Int option.

Parameters:

aShortOption - the short option

aLongOption - the long option

aAlias - the option arg name

aDescription - The description to use when printing out the help text.

Returns:

the option

See Also:

IntOption

longOption

public static LongOption longOption(String aLongOption,
                                    String aAlias,
                                    String aDescription)

Long option.

Parameters:

aLongOption - the long option

aAlias - the option arg name

aDescription - The description to use when printing out the help text.

Returns:

the option

See Also:

LongOption

longOption

public static LongOption longOption(String aShortOption,
                                    String aLongOption,
                                    String aAlias,
                                    String aDescription)

Long option.

Parameters:

aShortOption - the short option

aLongOption - the long option

aAlias - the option arg name

aDescription - The description to use when printing out the help text.

Returns:

the option

See Also:

LongOption

floatOption

public static FloatOption floatOption(String aLongOption,
                                      String aAlias,
                                      String aDescription)

Float option.

Parameters:

aLongOption - the long option

aAlias - the option arg name

aDescription - The description to use when printing out the help text.

Returns:

the option

See Also:

LongOption

floatOption

public static FloatOption floatOption(String aShortOption,
                                      String aLongOption,
                                      String aAlias,
                                      String aDescription)

Float option.

Parameters:

aShortOption - the short option

aLongOption - the long option

aAlias - the option arg name

aDescription - The description to use when printing out the help text.

Returns:

the option

See Also:

LongOption

doubleOption

public static DoubleOption doubleOption(String aLongOption,
                                        String aAlias,
                                        String aDescription)

Double option.

Parameters:

aLongOption - the long option

aAlias - the option arg name

aDescription - The description to use when printing out the help text.

Returns:

the option

See Also:

LongOption

doubleOption

public static DoubleOption doubleOption(String aShortOption,
                                        String aLongOption,
                                        String aAlias,
                                        String aDescription)

Double option.

Parameters:

aShortOption - the short option

aLongOption - the long option

aAlias - the option arg name

aDescription - The description to use when printing out the help text.

Returns:

the option

See Also:

LongOption

stringOption

public static StringOption stringOption(String aLongOption,
                                        String aAlias,
                                        String aDescription)

String option.

Parameters:

aLongOption - the long option

aAlias - the option arg name

aDescription - The description to use when printing out the help text.

Returns:

the option

See Also:

StringOption

stringOption

public static StringOption stringOption(String aShortOption,
                                        String aLongOption,
                                        String aAlias,
                                        String aDescription)

String option.

Parameters:

aShortOption - the short option

aLongOption - the long option

aAlias - the option arg name

aDescription - The description to use when printing out the help text.

Returns:

the option

See Also:

StringOption

charOption

public static CharOption charOption(String aLongOption,
                                    String aAlias,
                                    String aDescription)

Character option.

Parameters:

aLongOption - the long option

aAlias - the option arg name

aDescription - The description to use when printing out the help text.

Returns:

the option

See Also:

StringOption

charOption

public static CharOption charOption(String aShortOption,
                                    String aLongOption,
                                    String aAlias,
                                    String aDescription)

Character option.

Parameters:

aShortOption - the short option

aLongOption - the long option

aAlias - the option arg name

aDescription - The description to use when printing out the help text.

Returns:

the option

See Also:

StringOption

configOption

public static ConfigOption configOption()

Creates a ConfigOption representing value specifying a configuration resource (file).

Returns:

the according ConfigOption.

See Also:

ConfigOption

configOption

public static ConfigOption configOption(String aDescription)

Creates a ConfigOption representing a value specifying a configuration resource (file).

Parameters:

aDescription - The description to use when printing out the help text. to use when printing out the help text.

Returns:

the according ConfigOption.

See Also:

ConfigOption

fileOption

public static FileOption fileOption(String aLongOption,
                                    String aAlias,
                                    String aDescription)

Creates a FileOption for getting a File instance from a path.

Parameters:

aLongOption - the long option

aAlias - the option arg name

aDescription - The description to use when printing out the help text.

Returns:

the option

See Also:

FileOption

fileOption

public static FileOption fileOption(String aShortOption,
                                    String aLongOption,
                                    String aAlias,
                                    String aDescription)

Creates a FileOption for getting a File instance from a path.

Parameters:

aShortOption - the short option

aLongOption - the long option

aAlias - the option arg name

aDescription - The description to use when printing out the help text.

Returns:

the option

See Also:

FileOption

stringOperand

public static StringOperand stringOperand(String aIdentifier,
                                          String aDescription)

String operand.

Parameters:

aIdentifier - the identifier

aDescription - The description to use when printing out the help text.

Returns:

the operand

See Also:

StringOperand

asArray

public static <T> ArrayOption<T> asArray(Option<T> aOption)

Creates an array representation facade for the encapsulated Option. This way any Option can also be used as an array Option, e.g. it can be provided multiple times in the command line arguments.

Type Parameters:

T - The type of the Option for which to create an ArrayOption.

Parameters:

aOption - The Option which's array counterpart is to be defined.

Returns:

The according ArrayOption.

asArray

public static <T> ArrayOption<T> asArray(Option<T> aOption,
                                         int aLength)

Creates an array representation facade for the encapsulated Option. This way any Option can also be used as an array Option, e.g. it can by provided multiple times in the command line arguments.

Type Parameters:

T - The type of the Option for which to create an ArrayOption.

Parameters:

aOption - The Option which's array counterpart is to be defined.

aLength - The number of array elements, or -1 if there is no limit.

Returns:

The according ArrayOption.

asArray

public static <T> ArrayOption<T> asArray(Option<T> aOption,
                                         int aMinLength,
                                         int aMaxLength)

Creates an array representation facade for the encapsulated Option. This way any Option can also be used as an array Option, e.g. it can by provided multiple times in the command line arguments.

Type Parameters:

T - The type of the Option for which to create an ArrayOption.

Parameters:

aOption - The Option which's array counterpart is to be defined.

aMinLength - The minimum number of array elements, or -1 if there is no limit.

aMaxLength - The maximum number of array elements, or -1 if there is no limit.

Returns:

The according ArrayOption.

asArray

public static <T> ArrayOperand<T> asArray(Operand<T> aOperand)

Creates an array representation facade for the encapsulated Operand. This way any Operand can also be used as an array Operand, e.g. it can be provided multiple times in the command line arguments.

Type Parameters:

T - The type of the Operand for which to create an ArrayOperand.

Parameters:

aOperand - The Operand which's array counterpart is to be defined.

Returns:

The according ArrayOperand.

asArray

public static <T> ArrayOperand<T> asArray(Operand<T> aOperand,
                                          int aLength)

Creates an array representation facade for the encapsulated Operand. This way any Operand can also be used as an array Operand, e.g. it can by provided multiple times in the command line arguments.

Type Parameters:

T - The type of the Operand for which to create an ArrayOperand.

Parameters:

aOperand - The Operand which's array counterpart is to be defined.

aLength - The number of array elements, or -1 if there is no limit.

Returns:

The according ArrayOperand.

asArray

public static <T> ArrayOperand<T> asArray(Operand<T> aOperand,
                                          int aMinLength,
                                          int aMaxLength)

Creates an array representation facade for the encapsulated Operand. This way any Operand can also be used as an array Operand, e.g. it can by provided multiple times in the command line arguments.

Type Parameters:

T - The type of the Operand for which to create an ArrayOperand.

Parameters:

aOperand - The Operand which's array counterpart is to be defined.

aMinLength - The minimum number of array elements, or -1 if there is no limit.

aMaxLength - The maximum number of array elements, or -1 if there is no limit.

Returns:

The according ArrayOperand.