Package org.refcodes.console

Class ConsoleSugar

java.lang.Object

org.refcodes.console.ConsoleSugar

public class ConsoleSugar
extends java.lang.Object

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

Constructor Summary

Constructors

Constructor	Description
ConsoleSugar()

Method Summary

Modifier and Type	Method	Description
static Condition	and(Syntaxable... aArgs)	And.
static Flag	debugFlag()	Debug flag.
static <T extends java.lang.Enum<T>> EnumOption<T>	enumOption(java.lang.String aLongOption, java.lang.Class<T> aType, java.lang.String aAlias, java.lang.String aDescription)	Enum option.
static <T extends java.lang.Enum<T>> EnumOption<T>	enumOption(java.lang.String aShortOption, java.lang.String aLongOption, java.lang.Class<T> aType, java.lang.String aAlias, java.lang.String aDescription)	Enum option.
static FileOption	fileOption(java.lang.String aLongOption, java.lang.String aAlias, java.lang.String aDescription)	Creates a FileOption for getting a File instance from a path.
static FileOption	fileOption(java.lang.String aShortOption, java.lang.String aLongOption, java.lang.String aAlias, java.lang.String aDescription)	String option.
static Flag	flag(java.lang.String aLongOption, java.lang.String aAlias, java.lang.String aDescription)	As "flag" is a reserved word in Java, we use "flag" :-(.
static Flag	flag(java.lang.String aShortOption, java.lang.String aLongOption, java.lang.String aAlias, java.lang.String aDescription)	As "flag" is a reserved word in Java, we use "flag" :-(.
static Flag	forcesFlag()	Forces flag.
static Flag	forcesFlag(java.lang.String aDescription)	Forces flag.
static Flag	helpFlag()	Help flag.
static Flag	helpFlag(java.lang.String aDescription)	Help flag.
static IntegerOption	intOption(java.lang.String aLongOption, java.lang.String aAlias, java.lang.String aDescription)	Int option.
static IntegerOption	intOption(java.lang.String aShortOption, java.lang.String aLongOption, java.lang.String aAlias, java.lang.String aDescription)	Int option.
static LongOption	longOption(java.lang.String aLongOption, java.lang.String aAlias, java.lang.String aDescription)	Long option.
static LongOption	longOption(java.lang.String aShortOption, java.lang.String aLongOption, java.lang.String aAlias, java.lang.String aDescription)	Long option.
static Condition	optional(Syntaxable... aArg)	Optional.
static Condition	or(Syntaxable... aArgs)	Or.
static Flag	quietFlag()	Quiet flag.
static Flag	quietFlag(java.lang.String aDescription)	Quiet flag.
static StringOperand	stringOperand(java.lang.String aIdentifier, java.lang.String aDescription)	String operand.
static StringOption	stringOption(java.lang.String aLongOption, java.lang.String aAlias, java.lang.String aDescription)	String option.
static StringOption	stringOption(java.lang.String aShortOption, java.lang.String aLongOption, java.lang.String aAlias, java.lang.String aDescription)	String option.
static Flag	sysInfoFlag()	Sys info flag.
static Flag	sysInfoFlag(java.lang.String aDescription)	Sys info flag.
static Flag	verboseDebug(java.lang.String aDescription)	Debug flag.
static Flag	verboseFlag()	Verbose flag.
static Flag	verboseFlag(java.lang.String aDescription)	Verbose flag.
static Condition	xor(Syntaxable... aArgs)	Xor.

Methods inherited from class java.lang.Object

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

Constructor Detail

ConsoleSugar

public ConsoleSugar()

Method Detail

and

public static Condition and(Syntaxable... aArgs)

And.

Parameters:

aArgs - the args

Returns:

the condition

See Also:

AndCondition

or

public static Condition or(Syntaxable... aArgs)

Or.

Parameters:

aArgs - the args

Returns:

the condition

See Also:

OrCondition

xor

public static Condition xor(Syntaxable... aArgs)

Xor.

Parameters:

aArgs - the args

Returns:

the condition

See Also:

XorCondition

optional

public static Condition optional(Syntaxable... aArg)

Optional.

Parameters:

aArg - the arg

Returns:

the condition

See Also:

OptionalCondition

enumOption

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

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

Returns:

the option

See Also:

EnumOption

enumOption

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

Enum option.

Type Parameters:

T - the generic type

Parameters:

aLongOption - the long option

aType - the type

aAlias - the option arg name

aDescription - the description

Returns:

the option

See Also:

EnumOption

flag

public static Flag flag(java.lang.String aLongOption,
                        java.lang.String aAlias,
                        java.lang.String aDescription)

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

Parameters:

aLongOption - the long option

aAlias - The alias of the flag

aDescription - the description

Returns:

the flag

See Also:

Flag

flag

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

As "flag" 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

Returns:

the flag

See Also:

Flag

forcesFlag

public static Flag forcesFlag(java.lang.String aDescription)

Forces flag.

Parameters:

aDescription - the description

Returns:

the flag

See Also:

ForceFlag

forcesFlag

public static Flag forcesFlag()

Forces flag.

Returns:

the flag

See Also:

ForceFlag

helpFlag

public static Flag helpFlag(java.lang.String aDescription)

Help flag.

Parameters:

aDescription - the description

Returns:

the flag

See Also:

HelpFlag

helpFlag

public static Flag helpFlag()

Help flag.

Returns:

the flag

See Also:

HelpFlag

sysInfoFlag

public static Flag sysInfoFlag(java.lang.String aDescription)

Sys info flag.

Parameters:

aDescription - the description

Returns:

the flag

See Also:

SysInfoFlag

sysInfoFlag

public static Flag sysInfoFlag()

Sys info flag.

Returns:

the flag

See Also:

SysInfoFlag

quietFlag

public static Flag quietFlag(java.lang.String aDescription)

Quiet flag.

Parameters:

aDescription - the description

Returns:

the flag

See Also:

QuietFlag

quietFlag

public static Flag quietFlag()

Quiet flag.

Returns:

the flag

See Also:

QuietFlag

verboseFlag

public static Flag verboseFlag(java.lang.String aDescription)

Verbose flag.

Parameters:

aDescription - the description

Returns:

the flag

See Also:

VerboseFlag

verboseFlag

public static Flag verboseFlag()

Verbose flag.

Returns:

the flag

See Also:

VerboseFlag

verboseDebug

public static Flag verboseDebug(java.lang.String aDescription)

Debug flag.

Parameters:

aDescription - the description

Returns:

the flag

See Also:

DebugFlag

debugFlag

public static Flag debugFlag()

Debug flag.

Returns:

the flag

See Also:

VerboseFlag

intOption

public static IntegerOption intOption(java.lang.String aLongOption,
                                      java.lang.String aAlias,
                                      java.lang.String aDescription)

Int option.

Parameters:

aLongOption - the long option

aAlias - the option arg name

aDescription - the description

Returns:

the option

See Also:

IntegerOption

intOption

public static IntegerOption intOption(java.lang.String aShortOption,
                                      java.lang.String aLongOption,
                                      java.lang.String aAlias,
                                      java.lang.String aDescription)

Int option.

Parameters:

aShortOption - the short option

aLongOption - the long option

aAlias - the option arg name

aDescription - the description

Returns:

the option

See Also:

IntegerOption

longOption

public static LongOption longOption(java.lang.String aLongOption,
                                    java.lang.String aAlias,
                                    java.lang.String aDescription)

Long option.

Parameters:

aLongOption - the long option

aAlias - the option arg name

aDescription - the description

Returns:

the option

See Also:

LongOption

longOption

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

Long option.

Parameters:

aShortOption - the short option

aLongOption - the long option

aAlias - the option arg name

aDescription - the description

Returns:

the option

See Also:

LongOption

stringOption

public static StringOption stringOption(java.lang.String aLongOption,
                                        java.lang.String aAlias,
                                        java.lang.String aDescription)

String option.

Parameters:

aLongOption - the long option

aAlias - the option arg name

aDescription - the description

Returns:

the option

See Also:

StringOption

stringOption

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

String option.

Parameters:

aShortOption - the short option

aLongOption - the long option

aAlias - the option arg name

aDescription - the description

Returns:

the option

See Also:

StringOption

fileOption

public static FileOption fileOption(java.lang.String aLongOption,
                                    java.lang.String aAlias,
                                    java.lang.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

Returns:

the option

See Also:

FileOption

fileOption

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

String option.

Parameters:

aShortOption - the short option

aLongOption - the long option

aAlias - the option arg name

aDescription - the description

Returns:

the option

See Also:

FileOption

stringOperand

public static StringOperand stringOperand(java.lang.String aIdentifier,
                                          java.lang.String aDescription)

String operand.

Parameters:

aIdentifier - the identifier

aDescription - the description

Returns:

the operand

See Also:

StringOperand