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, Condition, Option and Operand elements.

Method Summary

Modifier and Type	Method	Description
static AllCondition	all(Term aArg)	Instantiates a new AllCondition with the Term (Condition) instance to be nested.
static AndCondition	and(Term... aArgs)	Instantiates a new AndCondition with the Term (Condition) instances to be nested.
static AnyCondition	any(Term... aArgs)	Instantiates a new AnyCondition with the Term (Condition) 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 BooleanOption	booleanOption(Character aShortOption, String aLongOption, String aDescription)	Instantiates a new BooleanOption with the given arguments.
static BooleanOption	booleanOption(Character aShortOption, String aLongOption, String aAlias, String aDescription)	Instantiates a new BooleanOption with the given arguments.
static BooleanOption	booleanOption(Character aShortOption, String aLongOption, String aAlias, String aDescription, Consumer<BooleanOption> aConsumer)	Instantiates a new BooleanOption with the given arguments.
static BooleanOption	booleanOption(Character aShortOption, String aLongOption, String aDescription, Consumer<BooleanOption> aConsumer)	Instantiates a new BooleanOption with the given arguments.
static BooleanOption	booleanOption(String aLongOption, String aDescription)	Instantiates a new BooleanOption with the given arguments.
static BooleanOption	booleanOption(String aLongOption, String aAlias, String aDescription)	Instantiates a new BooleanOption with the given arguments.
static BooleanOption	booleanOption(String aLongOption, String aAlias, String aDescription, Consumer<BooleanOption> aConsumer)	Instantiates a new BooleanOption with the given arguments.
static BooleanOption	booleanOption(String aLongOption, String aDescription, Consumer<BooleanOption> aConsumer)	Instantiates a new BooleanOption with the given arguments.
static BooleanProperty	booleanProperty(Character aShortOption, String aLongOption, String aDescription)	Instantiates a new BooleanProperty with the given arguments.
static BooleanProperty	booleanProperty(Character aShortOption, String aLongOption, String aAlias, String aDescription)	Instantiates a new BooleanProperty with the given arguments.
static BooleanProperty	booleanProperty(Character aShortOption, String aLongOption, String aAlias, String aDescription, Consumer<BooleanProperty> aConsumer)	Instantiates a new BooleanProperty with the given arguments.
static BooleanProperty	booleanProperty(Character aShortOption, String aLongOption, String aDescription, Consumer<BooleanProperty> aConsumer)	Instantiates a new BooleanProperty with the given arguments.
static BooleanProperty	booleanProperty(String aLongOption, String aDescription)	Instantiates a new BooleanProperty with the given arguments.
static BooleanProperty	booleanProperty(String aLongOption, String aAlias, String aDescription)	Instantiates a new BooleanProperty with the given arguments.
static BooleanProperty	booleanProperty(String aLongOption, String aAlias, String aDescription, Consumer<BooleanProperty> aConsumer)	Instantiates a new BooleanProperty with the given arguments.
static BooleanProperty	booleanProperty(String aLongOption, String aDescription, Consumer<BooleanProperty> aConsumer)	Instantiates a new BooleanProperty with the given arguments.
static CasesCondition	cases(Term... aArgs)	Instantiates a new CasesCondition with the Term (Condition) instances to be nested.
static CharOption	charOption(Character aShortOption, String aLongOption, String aDescription)	Instantiates a new CharOption with the given arguments.
static CharOption	charOption(Character aShortOption, String aLongOption, String aAlias, String aDescription)	Instantiates a new CharOption with the given arguments.
static CharOption	charOption(Character aShortOption, String aLongOption, String aAlias, String aDescription, Consumer<CharOption> aConsumer)	Instantiates a new CharOption with the given arguments.
static CharOption	charOption(Character aShortOption, String aLongOption, String aDescription, Consumer<CharOption> aConsumer)	Instantiates a new CharOption with the given arguments.
static CharOption	charOption(String aLongOption, String aDescription)	Instantiates a new CharOption with the given arguments.
static CharOption	charOption(String aLongOption, String aAlias, String aDescription)	Instantiates a new CharOption with the given arguments.
static CharOption	charOption(String aLongOption, String aAlias, String aDescription, Consumer<CharOption> aConsumer)	Instantiates a new CharOption with the given arguments.
static CharOption	charOption(String aLongOption, String aDescription, Consumer<CharOption> aConsumer)	Instantiates a new CharOption with the given arguments.
static CharProperty	charProperty(Character aShortOption, String aLongOption, String aDescription)	Instantiates a new CharProperty with the given arguments.
static CharProperty	charProperty(Character aShortOption, String aLongOption, String aAlias, String aDescription)	Instantiates a new CharProperty with the given arguments.
static CharProperty	charProperty(Character aShortOption, String aLongOption, String aAlias, String aDescription, Consumer<CharProperty> aConsumer)	Instantiates a new CharProperty with the given arguments.
static CharProperty	charProperty(Character aShortOption, String aLongOption, String aDescription, Consumer<CharProperty> aConsumer)	Instantiates a new CharProperty with the given arguments.
static CharProperty	charProperty(String aLongOption, String aDescription)	Instantiates a new CharProperty with the given arguments.
static CharProperty	charProperty(String aLongOption, String aAlias, String aDescription)	Instantiates a new CharProperty with the given arguments.
static CharProperty	charProperty(String aLongOption, String aAlias, String aDescription, Consumer<CharProperty> aConsumer)	Instantiates a new CharProperty with the given arguments.
static CharProperty	charProperty(String aLongOption, String aDescription, Consumer<CharProperty> aConsumer)	Instantiates a new CharProperty with the given arguments.
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)	Instantiates a new config (file) Option.
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(Character aShortOption, String aLongOption, String aDescription)	Instantiates a new DoubleOption with the given arguments.
static DoubleOption	doubleOption(Character aShortOption, String aLongOption, String aAlias, String aDescription)	Instantiates a new DoubleOption with the given arguments.
static DoubleOption	doubleOption(Character aShortOption, String aLongOption, String aAlias, String aDescription, Consumer<DoubleOption> aConsumer)	Instantiates a new DoubleOption with the given arguments.
static DoubleOption	doubleOption(Character aShortOption, String aLongOption, String aDescription, Consumer<DoubleOption> aConsumer)	Instantiates a new DoubleOption with the given arguments.
static DoubleOption	doubleOption(String aLongOption, String aDescription)	Instantiates a new DoubleOption with the given arguments.
static DoubleOption	doubleOption(String aLongOption, String aAlias, String aDescription)	Instantiates a new DoubleOption with the given arguments.
static DoubleOption	doubleOption(String aLongOption, String aAlias, String aDescription, Consumer<DoubleOption> aConsumer)	Instantiates a new DoubleOption with the given arguments.
static DoubleOption	doubleOption(String aLongOption, String aDescription, Consumer<DoubleOption> aConsumer)	Instantiates a new DoubleOption with the given arguments.
static DoubleProperty	doubleProperty(Character aShortOption, String aLongOption, String aDescription)	Instantiates a new DoubleProperty with the given arguments.
static DoubleProperty	doubleProperty(Character aShortOption, String aLongOption, String aAlias, String aDescription)	Instantiates a new DoubleProperty with the given arguments.
static DoubleProperty	doubleProperty(Character aShortOption, String aLongOption, String aAlias, String aDescription, Consumer<DoubleProperty> aConsumer)	Instantiates a new DoubleProperty with the given arguments.
static DoubleProperty	doubleProperty(Character aShortOption, String aLongOption, String aDescription, Consumer<DoubleProperty> aConsumer)	Instantiates a new DoubleProperty with the given arguments.
static DoubleProperty	doubleProperty(String aLongOption, String aDescription)	Instantiates a new DoubleProperty with the given arguments.
static DoubleProperty	doubleProperty(String aLongOption, String aAlias, String aDescription)	Instantiates a new DoubleProperty with the given arguments.
static DoubleProperty	doubleProperty(String aLongOption, String aAlias, String aDescription, Consumer<DoubleProperty> aConsumer)	Instantiates a new DoubleProperty with the given arguments.
static DoubleProperty	doubleProperty(String aLongOption, String aDescription, Consumer<DoubleProperty> aConsumer)	Instantiates a new DoubleProperty with the given arguments.
static <T extends Enum<T>> EnumOption<T>	enumOption(Character aShortOption, String aLongOption, Class<T> aType, String aDescription)	Instantiates a new EnumOption with the given arguments.
static <T extends Enum<T>> EnumOption<T>	enumOption(Character aShortOption, String aLongOption, Class<T> aType, String aAlias, String aDescription)	Instantiates a new EnumOption with the given arguments.
static <T extends Enum<T>> EnumOption<T>	enumOption(Character aShortOption, String aLongOption, Class<T> aType, String aAlias, String aDescription, Consumer<EnumOption<T>> aConsumer)	Instantiates a new EnumOption with the given arguments.
static <T extends Enum<T>> EnumOption<T>	enumOption(Character aShortOption, String aLongOption, Class<T> aType, String aDescription, Consumer<EnumOption<T>> aConsumer)	Instantiates a new EnumOption with the given arguments.
static <T extends Enum<T>> EnumOption<T>	enumOption(String aLongOption, Class<T> aType, String aDescription)	Instantiates a new EnumOption with the given arguments.
static <T extends Enum<T>> EnumOption<T>	enumOption(String aLongOption, Class<T> aType, String aAlias, String aDescription)	Instantiates a new EnumOption with the given arguments.
static <T extends Enum<T>> EnumOption<T>	enumOption(String aLongOption, Class<T> aType, String aAlias, String aDescription, Consumer<EnumOption<T>> aConsumer)	Instantiates a new EnumOption with the given arguments.
static <T extends Enum<T>> EnumOption<T>	enumOption(String aLongOption, Class<T> aType, String aDescription, Consumer<EnumOption<T>> aConsumer)	Instantiates a new EnumOption with the given arguments.
static <T extends Enum<T>> EnumProperty<T>	enumProperty(Character aShortOption, String aLongOption, Class<T> aType, String aDescription)	Instantiates a new EnumProperty with the given arguments.
static <T extends Enum<T>> EnumProperty<T>	enumProperty(Character aShortOption, String aLongOption, Class<T> aType, String aAlias, String aDescription)	Instantiates a new EnumProperty with the given arguments.
static <T extends Enum<T>> EnumProperty<T>	enumProperty(Character aShortOption, String aLongOption, Class<T> aType, String aAlias, String aDescription, Consumer<EnumProperty<T>> aConsumer)	Instantiates a new EnumProperty with the given arguments.
static <T extends Enum<T>> EnumProperty<T>	enumProperty(Character aShortOption, String aLongOption, Class<T> aType, String aDescription, Consumer<EnumProperty<T>> aConsumer)	Instantiates a new EnumProperty with the given arguments.
static <T extends Enum<T>> EnumProperty<T>	enumProperty(String aLongOption, Class<T> aType, String aDescription)	Instantiates a new EnumProperty with the given arguments.
static <T extends Enum<T>> EnumProperty<T>	enumProperty(String aLongOption, Class<T> aType, String aAlias, String aDescription)	Instantiates a new EnumProperty with the given arguments.
static <T extends Enum<T>> EnumProperty<T>	enumProperty(String aLongOption, Class<T> aType, String aAlias, String aDescription, Consumer<EnumProperty<T>> aConsumer)	Instantiates a new EnumProperty with the given arguments.
static <T extends Enum<T>> EnumProperty<T>	enumProperty(String aLongOption, Class<T> aType, String aDescription, Consumer<EnumProperty<T>> aConsumer)	Instantiates a new EnumProperty with the given arguments.
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(Character aShortOption, String aLongOption, String aDescription)	Instantiates a new FileOption with the given arguments.
static FileOption	fileOption(Character aShortOption, String aLongOption, String aAlias, String aDescription)	Instantiates a new FileOption with the given arguments.
static FileOption	fileOption(Character aShortOption, String aLongOption, String aAlias, String aDescription, Consumer<FileOption> aConsumer)	Instantiates a new FileOption with the given arguments.
static FileOption	fileOption(Character aShortOption, String aLongOption, String aDescription, Consumer<FileOption> aConsumer)	Instantiates a new FileOption with the given arguments.
static FileOption	fileOption(String aLongOption, String aDescription)	Instantiates a new FileOption with the given arguments.
static FileOption	fileOption(String aLongOption, String aAlias, String aDescription)	Instantiates a new FileOption with the given arguments.
static FileOption	fileOption(String aLongOption, String aAlias, String aDescription, Consumer<FileOption> aConsumer)	Instantiates a new FileOption with the given arguments.
static FileOption	fileOption(String aLongOption, String aDescription, Consumer<FileOption> aConsumer)	Instantiates a new FileOption with the given arguments.
static FileProperty	fileProperty(Character aShortOption, String aLongOption, String aDescription)	Instantiates a new FileProperty with the given arguments.
static FileProperty	fileProperty(Character aShortOption, String aLongOption, String aAlias, String aDescription)	Instantiates a new FileProperty with the given arguments.
static FileProperty	fileProperty(Character aShortOption, String aLongOption, String aAlias, String aDescription, Consumer<FileProperty> aConsumer)	Instantiates a new FileProperty with the given arguments.
static FileProperty	fileProperty(Character aShortOption, String aLongOption, String aDescription, Consumer<FileProperty> aConsumer)	Instantiates a new FileProperty with the given arguments.
static FileProperty	fileProperty(String aLongOption, String aDescription)	Instantiates a new FileProperty with the given arguments.
static FileProperty	fileProperty(String aLongOption, String aAlias, String aDescription)	Instantiates a new FileProperty with the given arguments.
static FileProperty	fileProperty(String aLongOption, String aAlias, String aDescription, Consumer<FileProperty> aConsumer)	Instantiates a new FileProperty with the given arguments.
static FileProperty	fileProperty(String aLongOption, String aDescription, Consumer<FileProperty> aConsumer)	Instantiates a new FileProperty with the given arguments.
static Flag	flag(Character aShortOption, String aLongOption, String aDescription)	Instantiates a new Flag with the given arguments.
static Flag	flag(Character aShortOption, String aLongOption, String aAlias, String aDescription)	Instantiates a new Flag with the given arguments.
static Flag	flag(Character aShortOption, String aLongOption, String aAlias, String aDescription, Consumer<Flag> aConsumer)	Instantiates a new Flag with the given arguments.
static Flag	flag(Character aShortOption, String aLongOption, String aDescription, Consumer<Flag> aConsumer)	Instantiates a new Flag with the given arguments.
static Flag	flag(String aLongOption, String aDescription)	Instantiates a new Flag with the given arguments.
static Flag	flag(String aLongOption, String aAlias, String aDescription)	Instantiates a new Flag with the given arguments.
static Flag	flag(String aLongOption, String aAlias, String aDescription, Consumer<Flag> aConsumer)	Instantiates a new Flag with the given arguments.
static Flag	flag(String aLongOption, String aDescription, Consumer<Flag> aConsumer)	Instantiates a new Flag with the given arguments.
static FloatOption	floatOption(Character aShortOption, String aLongOption, String aDescription)	Instantiates a new FloatOption with the given arguments.
static FloatOption	floatOption(Character aShortOption, String aLongOption, String aAlias, String aDescription)	Instantiates a new FloatOption with the given arguments.
static FloatOption	floatOption(Character aShortOption, String aLongOption, String aAlias, String aDescription, Consumer<FloatOption> aConsumer)	Instantiates a new FloatOption with the given arguments.
static FloatOption	floatOption(Character aShortOption, String aLongOption, String aDescription, Consumer<FloatOption> aConsumer)	Instantiates a new FloatOption with the given arguments.
static FloatOption	floatOption(String aLongOption, String aDescription)	Instantiates a new FloatOption with the given arguments.
static FloatOption	floatOption(String aLongOption, String aAlias, String aDescription)	Instantiates a new FloatOption with the given arguments.
static FloatOption	floatOption(String aLongOption, String aAlias, String aDescription, Consumer<FloatOption> aConsumer)	Instantiates a new FloatOption with the given arguments.
static FloatOption	floatOption(String aLongOption, String aDescription, Consumer<FloatOption> aConsumer)	Instantiates a new FloatOption with the given arguments.
static FloatProperty	floatProperty(Character aShortOption, String aLongOption, String aDescription)	Instantiates a new FloatProperty with the given arguments.
static FloatProperty	floatProperty(Character aShortOption, String aLongOption, String aAlias, String aDescription)	Instantiates a new FloatProperty with the given arguments.
static FloatProperty	floatProperty(Character aShortOption, String aLongOption, String aAlias, String aDescription, Consumer<FloatProperty> aConsumer)	Instantiates a new FloatProperty with the given arguments.
static FloatProperty	floatProperty(Character aShortOption, String aLongOption, String aDescription, Consumer<FloatProperty> aConsumer)	Instantiates a new FloatProperty with the given arguments.
static FloatProperty	floatProperty(String aLongOption, String aDescription)	Instantiates a new FloatProperty with the given arguments.
static FloatProperty	floatProperty(String aLongOption, String aAlias, String aDescription)	Instantiates a new FloatProperty with the given arguments.
static FloatProperty	floatProperty(String aLongOption, String aAlias, String aDescription, Consumer<FloatProperty> aConsumer)	Instantiates a new FloatProperty with the given arguments.
static FloatProperty	floatProperty(String aLongOption, String aDescription, Consumer<FloatProperty> aConsumer)	Instantiates a new FloatProperty with the given arguments.
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(Character aShortOption, String aLongOption, String aDescription)	Instantiates a new IntOption with the given arguments.
static IntOption	intOption(Character aShortOption, String aLongOption, String aAlias, String aDescription)	Instantiates a new IntOption with the given arguments.
static IntOption	intOption(Character aShortOption, String aLongOption, String aAlias, String aDescription, Consumer<IntOption> aConsumer)	Instantiates a new IntOption with the given arguments.
static IntOption	intOption(Character aShortOption, String aLongOption, String aDescription, Consumer<IntOption> aConsumer)	Instantiates a new IntOption with the given arguments.
static IntOption	intOption(String aLongOption, String aDescription)	Instantiates a new IntOption with the given arguments.
static IntOption	intOption(String aLongOption, String aAlias, String aDescription)	Instantiates a new IntOption with the given arguments.
static IntOption	intOption(String aLongOption, String aAlias, String aDescription, Consumer<IntOption> aConsumer)	Instantiates a new IntOption with the given arguments.
static IntOption	intOption(String aLongOption, String aDescription, Consumer<IntOption> aConsumer)	Instantiates a new IntOption with the given arguments.
static IntProperty	intProperty(Character aShortOption, String aLongOption, String aDescription)	Instantiates a new IntProperty with the given arguments.
static IntProperty	intProperty(Character aShortOption, String aLongOption, String aAlias, String aDescription)	Instantiates a new IntProperty with the given arguments.
static IntProperty	intProperty(Character aShortOption, String aLongOption, String aAlias, String aDescription, Consumer<IntProperty> aConsumer)	Instantiates a new IntProperty with the given arguments.
static IntProperty	intProperty(Character aShortOption, String aLongOption, String aDescription, Consumer<IntProperty> aConsumer)	Instantiates a new IntProperty with the given arguments.
static IntProperty	intProperty(String aLongOption, String aDescription)	Instantiates a new IntProperty with the given arguments.
static IntProperty	intProperty(String aLongOption, String aAlias, String aDescription)	Instantiates a new IntProperty with the given arguments.
static IntProperty	intProperty(String aLongOption, String aAlias, String aDescription, Consumer<IntProperty> aConsumer)	Instantiates a new IntProperty with the given arguments.
static IntProperty	intProperty(String aLongOption, String aDescription, Consumer<IntProperty> aConsumer)	Instantiates a new IntProperty with the given arguments.
static LongOption	longOption(Character aShortOption, String aLongOption, String aDescription)	Instantiates a new LongOption with the given arguments.
static LongOption	longOption(Character aShortOption, String aLongOption, String aAlias, String aDescription)	Instantiates a new LongOption with the given arguments.
static LongOption	longOption(Character aShortOption, String aLongOption, String aAlias, String aDescription, Consumer<LongOption> aConsumer)	Instantiates a new LongOption with the given arguments.
static LongOption	longOption(Character aShortOption, String aLongOption, String aDescription, Consumer<LongOption> aConsumer)	Instantiates a new LongOption with the given arguments.
static LongOption	longOption(String aLongOption, String aDescription)	Instantiates a new LongOption with the given arguments.
static LongOption	longOption(String aLongOption, String aAlias, String aDescription)	Instantiates a new LongOption with the given arguments.
static LongOption	longOption(String aLongOption, String aAlias, String aDescription, Consumer<LongOption> aConsumer)	Instantiates a new LongOption with the given arguments.
static LongOption	longOption(String aLongOption, String aDescription, Consumer<LongOption> aConsumer)	Instantiates a new LongOption with the given arguments.
static LongProperty	longProperty(Character aShortOption, String aLongOption, String aDescription)	Instantiates a new LongProperty with the given arguments.
static LongProperty	longProperty(Character aShortOption, String aLongOption, String aAlias, String aDescription)	Instantiates a new LongProperty with the given arguments.
static LongProperty	longProperty(Character aShortOption, String aLongOption, String aAlias, String aDescription, Consumer<LongProperty> aConsumer)	Instantiates a new LongProperty with the given arguments.
static LongProperty	longProperty(Character aShortOption, String aLongOption, String aDescription, Consumer<LongProperty> aConsumer)	Instantiates a new LongProperty with the given arguments.
static LongProperty	longProperty(String aLongOption, String aDescription)	Instantiates a new LongProperty with the given arguments.
static LongProperty	longProperty(String aLongOption, String aAlias, String aDescription)	Instantiates a new LongProperty with the given arguments.
static LongProperty	longProperty(String aLongOption, String aAlias, String aDescription, Consumer<LongProperty> aConsumer)	Instantiates a new LongProperty with the given arguments.
static LongProperty	longProperty(String aLongOption, String aDescription, Consumer<LongProperty> aConsumer)	Instantiates a new LongProperty with the given arguments.
static NoneOperand	none(String aDescription)	Instantiates a new NoneOperand.
static NoneOperand	none(String aAlias, String aDescription)	Instantiates a new NoneOperand.
static NoneOperand	none(String aAlias, String aDescription, Consumer<NoneOperand> aConsumer)	Instantiates a new NoneOperand.
static NoneOperand	none(String aDescription, Consumer<NoneOperand> aConsumer)	Instantiates a new NoneOperand.
static NoneOperand	none(org.refcodes.struct.Relation<String,Boolean> aProperty)	Instantiates a new NoneOperand.
static NoneOperand	none(org.refcodes.struct.Relation<String,Boolean> aProperty, Consumer<NoneOperand> aConsumer)	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 Operation	operation(String aOperation, String aAlias, String aDescription, Consumer<Operation> aConsumer)	Constructs a Operation with the given arguments.
static Operation	operation(String aOperation, String aDescription, Consumer<Operation> aConsumer)	Constructs a Operation with the given arguments.
static AnyCondition	optional(Term... aArgs)	Semantically identical synonym for the optional(Term...) declaration.
static OrCondition	or(Term... aArgs)	Instantiates a new OrCondition with the Term (Condition) 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 aAlias, String aDescription)	Instantiates a new StringOperand.
static StringOperand	stringOperand(String aAlias, String aDescription, Consumer<StringOperand> aConsumer)	Instantiates a new StringOperand.
static StringOption	stringOption(Character aShortOption, String aLongOption, String aDescription)	Instantiates a new StringOption with the given arguments.
static StringOption	stringOption(Character aShortOption, String aLongOption, String aAlias, String aDescription)	Instantiates a new StringOption with the given arguments.
static StringOption	stringOption(Character aShortOption, String aLongOption, String aAlias, String aDescription, Consumer<StringOption> aConsumer)	Instantiates a new StringOption with the given arguments.
static StringOption	stringOption(Character aShortOption, String aLongOption, String aDescription, Consumer<StringOption> aConsumer)	Instantiates a new StringOption with the given arguments.
static StringOption	stringOption(String aLongOption, String aDescription)	Instantiates a new StringOption with the given arguments.
static StringOption	stringOption(String aLongOption, String aAlias, String aDescription)	Instantiates a new StringOption with the given arguments.
static StringOption	stringOption(String aLongOption, String aAlias, String aDescription, Consumer<StringOption> aConsumer)	Instantiates a new StringOption with the given arguments.
static StringOption	stringOption(String aLongOption, String aDescription, Consumer<StringOption> aConsumer)	Instantiates a new StringOption with the given arguments.
static StringProperty	stringProperty(Character aShortOption, String aLongOption, String aDescription)	Instantiates a new StringProperty with the given arguments.
static StringProperty	stringProperty(Character aShortOption, String aLongOption, String aAlias, String aDescription)	Instantiates a new StringProperty with the given arguments.
static StringProperty	stringProperty(Character aShortOption, String aLongOption, String aAlias, String aDescription, Consumer<StringProperty> aConsumer)	Instantiates a new StringProperty with the given arguments.
static StringProperty	stringProperty(Character aShortOption, String aLongOption, String aDescription, Consumer<StringProperty> aConsumer)	Instantiates a new StringProperty with the given arguments.
static StringProperty	stringProperty(String aLongOption, String aDescription)	Instantiates a new StringProperty with the given arguments.
static StringProperty	stringProperty(String aLongOption, String aAlias, String aDescription)	Instantiates a new StringProperty with the given arguments.
static StringProperty	stringProperty(String aLongOption, String aAlias, String aDescription, Consumer<StringProperty> aConsumer)	Instantiates a new StringProperty with the given arguments.
static StringProperty	stringProperty(String aLongOption, String aDescription, Consumer<StringProperty> aConsumer)	Instantiates a new StringProperty with the given arguments.
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 XorCondition	xor(Term... aArgs)	Instantiates a new XorCondition with the Term (Condition) instances to be nested.

Methods inherited from class java.lang.Object

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

Method Details

all

public static AllCondition all(Term aArg)

Instantiates a new AllCondition with the Term (Condition) instance to be nested.

Parameters:

aArg - The Term (Condition) instance to be nested.

Returns:

The according ALL condition.

See Also:

• AllCondition

and

public static AndCondition and(Term... aArgs)

Instantiates a new AndCondition with the Term (Condition) instances to be nested.

Parameters:

aArgs - The Term (Condition) instances to be nested.

Returns:

The according AND condition.

See Also:

• AndCondition

any

public static AnyCondition any(Term... aArgs)

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

Parameters:

aArgs - The Term (Condition) instances to be nested

Returns:

The according AbstractCondition.

See Also:

• AnyCondition

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.

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.

booleanOption

public static BooleanOption booleanOption(Character aShortOption,
 String aLongOption,
 String aDescription)

Instantiates a new BooleanOption with the given arguments. In case a long option is provided, the intance's alias will automatically be set with the long option, else the short option is used ass alias.

Parameters:

aShortOption - The short option to use.

aLongOption - The long option to use.

aDescription - The description of the BooleanOption

Returns:

The accordingly created BooleanOption instance.

See Also:

• BooleanOption

booleanOption

public static BooleanOption booleanOption(Character aShortOption,
 String aLongOption,
 String aDescription,
 Consumer<BooleanOption> aConsumer)

Instantiates a new BooleanOption with the given arguments. In case a long option is provided, the intance's alias will automatically be set with the long option, else the short option is used ass alias.

Parameters:

aShortOption - The short option to use.

aLongOption - The long option to use.

aDescription - The description of the BooleanOption

aConsumer - The Consumer being invoked in case this BooleanOption participated in successfully parsing the command line arguments.

Returns:

The accordingly created BooleanOption instance.

See Also:

• BooleanOption

booleanOption

public static BooleanOption booleanOption(Character aShortOption,
 String aLongOption,
 String aAlias,
 String aDescription)

Instantiates a new BooleanOption with the given arguments.

Parameters:

aShortOption - The short option to use.

aLongOption - The long option to use.

aAlias - The alias to be used for naming purposes.

aDescription - The description of the BooleanOption

Returns:

The accordingly created BooleanOption instance.

See Also:

• BooleanOption

booleanOption

public static BooleanOption booleanOption(Character aShortOption,
 String aLongOption,
 String aAlias,
 String aDescription,
 Consumer<BooleanOption> aConsumer)

Instantiates a new BooleanOption with the given arguments.

Parameters:

aShortOption - The short option to use.

aLongOption - The long option to use.

aAlias - The alias to be used for naming purposes.

aDescription - The description of the BooleanOption

aConsumer - The Consumer being invoked in case this BooleanOption participated in successfully parsing the command line arguments.

Returns:

The accordingly created BooleanOption instance.

See Also:

• BooleanOption

booleanOption

public static BooleanOption booleanOption(String aLongOption,
 String aDescription)

Instantiates a new BooleanOption with the given arguments. In case a long option is provided, the intance's alias will automatically be set with the long option.

Parameters:

aLongOption - The long option to use.

aDescription - The description of the BooleanOption

Returns:

The accordingly created BooleanOption instance.

See Also:

• BooleanOption

booleanOption

public static BooleanOption booleanOption(String aLongOption,
 String aDescription,
 Consumer<BooleanOption> aConsumer)

Instantiates a new BooleanOption with the given arguments. In case a long option is provided, the intance's alias will automatically be set with the long option.

Parameters:

aLongOption - The long option to use.

aDescription - The description of the BooleanOption

aConsumer - The Consumer being invoked in case this BooleanOption participated in successfully parsing the command line arguments.

Returns:

The accordingly created BooleanOption instance.

See Also:

• BooleanOption

booleanOption

public static BooleanOption booleanOption(String aLongOption,
 String aAlias,
 String aDescription)

Instantiates a new BooleanOption with the given arguments.

Parameters:

aLongOption - The long option to use.

aAlias - The alias to be used for naming purposes.

aDescription - The description of the BooleanOption

Returns:

The accordingly created BooleanOption instance.

See Also:

• BooleanOption

booleanOption

public static BooleanOption booleanOption(String aLongOption,
 String aAlias,
 String aDescription,
 Consumer<BooleanOption> aConsumer)

Instantiates a new BooleanOption with the given arguments.

Parameters:

aLongOption - The long option to use.

aAlias - The alias to be used for naming purposes.

aDescription - The description of the BooleanOption

aConsumer - The Consumer being invoked in case this BooleanOption participated in successfully parsing the command line arguments.

Returns:

The accordingly created BooleanOption instance.

See Also:

• BooleanOption

booleanProperty

public static BooleanProperty booleanProperty(Character aShortOption,
 String aLongOption,
 String aDescription)

Instantiates a new BooleanProperty with the given arguments. In case a long option is provided, the intance's alias will automatically be set with the long option, else the short option is used ass alias.

Parameters:

aShortOption - The short option to use.

aLongOption - the boolean property

aDescription - The description of the BooleanProperty

Returns:

The accordingly created BooleanProperty instance.

See Also:

• BooleanProperty

booleanProperty

public static BooleanProperty booleanProperty(Character aShortOption,
 String aLongOption,
 String aDescription,
 Consumer<BooleanProperty> aConsumer)

Instantiates a new BooleanProperty with the given arguments. In case a long option is provided, the intance's alias will automatically be set with the long option, else the short option is used ass alias.

Parameters:

aShortOption - The short option to use.

aLongOption - the boolean property

aDescription - The description of the BooleanProperty

aConsumer - The Consumer being invoked in case this BooleanProperty participated in successfully parsing the command line arguments.

Returns:

The accordingly created BooleanProperty instance.

See Also:

• BooleanProperty

booleanProperty

public static BooleanProperty booleanProperty(Character aShortOption,
 String aLongOption,
 String aAlias,
 String aDescription)

Instantiates a new BooleanProperty with the given arguments.

Parameters:

aShortOption - The short option to use.

aLongOption - The long option to use.

aAlias - The alias to be used for naming purposes.

aDescription - The description of the BooleanProperty

Returns:

The accordingly created BooleanProperty instance.

See Also:

• BooleanProperty

booleanProperty

public static BooleanProperty booleanProperty(Character aShortOption,
 String aLongOption,
 String aAlias,
 String aDescription,
 Consumer<BooleanProperty> aConsumer)

Instantiates a new BooleanProperty with the given arguments.

Parameters:

aShortOption - The short option to use.

aLongOption - The long option to use.

aAlias - The alias to be used for naming purposes.

aDescription - The description of the BooleanProperty

aConsumer - The Consumer being invoked in case this BooleanProperty participated in successfully parsing the command line arguments.

Returns:

The accordingly created BooleanProperty instance.

See Also:

• BooleanProperty

booleanProperty

public static BooleanProperty booleanProperty(String aLongOption,
 String aDescription)

Instantiates a new BooleanProperty with the given arguments. In case a long option is provided, the intance's alias will automatically be set with the long option.

Parameters:

aLongOption - The long option to use.

aDescription - The description of the BooleanProperty

Returns:

The accordingly created BooleanProperty instance.

See Also:

• BooleanProperty

booleanProperty

public static BooleanProperty booleanProperty(String aLongOption,
 String aDescription,
 Consumer<BooleanProperty> aConsumer)

Instantiates a new BooleanProperty with the given arguments. In case a long option is provided, the intance's alias will automatically be set with the long option.

Parameters:

aLongOption - The long option to use.

aDescription - The description of the BooleanProperty

aConsumer - The Consumer being invoked in case this BooleanProperty participated in successfully parsing the command line arguments.

Returns:

The accordingly created BooleanProperty instance.

See Also:

• BooleanProperty

booleanProperty

public static BooleanProperty booleanProperty(String aLongOption,
 String aAlias,
 String aDescription)

Instantiates a new BooleanProperty with the given arguments.

Parameters:

aLongOption - The long option to use.

aAlias - The alias to be used for naming purposes.

aDescription - The description of the BooleanProperty

Returns:

The accordingly created BooleanProperty instance.

See Also:

• BooleanProperty

booleanProperty

public static BooleanProperty booleanProperty(String aLongOption,
 String aAlias,
 String aDescription,
 Consumer<BooleanProperty> aConsumer)

Instantiates a new BooleanProperty with the given arguments.

Parameters:

aLongOption - The long option to use.

aAlias - The alias to be used for naming purposes.

aDescription - The description of the BooleanProperty

aConsumer - The Consumer being invoked in case this BooleanProperty participated in successfully parsing the command line arguments.

Returns:

The accordingly created BooleanProperty instance.

See Also:

• BooleanProperty

cases

public static CasesCondition cases(Term... aArgs)

Instantiates a new CasesCondition with the Term (Condition) instances to be nested.

Parameters:

aArgs - The Term (Condition) instances to be nested.

Returns:

The according CasesCondition (https://www.metacodes.pro XOR) condition.

See Also:

• CasesCondition

charOption

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

Instantiates a new CharOption with the given arguments. In case a long option is provided, the intance's alias will automatically be set with the long option, else the short option is used ass alias.

Parameters:

aShortOption - The short option to use.

aLongOption - The long option to use.

aDescription - The description of the CharOption

Returns:

The accordingly created EnumOptioninstance.

See Also:

• CharOption

charOption

public static CharOption charOption(Character aShortOption,
 String aLongOption,
 String aDescription,
 Consumer<CharOption> aConsumer)

Instantiates a new CharOption with the given arguments. In case a long option is provided, the intance's alias will automatically be set with the long option, else the short option is used ass alias.

Parameters:

aShortOption - The short option to use.

aLongOption - The long option to use.

aDescription - The description of the CharOption

aConsumer - The Consumer being invoked in case this CharOption participated in successfully parsing the command line arguments.

Returns:

The accordingly created CharOption instance.

See Also:

• CharOption

charOption

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

Instantiates a new CharOption with the given arguments.

Parameters:

aShortOption - The short option to use.

aLongOption - The long option to use.

aAlias - The alias to be used for naming purposes.

aDescription - The description of the CharOption

Returns:

The accordingly created EnumOptioninstance.

See Also:

• CharOption

charOption

public static CharOption charOption(Character aShortOption,
 String aLongOption,
 String aAlias,
 String aDescription,
 Consumer<CharOption> aConsumer)

Instantiates a new CharOption with the given arguments.

Parameters:

aShortOption - The short option to use.

aLongOption - The long option to use.

aAlias - The alias to be used for naming purposes.

aDescription - The description of the CharOption

aConsumer - The Consumer being invoked in case this CharOption participated in successfully parsing the command line arguments.

Returns:

The accordingly created CharOption instance.

See Also:

• CharOption

charOption

public static CharOption charOption(String aLongOption,
 String aDescription)

Instantiates a new CharOption with the given arguments. In case a long option is provided, the intance's alias will automatically be set with the long option.

Parameters:

aLongOption - The long option to use.

aDescription - The description of the CharOption

Returns:

The accordingly created CharOption instance.

See Also:

• CharOption

charOption

public static CharOption charOption(String aLongOption,
 String aDescription,
 Consumer<CharOption> aConsumer)

Instantiates a new CharOption with the given arguments. In case a long option is provided, the intance's alias will automatically be set with the long option.

Parameters:

aLongOption - The long option to use.

aDescription - The description of the CharOption

aConsumer - The Consumer being invoked in case this CharOption participated in successfully parsing the command line arguments.

Returns:

The accordingly created CharOption instance.

See Also:

• CharOption

charOption

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

Instantiates a new CharOption with the given arguments.

Parameters:

aLongOption - The long option to use.

aAlias - The alias to be used for naming purposes.

aDescription - The description of the CharOption

Returns:

The accordingly created CharOption instance.

See Also:

• CharOption

charOption

public static CharOption charOption(String aLongOption,
 String aAlias,
 String aDescription,
 Consumer<CharOption> aConsumer)

Instantiates a new CharOption with the given arguments.

Parameters:

aLongOption - The long option to use.

aAlias - The alias to be used for naming purposes.

aDescription - The description of the CharOption

aConsumer - The Consumer being invoked in case this CharOption participated in successfully parsing the command line arguments.

Returns:

The accordingly created CharOption instance.

See Also:

• CharOption

charProperty

public static CharProperty charProperty(Character aShortOption,
 String aLongOption,
 String aDescription)

Instantiates a new CharProperty with the given arguments. In case a long option is provided, the intance's alias will automatically be set with the long option, else the short option is used ass alias.

Parameters:

aShortOption - The short option to use.

aLongOption - The long option to use.

aDescription - The description of the CharProperty

Returns:

The accordingly created EnumPropertyinstance.

See Also:

• CharProperty

charProperty

public static CharProperty charProperty(Character aShortOption,
 String aLongOption,
 String aDescription,
 Consumer<CharProperty> aConsumer)

Instantiates a new CharProperty with the given arguments. In case a long option is provided, the intance's alias will automatically be set with the long option, else the short option is used ass alias.

Parameters:

aShortOption - The short option to use.

aLongOption - The long option to use.

aDescription - The description of the CharProperty

aConsumer - The Consumer being invoked in case this CharProperty participated in successfully parsing the command line arguments.

Returns:

The accordingly created EnumPropertyinstance.

See Also:

• CharProperty

charProperty

public static CharProperty charProperty(Character aShortOption,
 String aLongOption,
 String aAlias,
 String aDescription)

Instantiates a new CharProperty with the given arguments.

Parameters:

aShortOption - The short option to use.

aLongOption - The long option to use.

aAlias - The alias to be used for naming purposes.

aDescription - The description of the CharProperty

Returns:

The accordingly created EnumPropertyinstance.

See Also:

• CharProperty

charProperty

public static CharProperty charProperty(Character aShortOption,
 String aLongOption,
 String aAlias,
 String aDescription,
 Consumer<CharProperty> aConsumer)

Instantiates a new CharProperty with the given arguments.

Parameters:

aShortOption - The short option to use.

aLongOption - The long option to use.

aAlias - The alias to be used for naming purposes.

aDescription - The description of the CharProperty

aConsumer - The Consumer being invoked in case this CharProperty participated in successfully parsing the command line arguments.

Returns:

The accordingly created EnumPropertyinstance.

See Also:

• CharProperty

charProperty

public static CharProperty charProperty(String aLongOption,
 String aDescription)

Instantiates a new CharProperty with the given arguments. In case a long option is provided, the intance's alias will automatically be set with the long option.

Parameters:

aLongOption - The long option to use.

aDescription - The description of the CharProperty

Returns:

The accordingly created CharProperty instance.

See Also:

• CharProperty

charProperty

public static CharProperty charProperty(String aLongOption,
 String aDescription,
 Consumer<CharProperty> aConsumer)

Instantiates a new CharProperty with the given arguments. In case a long option is provided, the intance's alias will automatically be set with the long option.

Parameters:

aLongOption - The long option to use.

aDescription - The description of the CharProperty

aConsumer - The Consumer being invoked in case this CharProperty participated in successfully parsing the command line arguments.

Returns:

The accordingly created CharProperty instance.

See Also:

• CharProperty

charProperty

public static CharProperty charProperty(String aLongOption,
 String aAlias,
 String aDescription)

Instantiates a new CharProperty with the given arguments.

Parameters:

aLongOption - The long option to use.

aAlias - The alias to be used for naming purposes.

aDescription - The description of the CharProperty

Returns:

The accordingly created CharProperty instance.

See Also:

• CharProperty

charProperty

public static CharProperty charProperty(String aLongOption,
 String aAlias,
 String aDescription,
 Consumer<CharProperty> aConsumer)

Instantiates a new CharProperty with the given arguments.

Parameters:

aLongOption - The long option to use.

aAlias - The alias to be used for naming purposes.

aDescription - The description of the CharProperty

aConsumer - The Consumer being invoked in case this CharProperty participated in successfully parsing the command line arguments.

Returns:

The accordingly created CharProperty instance.

See Also:

• CharProperty

cleanFlag

public static CleanFlag cleanFlag()

Constructs the predefined clean Flag.

Returns:

The accordingly created Flag instance.

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 accordingly created Flag instance.

See Also:

• CleanFlag

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 accordingly created Flag instance.

See Also:

• CleanFlag

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)

Instantiates a new config (file) Option.

Parameters:

aDescription - The description to use.

Returns:

the according ConfigOption.

See Also:

• ConfigOption

daemonFlag

public static DaemonFlag daemonFlag()

Constructs the predefined daemon Flag.

Returns:

The accordingly created Flag instance.

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 accordingly created Flag instance.

See Also:

• DaemonFlag

daemonFlag

public static DaemonFlag daemonFlag(String aDescription)

Constructs the predefined daemon Flag.

Parameters:

aDescription - The description to be used (without any line breaks).

Returns:

The accordingly created Flag instance.

See Also:

• DaemonFlag

debugFlag

public static DebugFlag debugFlag()

Constructs the predefined debug Flag.

Returns:

The accordingly created Flag instance.

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 accordingly created Flag instance.

See Also:

• DebugFlag

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 accordingly created Flag instance.

See Also:

• DebugFlag

doubleOption

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

Instantiates a new DoubleOption with the given arguments. In case a long option is provided, the intance's alias will automatically be set with the long option, else the short option is used ass alias.

Parameters:

aShortOption - The short option to use.

aLongOption - The long option to use.

aDescription - The description of the DoubleOption

Returns:

The accordingly created DoubleOption instance.

See Also:

• DoubleOption

doubleOption

public static DoubleOption doubleOption(Character aShortOption,
 String aLongOption,
 String aDescription,
 Consumer<DoubleOption> aConsumer)

Instantiates a new DoubleOption with the given arguments. In case a long option is provided, the intance's alias will automatically be set with the long option, else the short option is used ass alias.

Parameters:

aShortOption - The short option to use.

aLongOption - The long option to use.

aDescription - The description of the DoubleOption

aConsumer - The Consumer being invoked in case this DoubleOption participated in successfully parsing the command line arguments.

Returns:

The accordingly created DoubleOption instance.

See Also:

• DoubleOption

doubleOption

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

Instantiates a new DoubleOption with the given arguments.

Parameters:

aShortOption - The short option to use.

aLongOption - The long option to use.

aAlias - The alias to be used for naming purposes.

aDescription - The description of the DoubleOption

Returns:

The accordingly created DoubleOption instance.

See Also:

• DoubleOption

doubleOption

public static DoubleOption doubleOption(Character aShortOption,
 String aLongOption,
 String aAlias,
 String aDescription,
 Consumer<DoubleOption> aConsumer)

Instantiates a new DoubleOption with the given arguments.

Parameters:

aShortOption - The short option to use.

aLongOption - The long option to use.

aAlias - The alias to be used for naming purposes.

aDescription - The description of the DoubleOption

aConsumer - The Consumer being invoked in case this DoubleOption participated in successfully parsing the command line arguments.

Returns:

The accordingly created DoubleOption instance.

See Also:

• DoubleOption

doubleOption

public static DoubleOption doubleOption(String aLongOption,
 String aDescription)

Instantiates a new DoubleOption with the given arguments. In case a long option is provided, the intance's alias will automatically be set with the long option.

Parameters:

aLongOption - The long option to use.

aDescription - The description of the DoubleOption

Returns:

The accordingly created DoubleOption instance.

See Also:

• DoubleOption

doubleOption

public static DoubleOption doubleOption(String aLongOption,
 String aDescription,
 Consumer<DoubleOption> aConsumer)

Instantiates a new DoubleOption with the given arguments. In case a long option is provided, the intance's alias will automatically be set with the long option.

Parameters:

aLongOption - The long option to use.

aDescription - The description of the DoubleOption

aConsumer - The Consumer being invoked in case this DoubleOption participated in successfully parsing the command line arguments.

Returns:

The accordingly created DoubleOption instance.

See Also:

• DoubleOption

doubleOption

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

Instantiates a new DoubleOption with the given arguments.

Parameters:

aLongOption - The long option to use.

aAlias - The alias to be used for naming purposes.

aDescription - The description of the DoubleOption

Returns:

The accordingly created DoubleOption instance.

See Also:

• DoubleOption

doubleOption

public static DoubleOption doubleOption(String aLongOption,
 String aAlias,
 String aDescription,
 Consumer<DoubleOption> aConsumer)

Instantiates a new DoubleOption with the given arguments.

Parameters:

aLongOption - The long option to use.

aAlias - The alias to be used for naming purposes.

aDescription - The description of the DoubleOption

aConsumer - The Consumer being invoked in case this DoubleOption participated in successfully parsing the command line arguments.

Returns:

The accordingly created DoubleOption instance.

See Also:

• DoubleOption

doubleProperty

public static DoubleProperty doubleProperty(Character aShortOption,
 String aLongOption,
 String aDescription)

Instantiates a new DoubleProperty with the given arguments. In case a long option is provided, the intance's alias will automatically be set with the long option, else the short option is used ass alias.

Parameters:

aShortOption - The short option to use.

aLongOption - the double property

aDescription - The description of the DoubleProperty

Returns:

The accordingly created DoubleProperty instance.

See Also:

• DoubleProperty

doubleProperty

public static DoubleProperty doubleProperty(Character aShortOption,
 String aLongOption,
 String aDescription,
 Consumer<DoubleProperty> aConsumer)

Instantiates a new DoubleProperty with the given arguments. In case a long option is provided, the intance's alias will automatically be set with the long option, else the short option is used ass alias.

Parameters:

aShortOption - The short option to use.

aLongOption - the double property

aDescription - The description of the DoubleProperty

aConsumer - The Consumer being invoked in case this DoubleProperty participated in successfully parsing the command line arguments.

Returns:

The accordingly created DoubleProperty instance.

See Also:

• DoubleProperty

doubleProperty

public static DoubleProperty doubleProperty(Character aShortOption,
 String aLongOption,
 String aAlias,
 String aDescription)

Instantiates a new DoubleProperty with the given arguments.

Parameters:

aShortOption - The short option to use.

aLongOption - The long option to use.

aAlias - The alias to be used for naming purposes.

aDescription - The description of the DoubleProperty

Returns:

The accordingly created DoubleProperty instance.

See Also:

• DoubleProperty

doubleProperty

public static DoubleProperty doubleProperty(Character aShortOption,
 String aLongOption,
 String aAlias,
 String aDescription,
 Consumer<DoubleProperty> aConsumer)

Instantiates a new DoubleProperty with the given arguments.

Parameters:

aShortOption - The short option to use.

aLongOption - The long option to use.

aAlias - The alias to be used for naming purposes.

aDescription - The description of the DoubleProperty

aConsumer - The Consumer being invoked in case this DoubleProperty participated in successfully parsing the command line arguments.

Returns:

The accordingly created DoubleProperty instance.

See Also:

• DoubleProperty

doubleProperty

public static DoubleProperty doubleProperty(String aLongOption,
 String aDescription)

Instantiates a new DoubleProperty with the given arguments. In case a long option is provided, the intance's alias will automatically be set with the long option.

Parameters:

aLongOption - The long option to use.

aDescription - The description of the DoubleProperty

Returns:

The accordingly created DoubleProperty instance.

See Also:

• DoubleProperty

doubleProperty

public static DoubleProperty doubleProperty(String aLongOption,
 String aDescription,
 Consumer<DoubleProperty> aConsumer)

Instantiates a new DoubleProperty with the given arguments. In case a long option is provided, the intance's alias will automatically be set with the long option.

Parameters:

aLongOption - The long option to use.

aDescription - The description of the DoubleProperty

aConsumer - The Consumer being invoked in case this DoubleProperty participated in successfully parsing the command line arguments.

Returns:

The accordingly created DoubleProperty instance.

See Also:

• DoubleProperty

doubleProperty

public static DoubleProperty doubleProperty(String aLongOption,
 String aAlias,
 String aDescription)

Instantiates a new DoubleProperty with the given arguments.

Parameters:

aLongOption - The long option to use.

aAlias - The alias to be used for naming purposes.

aDescription - The description of the DoubleProperty

Returns:

The accordingly created DoubleProperty instance.

See Also:

• DoubleProperty

doubleProperty

public static DoubleProperty doubleProperty(String aLongOption,
 String aAlias,
 String aDescription,
 Consumer<DoubleProperty> aConsumer)

Instantiates a new DoubleProperty with the given arguments.

Parameters:

aLongOption - The long option to use.

aAlias - The alias to be used for naming purposes.

aDescription - The description of the DoubleProperty

aConsumer - The Consumer being invoked in case this DoubleProperty participated in successfully parsing the command line arguments.

Returns:

The accordingly created DoubleProperty instance.

See Also:

• DoubleProperty

enumOption

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

Instantiates a new EnumOption with the given arguments. In case a long option is provided, the intance's alias will automatically be set with the long option, else the short option is used ass alias.

Type Parameters:

T - The generic type of the enumeration.

Parameters:

aShortOption - The short option to use.

aLongOption - The long option to use.

aType - The type of the enumeration to be used.

aDescription - The description of the EnumOption

Returns:

The accordingly created EnumOption instance.

See Also:

• EnumOption

enumOption

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

Instantiates a new EnumOption with the given arguments. In case a long option is provided, the intance's alias will automatically be set with the long option, else the short option is used ass alias.

Type Parameters:

T - The generic type of the enumeration.

Parameters:

aShortOption - The short option to use.

aLongOption - The long option to use.

aType - The type of the enumeration to be used.

aDescription - The description of the EnumOption

aConsumer - The Consumer being invoked in case this EnumOption participated in successfully parsing the command line arguments.

Returns:

The accordingly created EnumOption instance.

See Also:

• EnumOption

enumOption

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

Instantiates a new EnumOption with the given arguments.

Type Parameters:

T - The generic type of the enumeration.

Parameters:

aShortOption - The short option to use.

aLongOption - The long option to use.

aType - The type of the enumeration to be used.

aAlias - The alias to be used for naming purposes.

aDescription - The description of the EnumOption

Returns:

The accordingly created EnumOption instance.

See Also:

• EnumOption

enumOption

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

Instantiates a new EnumOption with the given arguments.

Type Parameters:

T - The generic type of the enumeration.

Parameters:

aShortOption - The short option to use.

aLongOption - The long option to use.

aType - The type of the enumeration to be used.

aAlias - The alias to be used for naming purposes.

aDescription - The description of the EnumOption

aConsumer - The Consumer being invoked in case this EnumOption participated in successfully parsing the command line arguments.

Returns:

The accordingly created EnumOption instance.

See Also:

• EnumOption

enumOption

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

Instantiates a new EnumOption with the given arguments. In case a long option is provided, the intance's alias will automatically be set with the long option.

Type Parameters:

T - The generic type of the enumeration.

Parameters:

aLongOption - The long option to use.

aType - The type of the enumeration to be used.

aDescription - The description of the EnumOption

Returns:

The accordingly created EnumOption instance.

See Also:

• EnumOption

enumOption

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

Instantiates a new EnumOption with the given arguments. In case a long option is provided, the intance's alias will automatically be set with the long option.

Type Parameters:

T - The generic type of the enumeration.

Parameters:

aLongOption - The long option to use.

aType - The type of the enumeration to be used.

aDescription - The description of the EnumOption

aConsumer - The Consumer being invoked in case this EnumOption participated in successfully parsing the command line arguments.

Returns:

The accordingly created EnumOption instance.

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 EnumOption with the given arguments.

Type Parameters:

T - The generic type of the enumeration.

Parameters:

aLongOption - The long option to use.

aType - The type of the enumeration to be used.

aAlias - The alias to be used for naming purposes.

aDescription - The description of the EnumOption

Returns:

The accordingly created EnumOption instance.

See Also:

• EnumOption

enumOption

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

Instantiates a new EnumOption with the given arguments.

Type Parameters:

T - The generic type of the enumeration.

Parameters:

aLongOption - The long option to use.

aType - The type of the enumeration to be used.

aAlias - The alias to be used for naming purposes.

aDescription - The description of the EnumOption

aConsumer - The Consumer being invoked in case this EnumOption participated in successfully parsing the command line arguments.

Returns:

The accordingly created EnumOption instance.

See Also:

• EnumOption

enumProperty

public static <T extends Enum<T>> EnumProperty<T> enumProperty(Character aShortOption,
 String aLongOption,
 Class<T> aType,
 String aDescription)

Instantiates a new EnumProperty with the given arguments. In case a long option is provided, the intance's alias will automatically be set with the long option, else the short option is used ass alias.

Type Parameters:

T - The generic type of the enumeration.

Parameters:

aShortOption - The short option to use.

aLongOption - The long option to use.

aType - The type of the enumeration to be used.

aDescription - The description of the EnumProperty

Returns:

The accordingly created EnumProperty instance.

See Also:

• EnumProperty

enumProperty

public static <T extends Enum<T>> EnumProperty<T> enumProperty(Character aShortOption,
 String aLongOption,
 Class<T> aType,
 String aDescription,
 Consumer<EnumProperty<T>> aConsumer)

Instantiates a new EnumProperty with the given arguments. In case a long option is provided, the intance's alias will automatically be set with the long option, else the short option is used ass alias.

Type Parameters:

T - The generic type of the enumeration.

Parameters:

aShortOption - The short option to use.

aLongOption - The long option to use.

aType - The type of the enumeration to be used.

aDescription - The description of the EnumProperty

aConsumer - The Consumer being invoked in case this EnumProperty participated in successfully parsing the command line arguments.

Returns:

The accordingly created EnumProperty instance.

See Also:

• EnumProperty

enumProperty

public static <T extends Enum<T>> EnumProperty<T> enumProperty(Character aShortOption,
 String aLongOption,
 Class<T> aType,
 String aAlias,
 String aDescription)

Instantiates a new EnumProperty with the given arguments.

Type Parameters:

T - The generic type of the enumeration.

Parameters:

aShortOption - The short option to use.

aLongOption - The long option to use.

aType - The type of the enumeration to be used.

aAlias - The alias to be used for naming purposes.

aDescription - The description of the EnumProperty

Returns:

The accordingly created EnumProperty instance.

See Also:

• EnumProperty

enumProperty

public static <T extends Enum<T>> EnumProperty<T> enumProperty(Character aShortOption,
 String aLongOption,
 Class<T> aType,
 String aAlias,
 String aDescription,
 Consumer<EnumProperty<T>> aConsumer)

Instantiates a new EnumProperty with the given arguments.

Type Parameters:

T - The generic type of the enumeration.

Parameters:

aShortOption - The short option to use.

aLongOption - The long option to use.

aType - The type of the enumeration to be used.

aAlias - The alias to be used for naming purposes.

aDescription - The description of the EnumProperty

aConsumer - The Consumer being invoked in case this EnumProperty participated in successfully parsing the command line arguments.

Returns:

The accordingly created EnumProperty instance.

See Also:

• EnumProperty

enumProperty

public static <T extends Enum<T>> EnumProperty<T> enumProperty(String aLongOption,
 Class<T> aType,
 String aDescription)

Instantiates a new EnumProperty with the given arguments. In case a long option is provided, the intance's alias will automatically be set with the long option.

Type Parameters:

T - The generic type of the enumeration.

Parameters:

aLongOption - The long option to use.

aType - The type of the enumeration to be used.

aDescription - The description of the EnumProperty

Returns:

The accordingly created EnumProperty instance.

See Also:

• EnumProperty

enumProperty

public static <T extends Enum<T>> EnumProperty<T> enumProperty(String aLongOption,
 Class<T> aType,
 String aDescription,
 Consumer<EnumProperty<T>> aConsumer)

Instantiates a new EnumProperty with the given arguments. In case a long option is provided, the intance's alias will automatically be set with the long option.

Type Parameters:

T - The generic type of the enumeration.

Parameters:

aLongOption - The long option to use.

aType - The type of the enumeration to be used.

aDescription - The description of the EnumProperty

aConsumer - The Consumer being invoked in case this EnumProperty participated in successfully parsing the command line arguments.

Returns:

The accordingly created EnumProperty instance.

See Also:

• EnumProperty

enumProperty

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

Instantiates a new EnumProperty with the given arguments.

Type Parameters:

T - The generic type of the enumeration.

Parameters:

aLongOption - The long option to use.

aType - The type of the enumeration to be used.

aAlias - The alias to be used for naming purposes.

aDescription - The description of the EnumProperty

Returns:

The accordingly created EnumProperty instance.

See Also:

• EnumProperty

enumProperty

public static <T extends Enum<T>> EnumProperty<T> enumProperty(String aLongOption,
 Class<T> aType,
 String aAlias,
 String aDescription,
 Consumer<EnumProperty<T>> aConsumer)

Instantiates a new EnumProperty with the given arguments.

Type Parameters:

T - The generic type of the enumeration.

Parameters:

aLongOption - The long option to use.

aType - The type of the enumeration to be used.

aAlias - The alias to be used for naming purposes.

aDescription - The description of the EnumProperty

aConsumer - The Consumer being invoked in case this EnumProperty participated in successfully parsing the command line arguments.

Returns:

The accordingly created EnumProperty instance.

See Also:

• EnumProperty

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.

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.

fileOption

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

Instantiates a new FileOption with the given arguments. In case a long option is provided, the intance's alias will automatically be set with the long option, else the short option is used ass alias.

Parameters:

aShortOption - The short option to use.

aLongOption - The long option to use.

aDescription - The description of the FileOption

Returns:

The according FileOption.

See Also:

• FileOption

fileOption

public static FileOption fileOption(Character aShortOption,
 String aLongOption,
 String aDescription,
 Consumer<FileOption> aConsumer)

Instantiates a new FileOption with the given arguments. In case a long option is provided, the intance's alias will automatically be set with the long option, else the short option is used ass alias.

Parameters:

aShortOption - The short option to use.

aLongOption - The long option to use.

aDescription - The description of the FileOption

aConsumer - The Consumer being invoked in case this FileOption participated in successfully parsing the command line arguments.

Returns:

The according FileOption.

See Also:

• FileOption

fileOption

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

Instantiates a new FileOption with the given arguments.

Parameters:

aShortOption - The short option to use.

aLongOption - The long option to use.

aAlias - The alias to be used for naming purposes.

aDescription - The description of the FileOption

Returns:

The according FileOption.

See Also:

• FileOption

fileOption

public static FileOption fileOption(Character aShortOption,
 String aLongOption,
 String aAlias,
 String aDescription,
 Consumer<FileOption> aConsumer)

Instantiates a new FileOption with the given arguments.

Parameters:

aShortOption - The short option to use.

aLongOption - The long option to use.

aAlias - The alias to be used for naming purposes.

aDescription - The description of the FileOption

aConsumer - The Consumer being invoked in case this FileOption participated in successfully parsing the command line arguments.

Returns:

The according FileOption.

See Also:

• FileOption

fileOption

public static FileOption fileOption(String aLongOption,
 String aDescription)

Instantiates a new FileOption with the given arguments. In case a long option is provided, the intance's alias will automatically be set with the long option.

Parameters:

aLongOption - The long option to use.

aDescription - the description

Returns:

The according FileOption.

See Also:

• FileOption

fileOption

public static FileOption fileOption(String aLongOption,
 String aDescription,
 Consumer<FileOption> aConsumer)

Instantiates a new FileOption with the given arguments. In case a long option is provided, the intance's alias will automatically be set with the long option.

Parameters:

aLongOption - The long option to use.

aDescription - the description

aConsumer - The Consumer being invoked in case this FileOption participated in successfully parsing the command line arguments.

Returns:

The according FileOption.

See Also:

• FileOption

fileOption

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

Instantiates a new FileOption with the given arguments.

Parameters:

aLongOption - The long option to use.

aAlias - The alias to be used for naming purposes.

aDescription - The description of the FileOption

Returns:

The according FileOption.

See Also:

• FileOption

fileOption

public static FileOption fileOption(String aLongOption,
 String aAlias,
 String aDescription,
 Consumer<FileOption> aConsumer)

Instantiates a new FileOption with the given arguments.

Parameters:

aLongOption - The long option to use.

aAlias - The alias to be used for naming purposes.

aDescription - The description of the FileOption

aConsumer - The Consumer being invoked in case this FileOption participated in successfully parsing the command line arguments.

Returns:

The according FileOption.

See Also:

• FileOption

fileProperty

public static FileProperty fileProperty(Character aShortOption,
 String aLongOption,
 String aDescription)

Instantiates a new FileProperty with the given arguments. In case a long option is provided, the intance's alias will automatically be set with the long option, else the short option is used ass alias.

Parameters:

aShortOption - The short option to use.

aLongOption - The long option to use.

aDescription - The description of the FileProperty

Returns:

The according FileProperty.

See Also:

• FileProperty

fileProperty

public static FileProperty fileProperty(Character aShortOption,
 String aLongOption,
 String aDescription,
 Consumer<FileProperty> aConsumer)

Instantiates a new FileProperty with the given arguments. In case a long option is provided, the intance's alias will automatically be set with the long option, else the short option is used ass alias.

Parameters:

aShortOption - The short option to use.

aLongOption - The long option to use.

aDescription - The description of the FileProperty

aConsumer - The Consumer being invoked in case this FileProperty participated in successfully parsing the command line arguments.

Returns:

The according FileProperty.

See Also:

• FileProperty

fileProperty

public static FileProperty fileProperty(Character aShortOption,
 String aLongOption,
 String aAlias,
 String aDescription)

Instantiates a new FileProperty with the given arguments.

Parameters:

aShortOption - The short option to use.

aLongOption - The long option to use.

aAlias - The alias to be used for naming purposes.

aDescription - The description of the FileProperty

Returns:

The according FileProperty.

See Also:

• FileProperty

fileProperty

public static FileProperty fileProperty(Character aShortOption,
 String aLongOption,
 String aAlias,
 String aDescription,
 Consumer<FileProperty> aConsumer)

Instantiates a new FileProperty with the given arguments.

Parameters:

aShortOption - The short option to use.

aLongOption - The long option to use.

aAlias - The alias to be used for naming purposes.

aDescription - The description of the FileProperty

aConsumer - The Consumer being invoked in case this FileProperty participated in successfully parsing the command line arguments.

Returns:

The according FileProperty.

See Also:

• FileProperty

fileProperty

public static FileProperty fileProperty(String aLongOption,
 String aDescription)

Instantiates a new FileProperty with the given arguments. In case a long option is provided, the intance's alias will automatically be set with the long option.

Parameters:

aLongOption - The long option to use.

aDescription - the description

Returns:

The according FileProperty.

See Also:

• FileProperty

fileProperty

public static FileProperty fileProperty(String aLongOption,
 String aDescription,
 Consumer<FileProperty> aConsumer)

Instantiates a new FileProperty with the given arguments. In case a long option is provided, the intance's alias will automatically be set with the long option.

Parameters:

aLongOption - The long option to use.

aDescription - the description

aConsumer - The Consumer being invoked in case this FileProperty participated in successfully parsing the command line arguments.

Returns:

The according FileProperty.

See Also:

• FileProperty

fileProperty

public static FileProperty fileProperty(String aLongOption,
 String aAlias,
 String aDescription)

Instantiates a new FileProperty with the given arguments.

Parameters:

aLongOption - The long option to use.

aAlias - The alias to be used for naming purposes.

aDescription - The description of the FileProperty

Returns:

The according FileProperty.

See Also:

• FileProperty

fileProperty

public static FileProperty fileProperty(String aLongOption,
 String aAlias,
 String aDescription,
 Consumer<FileProperty> aConsumer)

Instantiates a new FileProperty with the given arguments.

Parameters:

aLongOption - The long option to use.

aAlias - The alias to be used for naming purposes.

aDescription - The description of the FileProperty

aConsumer - The Consumer being invoked in case this FileProperty participated in successfully parsing the command line arguments.

Returns:

The according FileProperty.

See Also:

• FileProperty

flag

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

Instantiates a new Flag with the given arguments. In case a long option is provided, the intance's alias will automatically be set with the long option, else the short option is used ass alias.

Parameters:

aShortOption - The short option to use.

aLongOption - The long option to use.

aDescription - The description of the Flag

Returns:

The accordingly created Flag instance.

See Also:

• Flag

flag

public static Flag flag(Character aShortOption,
 String aLongOption,
 String aDescription,
 Consumer<Flag> aConsumer)

Instantiates a new Flag with the given arguments. In case a long option is provided, the intance's alias will automatically be set with the long option, else the short option is used ass alias.

Parameters:

aShortOption - The short option to use.

aLongOption - The long option to use.

aDescription - The description of the Flag

aConsumer - The Consumer being invoked in case this Flag participated in successfully parsing the command line arguments.

Returns:

The accordingly created Flag instance.

See Also:

• Flag

flag

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

Instantiates a new Flag with the given arguments.

Parameters:

aShortOption - The short option to use.

aLongOption - The long option to use.

aAlias - The alias to be used for naming purposes.

aDescription - The description of the Flag

Returns:

The accordingly created Flag instance.

See Also:

• Flag

flag

public static Flag flag(Character aShortOption,
 String aLongOption,
 String aAlias,
 String aDescription,
 Consumer<Flag> aConsumer)

Instantiates a new Flag with the given arguments.

Parameters:

aShortOption - The short option to use.

aLongOption - The long option to use.

aAlias - The alias to be used for naming purposes.

aDescription - The description of the Flag

aConsumer - The Consumer being invoked in case this Flag participated in successfully parsing the command line arguments.

Returns:

The accordingly created Flag instance.

See Also:

• Flag

flag

public static Flag flag(String aLongOption,
 String aDescription)

Instantiates a new Flag with the given arguments. In case a long option is provided, the intance's alias will automatically be set with the long option.

Parameters:

aLongOption - The long option to use.

aDescription - The description of the Flag

Returns:

The accordingly created Flag instance.

See Also:

• Flag

flag

public static Flag flag(String aLongOption,
 String aDescription,
 Consumer<Flag> aConsumer)

Instantiates a new Flag with the given arguments. In case a long option is provided, the intance's alias will automatically be set with the long option.

Parameters:

aLongOption - The long option to use.

aDescription - The description of the Flag

aConsumer - The Consumer being invoked in case this Flag participated in successfully parsing the command line arguments.

Returns:

The accordingly created Flag instance.

See Also:

• Flag

flag

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

Instantiates a new Flag with the given arguments.

Parameters:

aLongOption - The long option to use.

aAlias - The alias to be used for naming purposes.

aDescription - The description of the Flag

Returns:

The accordingly created Flag instance.

See Also:

• Flag

flag

public static Flag flag(String aLongOption,
 String aAlias,
 String aDescription,
 Consumer<Flag> aConsumer)

Instantiates a new Flag with the given arguments.

Parameters:

aLongOption - The long option to use.

aAlias - The alias to be used for naming purposes.

aDescription - The description of the Flag

aConsumer - The Consumer being invoked in case this Flag participated in successfully parsing the command line arguments.

Returns:

The accordingly created Flag instance.

See Also:

• Flag

floatOption

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

Instantiates a new FloatOption with the given arguments. In case a long option is provided, the intance's alias will automatically be set with the long option, else the short option is used ass alias.

Parameters:

aShortOption - The short option to use.

aLongOption - The long option to use.

aDescription - The description of the FloatOption

Returns:

The accordingly created FloatOption instance.

See Also:

• FloatOption

floatOption

public static FloatOption floatOption(Character aShortOption,
 String aLongOption,
 String aDescription,
 Consumer<FloatOption> aConsumer)

Instantiates a new FloatOption with the given arguments. In case a long option is provided, the intance's alias will automatically be set with the long option, else the short option is used ass alias.

Parameters:

aShortOption - The short option to use.

aLongOption - The long option to use.

aDescription - The description of the FloatOption

aConsumer - The Consumer being invoked in case this FloatOption participated in successfully parsing the command line arguments.

Returns:

The accordingly created FloatOption instance.

See Also:

• FloatOption

floatOption

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

Instantiates a new FloatOption with the given arguments.

Parameters:

aShortOption - The short option to use.

aLongOption - The long option to use.

aAlias - The alias to be used for naming purposes.

aDescription - The description of the FloatOption

Returns:

The accordingly created FloatOption instance.

See Also:

• FloatOption

floatOption

public static FloatOption floatOption(Character aShortOption,
 String aLongOption,
 String aAlias,
 String aDescription,
 Consumer<FloatOption> aConsumer)

Instantiates a new FloatOption with the given arguments.

Parameters:

aShortOption - The short option to use.

aLongOption - The long option to use.

aAlias - The alias to be used for naming purposes.

aDescription - The description of the FloatOption

aConsumer - The Consumer being invoked in case this FloatOption participated in successfully parsing the command line arguments.

Returns:

The accordingly created FloatOption instance.

See Also:

• FloatOption

floatOption

public static FloatOption floatOption(String aLongOption,
 String aDescription)

Instantiates a new FloatOption with the given arguments. In case a long option is provided, the intance's alias will automatically be set with the long option.

Parameters:

aLongOption - The long option to use.

aDescription - The description of the FloatOption

Returns:

The accordingly created FloatOption instance.

See Also:

• FloatOption

floatOption

public static FloatOption floatOption(String aLongOption,
 String aDescription,
 Consumer<FloatOption> aConsumer)

Instantiates a new FloatOption with the given arguments. In case a long option is provided, the intance's alias will automatically be set with the long option.

Parameters:

aLongOption - The long option to use.

aDescription - The description of the FloatOption

aConsumer - The Consumer being invoked in case this FloatOption participated in successfully parsing the command line arguments.

Returns:

The accordingly created FloatOption instance.

See Also:

• FloatOption

floatOption

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

Instantiates a new FloatOption with the given arguments.

Parameters:

aLongOption - The long option to use.

aAlias - The alias to be used for naming purposes.

aDescription - The description of the FloatOption

Returns:

The accordingly created FloatOption instance.

See Also:

• FloatOption

floatOption

public static FloatOption floatOption(String aLongOption,
 String aAlias,
 String aDescription,
 Consumer<FloatOption> aConsumer)

Instantiates a new FloatOption with the given arguments.

Parameters:

aLongOption - The long option to use.

aAlias - The alias to be used for naming purposes.

aDescription - The description of the FloatOption

aConsumer - The Consumer being invoked in case this FloatOption participated in successfully parsing the command line arguments.

Returns:

The accordingly created FloatOption instance.

See Also:

• FloatOption

floatProperty

public static FloatProperty floatProperty(Character aShortOption,
 String aLongOption,
 String aDescription)

Instantiates a new FloatProperty with the given arguments. In case a long option is provided, the intance's alias will automatically be set with the long option, else the short option is used ass alias.

Parameters:

aShortOption - The short option to use.

aLongOption - the float property

aDescription - The description of the FloatProperty

Returns:

The accordingly created FloatProperty instance.

See Also:

• FloatProperty

floatProperty

public static FloatProperty floatProperty(Character aShortOption,
 String aLongOption,
 String aDescription,
 Consumer<FloatProperty> aConsumer)

Instantiates a new FloatProperty with the given arguments. In case a long option is provided, the intance's alias will automatically be set with the long option, else the short option is used ass alias.

Parameters:

aShortOption - The short option to use.

aLongOption - the float property

aDescription - The description of the FloatProperty

aConsumer - The Consumer being invoked in case this FloatProperty participated in successfully parsing the command line arguments.

Returns:

The accordingly created FloatProperty instance.

See Also:

• FloatProperty

floatProperty

public static FloatProperty floatProperty(Character aShortOption,
 String aLongOption,
 String aAlias,
 String aDescription)

Instantiates a new FloatProperty with the given arguments.

Parameters:

aShortOption - The short option to use.

aLongOption - The long option to use.

aAlias - The alias to be used for naming purposes.

aDescription - The description of the FloatProperty

Returns:

The accordingly created FloatProperty instance.

See Also:

• FloatProperty

floatProperty

public static FloatProperty floatProperty(Character aShortOption,
 String aLongOption,
 String aAlias,
 String aDescription,
 Consumer<FloatProperty> aConsumer)

Instantiates a new FloatProperty with the given arguments.

Parameters:

aShortOption - The short option to use.

aLongOption - The long option to use.

aAlias - The alias to be used for naming purposes.

aDescription - The description of the FloatProperty

aConsumer - The Consumer being invoked in case this FloatProperty participated in successfully parsing the command line arguments.

Returns:

The accordingly created FloatProperty instance.

See Also:

• FloatProperty

floatProperty

public static FloatProperty floatProperty(String aLongOption,
 String aDescription)

Instantiates a new FloatProperty with the given arguments. In case a long option is provided, the intance's alias will automatically be set with the long option.

Parameters:

aLongOption - The long option to use.

aDescription - The description of the FloatProperty

Returns:

The accordingly created FloatProperty instance.

See Also:

• FloatProperty

floatProperty

public static FloatProperty floatProperty(String aLongOption,
 String aDescription,
 Consumer<FloatProperty> aConsumer)

Instantiates a new FloatProperty with the given arguments. In case a long option is provided, the intance's alias will automatically be set with the long option.

Parameters:

aLongOption - The long option to use.

aDescription - The description of the FloatProperty

aConsumer - The Consumer being invoked in case this FloatProperty participated in successfully parsing the command line arguments.

Returns:

The accordingly created FloatProperty instance.

See Also:

• FloatProperty

floatProperty

public static FloatProperty floatProperty(String aLongOption,
 String aAlias,
 String aDescription)

Instantiates a new FloatProperty with the given arguments.

Parameters:

aLongOption - The long option to use.

aAlias - The alias to be used for naming purposes.

aDescription - The description of the FloatProperty

Returns:

The accordingly created FloatProperty instance.

See Also:

• FloatProperty

floatProperty

public static FloatProperty floatProperty(String aLongOption,
 String aAlias,
 String aDescription,
 Consumer<FloatProperty> aConsumer)

Instantiates a new FloatProperty with the given arguments.

Parameters:

aLongOption - The long option to use.

aAlias - The alias to be used for naming purposes.

aDescription - The description of the FloatProperty

aConsumer - The Consumer being invoked in case this FloatProperty participated in successfully parsing the command line arguments.

Returns:

The accordingly created FloatProperty instance.

See Also:

• FloatProperty

forceFlag

public static ForceFlag forceFlag()

Constructs the predefined force Flag.

Returns:

The accordingly created Flag instance.

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 accordingly created Flag instance.

See Also:

• ForceFlag

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 accordingly created Flag instance.

See Also:

• ForceFlag

helpFlag

public static HelpFlag helpFlag()

Constructs the predefined help Flag.

Returns:

The accordingly created Flag instance.

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 accordingly created Flag instance.

See Also:

• HelpFlag

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 accordingly created Flag instance.

See Also:

• HelpFlag

initFlag

public static InitFlag initFlag()

Constructs the predefined init Flag.

Returns:

The accordingly created Flag instance.

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 accordingly created Flag instance.

See Also:

• InitFlag

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 accordingly created Flag instance.

See Also:

• InitFlag

intOption

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

Instantiates a new IntOption with the given arguments. In case a long option is provided, the intance's alias will automatically be set with the long option, else the short option is used ass alias.

Parameters:

aShortOption - The short option to use.

aLongOption - The long option to use.

aDescription - The description of the IntOption

Returns:

The accordingly created IntOption instance.

See Also:

• IntOption

intOption

public static IntOption intOption(Character aShortOption,
 String aLongOption,
 String aDescription,
 Consumer<IntOption> aConsumer)

Instantiates a new IntOption with the given arguments. In case a long option is provided, the intance's alias will automatically be set with the long option, else the short option is used ass alias.

Parameters:

aShortOption - The short option to use.

aLongOption - The long option to use.

aDescription - The description of the IntOption

aConsumer - The Consumer being invoked in case this IntOption participated in successfully parsing the command line arguments.

Returns:

The accordingly created IntOption instance.

See Also:

• IntOption

intOption

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

Instantiates a new IntOption with the given arguments.

Parameters:

aShortOption - The short option to use.

aLongOption - The long option to use.

aAlias - The alias to be used for naming purposes.

aDescription - The description of the IntOption

Returns:

The accordingly created IntOption instance.

See Also:

• IntOption

intOption

public static IntOption intOption(Character aShortOption,
 String aLongOption,
 String aAlias,
 String aDescription,
 Consumer<IntOption> aConsumer)

Instantiates a new IntOption with the given arguments.

Parameters:

aShortOption - The short option to use.

aLongOption - The long option to use.

aAlias - The alias to be used for naming purposes.

aDescription - The description of the IntOption

aConsumer - The Consumer being invoked in case this IntOption participated in successfully parsing the command line arguments.

Returns:

The accordingly created IntOption instance.

See Also:

• IntOption

intOption

public static IntOption intOption(String aLongOption,
 String aDescription)

Instantiates a new IntOption with the given arguments. In case a long option is provided, the intance's alias will automatically be set with the long option.

Parameters:

aLongOption - The long option to use.

aDescription - The description of the IntOption

Returns:

The accordingly created IntOption instance.

See Also:

• IntOption

intOption

public static IntOption intOption(String aLongOption,
 String aDescription,
 Consumer<IntOption> aConsumer)

Instantiates a new IntOption with the given arguments. In case a long option is provided, the intance's alias will automatically be set with the long option.

Parameters:

aLongOption - The long option to use.

aDescription - The description of the IntOption

aConsumer - The Consumer being invoked in case this IntOption participated in successfully parsing the command line arguments.

Returns:

The accordingly created IntOption instance.

See Also:

• IntOption

intOption

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

Instantiates a new IntOption with the given arguments.

Parameters:

aLongOption - The long option to use.

aAlias - The alias to be used for naming purposes.

aDescription - The description of the IntOption

Returns:

The accordingly created IntOption instance.

See Also:

• IntOption

intOption

public static IntOption intOption(String aLongOption,
 String aAlias,
 String aDescription,
 Consumer<IntOption> aConsumer)

Instantiates a new IntOption with the given arguments.

Parameters:

aLongOption - The long option to use.

aAlias - The alias to be used for naming purposes.

aDescription - The description of the IntOption

aConsumer - The Consumer being invoked in case this IntOption participated in successfully parsing the command line arguments.

Returns:

The accordingly created IntOption instance.

See Also:

• IntOption

intProperty

public static IntProperty intProperty(Character aShortOption,
 String aLongOption,
 String aDescription)

Instantiates a new IntProperty with the given arguments. In case a long option is provided, the intance's alias will automatically be set with the long option, else the short option is used ass alias.

Parameters:

aShortOption - The short option to use.

aLongOption - The long option to use.

aDescription - The description of the IntProperty

Returns:

The accordingly created IntProperty instance.

See Also:

• IntProperty

intProperty

public static IntProperty intProperty(Character aShortOption,
 String aLongOption,
 String aDescription,
 Consumer<IntProperty> aConsumer)

Instantiates a new IntProperty with the given arguments. In case a long option is provided, the intance's alias will automatically be set with the long option, else the short option is used ass alias.

Parameters:

aShortOption - The short option to use.

aLongOption - The long option to use.

aDescription - The description of the IntProperty

aConsumer - The Consumer being invoked in case this IntProperty participated in successfully parsing the command line arguments.

Returns:

The accordingly created IntProperty instance.

See Also:

• IntProperty

intProperty

public static IntProperty intProperty(Character aShortOption,
 String aLongOption,
 String aAlias,
 String aDescription)

Instantiates a new IntProperty with the given arguments.

Parameters:

aShortOption - The short option to use.

aLongOption - The long option to use.

aAlias - The alias to be used for naming purposes.

aDescription - The description of the IntProperty

Returns:

The accordingly created IntProperty instance.

See Also:

• IntProperty

intProperty

public static IntProperty intProperty(Character aShortOption,
 String aLongOption,
 String aAlias,
 String aDescription,
 Consumer<IntProperty> aConsumer)

Instantiates a new IntProperty with the given arguments.

Parameters:

aShortOption - The short option to use.

aLongOption - The long option to use.

aAlias - The alias to be used for naming purposes.

aDescription - The description of the IntProperty

aConsumer - The Consumer being invoked in case this IntProperty participated in successfully parsing the command line arguments.

Returns:

The accordingly created IntProperty instance.

See Also:

• IntProperty

intProperty

public static IntProperty intProperty(String aLongOption,
 String aDescription)

Instantiates a new IntProperty with the given arguments. In case a long option is provided, the intance's alias will automatically be set with the long option.

Parameters:

aLongOption - The long option to use.

aDescription - The description of the IntProperty

Returns:

The accordingly created IntProperty instance.

See Also:

• IntProperty

intProperty

public static IntProperty intProperty(String aLongOption,
 String aDescription,
 Consumer<IntProperty> aConsumer)

Instantiates a new IntProperty with the given arguments. In case a long option is provided, the intance's alias will automatically be set with the long option.

Parameters:

aLongOption - The long option to use.

aDescription - The description of the IntProperty

aConsumer - The Consumer being invoked in case this IntProperty participated in successfully parsing the command line arguments.

Returns:

The accordingly created IntProperty instance.

See Also:

• IntProperty

intProperty

public static IntProperty intProperty(String aLongOption,
 String aAlias,
 String aDescription)

Instantiates a new IntProperty with the given arguments.

Parameters:

aLongOption - The long option to use.

aAlias - The alias to be used for naming purposes.

aDescription - The description of the IntProperty

Returns:

The accordingly created IntProperty instance.

See Also:

• IntProperty

intProperty

public static IntProperty intProperty(String aLongOption,
 String aAlias,
 String aDescription,
 Consumer<IntProperty> aConsumer)

Instantiates a new IntProperty with the given arguments.

Parameters:

aLongOption - The long option to use.

aAlias - The alias to be used for naming purposes.

aDescription - The description of the IntProperty

aConsumer - The Consumer being invoked in case this IntProperty participated in successfully parsing the command line arguments.

Returns:

The accordingly created IntProperty instance.

See Also:

• IntProperty

longOption

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

Instantiates a new LongOption with the given arguments. In case a long option is provided, the intance's alias will automatically be set with the long option, else the short option is used ass alias.

Parameters:

aShortOption - The short option to use.

aLongOption - The long option to use.

aDescription - The description of the LongOption

Returns:

The accordingly created LongOption instance.

See Also:

• LongOption

longOption

public static LongOption longOption(Character aShortOption,
 String aLongOption,
 String aDescription,
 Consumer<LongOption> aConsumer)

Instantiates a new LongOption with the given arguments. In case a long option is provided, the intance's alias will automatically be set with the long option, else the short option is used ass alias.

Parameters:

aShortOption - The short option to use.

aLongOption - The long option to use.

aDescription - The description of the LongOption

aConsumer - The Consumer being invoked in case this LongOption participated in successfully parsing the command line arguments.

Returns:

The accordingly created LongOption instance.

See Also:

• LongOption

longOption

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

Instantiates a new LongOption with the given arguments.

Parameters:

aShortOption - The short option to use.

aLongOption - The long option to use.

aAlias - The alias to be used for naming purposes.

aDescription - The description of the LongOption

Returns:

The accordingly created LongOption instance.

See Also:

• LongOption

longOption

public static LongOption longOption(Character aShortOption,
 String aLongOption,
 String aAlias,
 String aDescription,
 Consumer<LongOption> aConsumer)

Instantiates a new LongOption with the given arguments.

Parameters:

aShortOption - The short option to use.

aLongOption - The long option to use.

aAlias - The alias to be used for naming purposes.

aDescription - The description of the LongOption

aConsumer - The Consumer being invoked in case this LongOption participated in successfully parsing the command line arguments.

Returns:

The accordingly created LongOption instance.

See Also:

• LongOption

longOption

public static LongOption longOption(String aLongOption,
 String aDescription)

Instantiates a new LongOption with the given arguments. In case a long option is provided, the intance's alias will automatically be set with the long option.

Parameters:

aLongOption - The long option to use.

aDescription - The description of the LongOption

Returns:

The accordingly created LongOption instance.

See Also:

• LongOption

longOption

public static LongOption longOption(String aLongOption,
 String aDescription,
 Consumer<LongOption> aConsumer)

Instantiates a new LongOption with the given arguments. In case a long option is provided, the intance's alias will automatically be set with the long option.

Parameters:

aLongOption - The long option to use.

aDescription - The description of the LongOption

aConsumer - The Consumer being invoked in case this LongOption participated in successfully parsing the command line arguments.

Returns:

The accordingly created LongOption instance.

See Also:

• LongOption

longOption

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

Instantiates a new LongOption with the given arguments.

Parameters:

aLongOption - The long option to use.

aAlias - The alias to be used for naming purposes.

aDescription - The description of the LongOption

Returns:

The accordingly created LongOption instance.

See Also:

• LongOption

longOption

public static LongOption longOption(String aLongOption,
 String aAlias,
 String aDescription,
 Consumer<LongOption> aConsumer)

Instantiates a new LongOption with the given arguments.

Parameters:

aLongOption - The long option to use.

aAlias - The alias to be used for naming purposes.

aDescription - The description of the LongOption

aConsumer - The Consumer being invoked in case this LongOption participated in successfully parsing the command line arguments.

Returns:

The accordingly created LongOption instance.

See Also:

• LongOption

longProperty

public static LongProperty longProperty(Character aShortOption,
 String aLongOption,
 String aDescription)

Instantiates a new LongProperty with the given arguments. In case a long option is provided, the intance's alias will automatically be set with the long option, else the short option is used ass alias.

Parameters:

aShortOption - The short option to use.

aLongOption - The long option to use.

aDescription - The description of the LongProperty

Returns:

The accordingly created LongProperty instance.

See Also:

• LongProperty

longProperty

public static LongProperty longProperty(Character aShortOption,
 String aLongOption,
 String aDescription,
 Consumer<LongProperty> aConsumer)

Instantiates a new LongProperty with the given arguments. In case a long option is provided, the intance's alias will automatically be set with the long option, else the short option is used ass alias.

Parameters:

aShortOption - The short option to use.

aLongOption - The long option to use.

aDescription - The description of the LongProperty

aConsumer - The Consumer being invoked in case this LongProperty participated in successfully parsing the command line arguments.

Returns:

The accordingly created LongProperty instance.

See Also:

• LongProperty

longProperty

public static LongProperty longProperty(Character aShortOption,
 String aLongOption,
 String aAlias,
 String aDescription)

Instantiates a new LongProperty with the given arguments.

Parameters:

aShortOption - The short option to use.

aLongOption - The long option to use.

aAlias - The alias to be used for naming purposes.

aDescription - The description of the LongProperty

Returns:

The accordingly created LongProperty instance.

See Also:

• LongProperty

longProperty

public static LongProperty longProperty(Character aShortOption,
 String aLongOption,
 String aAlias,
 String aDescription,
 Consumer<LongProperty> aConsumer)

Instantiates a new LongProperty with the given arguments.

Parameters:

aShortOption - The short option to use.

aLongOption - The long option to use.

aAlias - The alias to be used for naming purposes.

aDescription - The description of the LongProperty

aConsumer - The Consumer being invoked in case this LongProperty participated in successfully parsing the command line arguments.

Returns:

The accordingly created LongProperty instance.

See Also:

• LongProperty

longProperty

public static LongProperty longProperty(String aLongOption,
 String aDescription)

Instantiates a new LongProperty with the given arguments. In case a long option is provided, the intance's alias will automatically be set with the long option.

Parameters:

aLongOption - The long option to use.

aDescription - The description of the LongProperty

Returns:

The accordingly created LongProperty instance.

See Also:

• LongProperty

longProperty

public static LongProperty longProperty(String aLongOption,
 String aDescription,
 Consumer<LongProperty> aConsumer)

Instantiates a new LongProperty with the given arguments. In case a long option is provided, the intance's alias will automatically be set with the long option.

Parameters:

aLongOption - The long option to use.

aDescription - The description of the LongProperty

aConsumer - The Consumer being invoked in case this LongProperty participated in successfully parsing the command line arguments.

Returns:

The accordingly created LongProperty instance.

See Also:

• LongProperty

longProperty

public static LongProperty longProperty(String aLongOption,
 String aAlias,
 String aDescription)

Instantiates a new LongProperty with the given arguments.

Parameters:

aLongOption - The long option to use.

aAlias - The alias to be used for naming purposes.

aDescription - The description of the LongProperty

Returns:

The accordingly created LongProperty instance.

See Also:

• LongProperty

longProperty

public static LongProperty longProperty(String aLongOption,
 String aAlias,
 String aDescription,
 Consumer<LongProperty> aConsumer)

Instantiates a new LongProperty with the given arguments.

Parameters:

aLongOption - The long option to use.

aAlias - The alias to be used for naming purposes.

aDescription - The description of the LongProperty

aConsumer - The Consumer being invoked in case this LongProperty participated in successfully parsing the command line arguments.

Returns:

The accordingly created LongProperty instance.

See Also:

• LongProperty

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 accordingly created NoneOperand.

See Also:

• NoneOperand

none

public static NoneOperand none(String aDescription)

Instantiates a new NoneOperand.

Parameters:

aDescription - The description to be used (without any line breaks).

Returns:

The accordingly created NoneOperand.

See Also:

• NoneOperand

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 Term.toSyntax(CliContext) method.

aDescription - The description to be used (without any line breaks).

Returns:

The accordingly created NoneOperand.

See Also:

• NoneOperand

none

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

Instantiates a new NoneOperand.

Parameters:

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

aConsumer - The Consumer being invoked in case this NoneOperand participated in successfully parsing the command line arguments.

Returns:

The accordingly created NoneOperand.

See Also:

• NoneOperand

none

public static NoneOperand none(String aDescription,
 Consumer<NoneOperand> aConsumer)

Instantiates a new NoneOperand.

Parameters:

aDescription - The description to be used (without any line breaks).

aConsumer - The Consumer being invoked in case this NoneOperand participated in successfully parsing the command line arguments.

Returns:

The accordingly created NoneOperand.

See Also:

• NoneOperand

none

public static NoneOperand none(String aAlias,
 String aDescription,
 Consumer<NoneOperand> aConsumer)

Instantiates a new NoneOperand.

Parameters:

aAlias - The identifier to be used when printing the syntax via the Term.toSyntax(CliContext) method.

aDescription - The description to be used (without any line breaks).

aConsumer - The Consumer being invoked in case this NoneOperand participated in successfully parsing the command line arguments.

Returns:

The accordingly created NoneOperand.

See Also:

• NoneOperand

operation

public static Operation operation(String aOperation,
 String aDescription)

Constructs a Operation with the given arguments.

Parameters:

aOperation - The operation to declare.

aDescription - The description to be used (without any line breaks).

Returns:

The accordingly created Operation.

operation

public static Operation operation(String aOperation,
 String aDescription,
 Consumer<Operation> aConsumer)

Constructs a Operation with the given arguments.

Parameters:

aOperation - The operation to declare.

aDescription - The description to be used (without any line breaks).

aConsumer - The Consumer being invoked in case this Operation participated in successfully parsing the command line arguments.

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 - The description to be used (without any line breaks).

Returns:

The accordingly created Operation.

operation

public static Operation operation(String aOperation,
 String aAlias,
 String aDescription,
 Consumer<Operation> aConsumer)

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 - The description to be used (without any line breaks).

aConsumer - The Consumer being invoked in case this Operation participated in successfully parsing the command line arguments.

Returns:

The accordingly created Operation.

optional

public static AnyCondition optional(Term... aArgs)

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

Parameters:

aArgs - The Term (Condition) instances to be nested

Returns:

The according AbstractCondition.

See Also:

• AnyCondition

or

public static OrCondition or(Term... aArgs)

Instantiates a new OrCondition with the Term (Condition) instances to be nested.

Parameters:

aArgs - The Term (Condition) instances to be nested.

Returns:

The according OR condition.

See Also:

• OrCondition

quietFlag

public static QuietFlag quietFlag()

Constructs the predefined quiet Flag.

Returns:

The accordingly created Flag instance.

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 accordingly created Flag instance.

See Also:

• QuietFlag

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 accordingly created Flag instance.

See Also:

• QuietFlag

stringOperand

public static StringOperand stringOperand(String aAlias,
 String aDescription)

Instantiates a new StringOperand.

Parameters:

aAlias - The alias to be used for naming purposes.

aDescription - The description to be used (without any line breaks).

Returns:

The according StringOperand.

See Also:

• StringOperand

stringOperand

public static StringOperand stringOperand(String aAlias,
 String aDescription,
 Consumer<StringOperand> aConsumer)

Instantiates a new StringOperand.

Parameters:

aAlias - The alias to be used for naming purposes.

aDescription - The description to be used (without any line breaks).

aConsumer - The Consumer being invoked in case this StringOperand participated in successfully parsing the command line arguments.

Returns:

The according StringOperand.

See Also:

• StringOperand

stringOption

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

Instantiates a new StringOption with the given arguments. In case a long option is provided, the intance's alias will automatically be set with the long option, else the short option is used ass alias.

Parameters:

aShortOption - The short option to use.

aLongOption - the string option

aDescription - The description of the StringOption

Returns:

The accordingly created StringOption instance.

See Also:

• StringOption

stringOption

public static StringOption stringOption(Character aShortOption,
 String aLongOption,
 String aDescription,
 Consumer<StringOption> aConsumer)

Instantiates a new StringOption with the given arguments. In case a long option is provided, the intance's alias will automatically be set with the long option, else the short option is used ass alias.

Parameters:

aShortOption - The short option to use.

aLongOption - the string option

aDescription - The description of the StringOption

aConsumer - The Consumer being invoked in case this StringOption participated in successfully parsing the command line arguments.

Returns:

The accordingly created StringOption instance.

See Also:

• StringOption

stringOption

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

Instantiates a new StringOption with the given arguments.

Parameters:

aShortOption - The short option to use.

aLongOption - The long option to use.

aAlias - The alias to be used for naming purposes.

aDescription - The description of the StringOption

Returns:

The accordingly created StringOption instance.

See Also:

• StringOption

stringOption

public static StringOption stringOption(Character aShortOption,
 String aLongOption,
 String aAlias,
 String aDescription,
 Consumer<StringOption> aConsumer)

Instantiates a new StringOption with the given arguments. In case a long option is provided, the intance's alias will automatically be set with the long option, else the short option is used ass alias.

Parameters:

aShortOption - The short option to use.

aLongOption - the string option

aAlias - The alias to be used for naming purposes.

aDescription - The description of the StringOption

aConsumer - The Consumer being invoked in case this StringOption participated in successfully parsing the command line arguments.

Returns:

The accordingly created StringOption instance.

See Also:

• StringOption

stringOption

public static StringOption stringOption(String aLongOption,
 String aDescription)

Instantiates a new StringOption with the given arguments. In case a long option is provided, the intance's alias will automatically be set with the long option.

Parameters:

aLongOption - The long option to use.

aDescription - The description of the StringOption

Returns:

The accordingly created StringOption instance.

See Also:

• StringOption

stringOption

public static StringOption stringOption(String aLongOption,
 String aDescription,
 Consumer<StringOption> aConsumer)

Instantiates a new StringOption with the given arguments. In case a long option is provided, the intance's alias will automatically be set with the long option.

Parameters:

aLongOption - The long option to use.

aDescription - The description of the StringOption

aConsumer - The Consumer being invoked in case this StringOption participated in successfully parsing the command line arguments.

Returns:

The accordingly created StringOption instance.

See Also:

• StringOption

stringOption

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

Instantiates a new StringOption with the given arguments.

Parameters:

aLongOption - The long option to use.

aAlias - The alias to be used for naming purposes.

aDescription - The description of the StringOption

Returns:

The accordingly created StringOption instance.

See Also:

• StringOption

stringOption

public static StringOption stringOption(String aLongOption,
 String aAlias,
 String aDescription,
 Consumer<StringOption> aConsumer)

Instantiates a new StringOption with the given arguments.

Parameters:

aLongOption - The long option to use.

aAlias - The alias to be used for naming purposes.

aDescription - The description of the StringOption

aConsumer - The Consumer being invoked in case this StringOption participated in successfully parsing the command line arguments.

Returns:

The accordingly created StringOption instance.

See Also:

• StringOption

stringProperty

public static StringProperty stringProperty(Character aShortOption,
 String aLongOption,
 String aDescription)

Instantiates a new StringProperty with the given arguments. In case a long option is provided, the intance's alias will automatically be set with the long option, else the short option is used ass alias.

Parameters:

aShortOption - The short option to use.

aLongOption - The long option to use.

aDescription - The description of the StringProperty

Returns:

The accordingly created StringProperty instance.

See Also:

• StringProperty

stringProperty

public static StringProperty stringProperty(Character aShortOption,
 String aLongOption,
 String aDescription,
 Consumer<StringProperty> aConsumer)

Instantiates a new StringProperty with the given arguments. In case a long option is provided, the intance's alias will automatically be set with the long option, else the short option is used ass alias.

Parameters:

aShortOption - The short option to use.

aLongOption - The long option to use.

aDescription - The description of the StringProperty

aConsumer - The Consumer being invoked in case this StringProperty participated in successfully parsing the command line arguments.

Returns:

The accordingly created StringProperty instance.

See Also:

• StringProperty

stringProperty

public static StringProperty stringProperty(Character aShortOption,
 String aLongOption,
 String aAlias,
 String aDescription)

Instantiates a new StringProperty with the given arguments.

Parameters:

aShortOption - The short option to use.

aLongOption - The long option to use.

aAlias - The alias to be used for naming purposes.

aDescription - The description of the StringProperty

Returns:

The accordingly created StringProperty instance.

See Also:

• StringProperty

stringProperty

public static StringProperty stringProperty(Character aShortOption,
 String aLongOption,
 String aAlias,
 String aDescription,
 Consumer<StringProperty> aConsumer)

Instantiates a new StringProperty with the given arguments.

Parameters:

aShortOption - The short option to use.

aLongOption - The long option to use.

aAlias - The alias to be used for naming purposes.

aDescription - The description of the StringProperty

aConsumer - The Consumer being invoked in case this StringProperty participated in successfully parsing the command line arguments.

Returns:

The accordingly created StringProperty instance.

See Also:

• StringProperty

stringProperty

public static StringProperty stringProperty(String aLongOption,
 String aDescription)

Instantiates a new StringProperty with the given arguments. In case a long option is provided, the intance's alias will automatically be set with the long option.

Parameters:

aLongOption - The long option to use.

aDescription - The description of the StringProperty

Returns:

The accordingly created StringProperty instance.

See Also:

• StringProperty

stringProperty

public static StringProperty stringProperty(String aLongOption,
 String aDescription,
 Consumer<StringProperty> aConsumer)

Instantiates a new StringProperty with the given arguments. In case a long option is provided, the intance's alias will automatically be set with the long option.

Parameters:

aLongOption - The long option to use.

aDescription - The description of the StringProperty

aConsumer - The Consumer being invoked in case this StringProperty participated in successfully parsing the command line arguments.

Returns:

The accordingly created StringProperty instance.

See Also:

• StringProperty

stringProperty

public static StringProperty stringProperty(String aLongOption,
 String aAlias,
 String aDescription)

Instantiates a new StringProperty with the given arguments.

Parameters:

aLongOption - The long option to use.

aAlias - The alias to be used for naming purposes.

aDescription - The description of the StringProperty

Returns:

The accordingly created StringProperty instance.

See Also:

• StringProperty

stringProperty

public static StringProperty stringProperty(String aLongOption,
 String aAlias,
 String aDescription,
 Consumer<StringProperty> aConsumer)

Instantiates a new StringProperty with the given arguments.

Parameters:

aLongOption - The long option to use.

aAlias - The alias to be used for naming purposes.

aDescription - The description of the StringProperty

aConsumer - The Consumer being invoked in case this StringProperty participated in successfully parsing the command line arguments.

Returns:

The accordingly created StringProperty instance.

See Also:

• StringProperty

sysInfoFlag

public static SysInfoFlag sysInfoFlag()

Constructs the predefined system info Flag.

Returns:

The accordingly created Flag instance.

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 accordingly created Flag instance.

See Also:

• SysInfoFlag

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 accordingly created Flag instance.

See Also:

• SysInfoFlag

verboseFlag

public static VerboseFlag verboseFlag()

Constructs the predefined verbose Flag.

Returns:

The accordingly created Flag instance.

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 accordingly created Flag instance.

See Also:

• VerboseFlag

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 accordingly created Flag instance.

See Also:

• VerboseFlag

xor

public static XorCondition xor(Term... aArgs)

Instantiates a new XorCondition with the Term (Condition) instances to be nested.

Parameters:

aArgs - The Term (Condition) instances to be nested.

Returns:

The according XOR condition.

See Also:

• XorCondition