Package org.refcodes.console
Class ConsoleSugar
- java.lang.Object
-
- org.refcodes.console.ConsoleSugar
-
public class ConsoleSugar extends Object
-
-
Constructor Summary
Constructors Constructor Description ConsoleSugar()
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static Condition
and(Syntaxable... aArgs)
And.static Flag
debugFlag()
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)
Enum option.static <T extends Enum<T>>
EnumOption<T>enumOption(String aShortOption, String aLongOption, Class<T> aType, String aAlias, String aDescription)
Enum option.static FileOption
fileOption(String aLongOption, String aAlias, String aDescription)
Creates aFileOption
for getting aFile
instance from a path.static FileOption
fileOption(String aShortOption, String aLongOption, String aAlias, String aDescription)
String option.static Flag
flag(String aLongOption, String aAlias, String aDescription)
As "flag" is a reserved word in Java, we use "flag" :-(.static Flag
flag(String aShortOption, String aLongOption, String aAlias, String aDescription)
As "flag" 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 Flag
forcesFlag()
Forces flag.static Flag
forcesFlag(String aDescription)
Forces flag.static Flag
helpFlag()
Help flag.static Flag
helpFlag(String aDescription)
Help flag.static IntegerOption
intOption(String aLongOption, String aAlias, String aDescription)
Int option.static IntegerOption
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 Condition
optional(Syntaxable... aArg)
Optional.static Condition
or(Syntaxable... aArgs)
Or.static Flag
quietFlag()
Quiet flag.static Flag
quietFlag(String aDescription)
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 Flag
sysInfoFlag()
Sys info flag.static Flag
sysInfoFlag(String aDescription)
Sys info flag.static Flag
verboseDebug(String aDescription)
Debug flag.static Flag
verboseFlag()
Verbose flag.static Flag
verboseFlag(String aDescription)
Verbose flag.static Condition
xor(Syntaxable... aArgs)
Xor.
-
-
-
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 Enum<T>> EnumOption<T> enumOption(String aShortOption, String aLongOption, Class<T> aType, String aAlias, String aDescription)
Enum option.- Type Parameters:
T
- the generic type- Parameters:
aShortOption
- the short optionaLongOption
- the long optionaType
- the typeaAlias
- the option arg nameaDescription
- the description- 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)
Enum option.- Type Parameters:
T
- the generic type- Parameters:
aLongOption
- the long optionaType
- the typeaAlias
- the option arg nameaDescription
- the description- Returns:
- the option
- See Also:
EnumOption
-
flag
public static Flag flag(String aLongOption, String aAlias, String aDescription)
As "flag" is a reserved word in Java, we use "flag" :-(.- Parameters:
aLongOption
- the long optionaAlias
- The alias of the flagaDescription
- the description- Returns:
- the flag
- See Also:
Flag
-
flag
public static Flag flag(String aShortOption, String aLongOption, String aAlias, String aDescription)
As "flag" is a reserved word in Java, we use "flag" :-(.- Parameters:
aShortOption
- the short optionaLongOption
- the long optionaAlias
- The alias of the flagaDescription
- the description- Returns:
- the flag
- See Also:
Flag
-
forcesFlag
public static Flag forcesFlag(String aDescription)
Forces flag.- Parameters:
aDescription
- the description- Returns:
- the flag
- See Also:
ForceFlag
-
helpFlag
public static Flag helpFlag(String aDescription)
Help flag.- Parameters:
aDescription
- the description- Returns:
- the flag
- See Also:
HelpFlag
-
sysInfoFlag
public static Flag sysInfoFlag(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(String aDescription)
Quiet flag.- Parameters:
aDescription
- the description- Returns:
- the flag
- See Also:
QuietFlag
-
verboseFlag
public static Flag verboseFlag(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(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(String aLongOption, String aAlias, String aDescription)
Int option.- Parameters:
aLongOption
- the long optionaAlias
- the option arg nameaDescription
- the description- Returns:
- the option
- See Also:
IntegerOption
-
intOption
public static IntegerOption intOption(String aShortOption, String aLongOption, String aAlias, String aDescription)
Int option.- Parameters:
aShortOption
- the short optionaLongOption
- the long optionaAlias
- the option arg nameaDescription
- the description- Returns:
- the option
- See Also:
IntegerOption
-
longOption
public static LongOption longOption(String aLongOption, String aAlias, String aDescription)
Long option.- Parameters:
aLongOption
- the long optionaAlias
- the option arg nameaDescription
- the description- 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 optionaLongOption
- the long optionaAlias
- the option arg nameaDescription
- the description- Returns:
- the option
- See Also:
LongOption
-
floatOption
public static FloatOption floatOption(String aLongOption, String aAlias, String aDescription)
Float option.- Parameters:
aLongOption
- the long optionaAlias
- the option arg nameaDescription
- the description- 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 optionaLongOption
- the long optionaAlias
- the option arg nameaDescription
- the description- Returns:
- the option
- See Also:
LongOption
-
doubleOption
public static DoubleOption doubleOption(String aLongOption, String aAlias, String aDescription)
Double option.- Parameters:
aLongOption
- the long optionaAlias
- the option arg nameaDescription
- the description- 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 optionaLongOption
- the long optionaAlias
- the option arg nameaDescription
- the description- Returns:
- the option
- See Also:
LongOption
-
stringOption
public static StringOption stringOption(String aLongOption, String aAlias, String aDescription)
String option.- Parameters:
aLongOption
- the long optionaAlias
- the option arg nameaDescription
- the description- 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 optionaLongOption
- the long optionaAlias
- the option arg nameaDescription
- the description- Returns:
- the option
- See Also:
StringOption
-
fileOption
public static FileOption fileOption(String aLongOption, String aAlias, String aDescription)
Creates aFileOption
for getting aFile
instance from a path.- Parameters:
aLongOption
- the long optionaAlias
- the option arg nameaDescription
- the description- Returns:
- the option
- See Also:
FileOption
-
fileOption
public static FileOption fileOption(String aShortOption, String aLongOption, String aAlias, String aDescription)
String option.- Parameters:
aShortOption
- the short optionaLongOption
- the long optionaAlias
- the option arg nameaDescription
- the description- Returns:
- the option
- See Also:
FileOption
-
stringOperand
public static StringOperand stringOperand(String aIdentifier, String aDescription)
String operand.- Parameters:
aIdentifier
- the identifieraDescription
- the description- Returns:
- the operand
- See Also:
StringOperand
-
-