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.

  • Constructor Details

    • CliSugar

      public CliSugar()

  • Method Details

    • examples

      public static Example[] examples(Example... aExamples)
      Sugar for creating an Example array from a varargs argument.
      Parameters:
      aExamples - the Example varargs argument.
      Returns:
      The according array representation.

    • example

      public static Example example(String aDescription, Operand<?>... aOperands)
      Sugar for creating an Example from a description and the according Operand elements.
      Parameters:
      aDescription - The explanatory text of the example.
      aOperands - The operands required for the Example.
      Returns:
      The according Example instance.

    • operation

      public static Operation operation(String aOperation, String aDescription)
      Constructs a Operation with the given arguments.
      Parameters:
      aOperation - The operation to declare.
      aDescription - 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)
      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.

    • and

      public static Condition and(Constituent... aArgs)
      Instantiates a new AndCondition with the Constituent (Condition) instances to be nested.
      Parameters:
      aArgs - The Constituent (Condition) instances to be nested.
      Returns:
      The according AND condition.
      See Also:

    • all

      public static Condition all(Constituent aArg)
      Instantiates a new AllCondition with the Constituent (Condition) instance to be nested.
      Parameters:
      aArg - The Constituent (Condition) instance to be nested.
      Returns:
      The according ALL condition.
      See Also:

    • or

      public static Condition or(Constituent... aArgs)
      Instantiates a new OrCondition with the Constituent (Condition) instances to be nested.
      Parameters:
      aArgs - The Constituent (Condition) instances to be nested.
      Returns:
      The according OR condition.
      See Also:

    • xor

      public static Condition xor(Constituent... aArgs)
      Instantiates a new XorCondition with the Constituent (Condition) instances to be nested.
      Parameters:
      aArgs - The Constituent (Condition) instances to be nested.
      Returns:
      The according XOR condition.
      See Also:

    • cases

      public static Condition cases(Constituent... aArgs)
      Instantiates a new CasesCondition with the Constituent (Condition) instances to be nested.
      Parameters:
      aArgs - The Constituent (Condition) instances to be nested.
      Returns:
      The according CasesCondition (https://www.metacodes.pro XOR) condition.
      See Also:

    • any

      public static Condition any(Constituent... aArgs)
      Instantiates a new AnyCondition with the Constituent (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 Constituent (Condition) instances to be nested
      Returns:
      The according AbstractCondition.
      See Also:

    • optional

      public static Condition optional(Constituent... aArgs)
      Semantically identical synonym for the optional(Constituent...) declaration.
      Parameters:
      aArgs - The Constituent (Condition) instances to be nested
      Returns:
      The according AbstractCondition.
      See Also:

    • 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 Constituent.toSyntax(CliContext) method.
      aDescription - The description to be used (without any line breaks).
      Returns:
      the none operand
      See Also:

    • none

      public static NoneOperand none(String aDescription)
      Instantiates a new NoneOperand.
      Parameters:
      aDescription - The description to be used (without any line breaks).
      Returns:
      the none operand
      See Also:

    • none

      public static NoneOperand none(org.refcodes.struct.Relation<String,Boolean> aProperty)
      Instantiates a new NoneOperand.
      Parameters:
      aProperty - The key (= alias) and the value for the operand.
      Returns:
      the none operand
      See Also:

    • 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

      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

      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

      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:

    • 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

      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

      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

      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:

    • 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

      public static DaemonFlag daemonFlag()
      Constructs the predefined daemon Flag.
      Returns:
      The accordingly created Flag instance.
      See Also:

    • 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:

    • 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

      public static ForceFlag forceFlag()
      Constructs the predefined force Flag.
      Returns:
      The accordingly created Flag instance.
      See Also:

    • 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:

    • 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

      public static HelpFlag helpFlag()
      Constructs the predefined help Flag.
      Returns:
      The accordingly created Flag instance.
      See Also:

    • 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:

    • 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

      public static InitFlag initFlag()
      Constructs the predefined init Flag.
      Returns:
      The accordingly created Flag instance.
      See Also:

    • 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:

    • 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

      public static CleanFlag cleanFlag()
      Constructs the predefined clean Flag.
      Returns:
      The accordingly created Flag instance.
      See Also:

    • 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:

    • 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

      public static SysInfoFlag sysInfoFlag()
      Constructs the predefined system info Flag.
      Returns:
      The accordingly created Flag instance.
      See Also:

    • 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:

    • 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

      public static QuietFlag quietFlag()
      Constructs the predefined quiet Flag.
      Returns:
      The accordingly created Flag instance.
      See Also:

    • 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:

    • 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

      public static VerboseFlag verboseFlag()
      Constructs the predefined verbose Flag.
      Returns:
      The accordingly created Flag instance.
      See Also:

    • 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:

    • 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

      public static DebugFlag debugFlag()
      Constructs the predefined debug Flag.
      Returns:
      The accordingly created Flag instance.
      See Also:

    • 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:

    • 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

      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

      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

      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:

    • 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

      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

      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

      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:

    • floatOption

      public static FloatOption floatOption(String aFloatOption, String aAlias, String aDescription)
      Instantiates a new FloatOption with the given arguments.
      Parameters:
      aFloatOption - 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

      public static FloatOption floatOption(String aFloatOption, 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:
      aFloatOption - The long option to use.
      aDescription - The description of the FloatOption
      Returns:
      The accordingly created FloatOption instance.
      See Also:

    • floatOption

      public static FloatOption floatOption(Character aShortOption, String aFloatOption, String aAlias, String aDescription)
      Instantiates a new FloatOption with the given arguments.
      Parameters:
      aShortOption - The short option to use.
      aFloatOption - 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

      public static FloatOption floatOption(Character aShortOption, String aFloatOption, 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.
      aFloatOption - the float option
      aDescription - The description of the FloatOption
      Returns:
      The accordingly created FloatOption instance.
      See Also:

    • doubleOption

      public static DoubleOption doubleOption(String aDoubleOption, String aAlias, String aDescription)
      Instantiates a new DoubleOption with the given arguments.
      Parameters:
      aDoubleOption - 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

      public static DoubleOption doubleOption(String aDoubleOption, 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:
      aDoubleOption - The long option to use.
      aDescription - The description of the DoubleOption
      Returns:
      The accordingly created DoubleOption instance.
      See Also:

    • doubleOption

      public static DoubleOption doubleOption(Character aShortOption, String aDoubleOption, String aAlias, String aDescription)
      Instantiates a new DoubleOption with the given arguments.
      Parameters:
      aShortOption - The short option to use.
      aDoubleOption - 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

      public static DoubleOption doubleOption(Character aShortOption, String aDoubleOption, 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.
      aDoubleOption - the double option
      aDescription - The description of the DoubleOption
      Returns:
      The accordingly created DoubleOption instance.
      See Also:

    • stringOption

      public static StringOption stringOption(String aStringOption, String aAlias, String aDescription)
      Instantiates a new StringOption with the given arguments.
      Parameters:
      aStringOption - 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

      public static StringOption stringOption(String aStringOption, 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:
      aStringOption - The long option to use.
      aDescription - The description of the StringOption
      Returns:
      The accordingly created StringOption instance.
      See Also:

    • stringOption

      public static StringOption stringOption(Character aShortOption, String aStringOption, String aAlias, String aDescription)
      Instantiates a new StringOption with the given arguments.
      Parameters:
      aShortOption - The short option to use.
      aStringOption - 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

      public static StringOption stringOption(Character aShortOption, String aStringOption, 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.
      aStringOption - the string option
      aDescription - The description of the StringOption
      Returns:
      The accordingly created StringOption instance.
      See Also:

    • 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

      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

      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

      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:

    • configOption

      public static ConfigOption configOption()
      Creates a ConfigOption representing value specifying a configuration resource (file).
      Returns:
      the according ConfigOption.
      See Also:

    • 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:

    • 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

      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

      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

      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:

    • 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:

    • asArray

      public static <T> ArrayOption<T> asArray(Option<T> aOption)
      Creates an array representation facade for the encapsulated Option. This way any Option can also be used as an array Option, e.g. it can be provided multiple times in the command line arguments.
      Type Parameters:
      T - The type of the Option for which to create an ArrayOption.
      Parameters:
      aOption - The Option which's array counterpart is to be defined.
      Returns:
      The according ArrayOption.

    • asArray

      public static <T> ArrayOption<T> asArray(Option<T> aOption, int aLength)
      Creates an array representation facade for the encapsulated Option. This way any Option can also be used as an array Option, e.g. it can by provided multiple times in the command line arguments.
      Type Parameters:
      T - The type of the Option for which to create an ArrayOption.
      Parameters:
      aOption - The Option which's array counterpart is to be defined.
      aLength - The number of array elements, or -1 if there is no limit.
      Returns:
      The according ArrayOption.

    • asArray

      public static <T> ArrayOption<T> asArray(Option<T> aOption, int aMinLength, int aMaxLength)
      Creates an array representation facade for the encapsulated Option. This way any Option can also be used as an array Option, e.g. it can by provided multiple times in the command line arguments.
      Type Parameters:
      T - The type of the Option for which to create an ArrayOption.
      Parameters:
      aOption - The Option which's array counterpart is to be defined.
      aMinLength - The minimum number of array elements, or -1 if there is no limit.
      aMaxLength - The maximum number of array elements, or -1 if there is no limit.
      Returns:
      The according ArrayOption.

    • asArray

      public static <T> ArrayOperand<T> asArray(Operand<T> aOperand)
      Creates an array representation facade for the encapsulated Operand. This way any Operand can also be used as an array Operand, e.g. it can be provided multiple times in the command line arguments.
      Type Parameters:
      T - The type of the Operand for which to create an ArrayOperand.
      Parameters:
      aOperand - The Operand which's array counterpart is to be defined.
      Returns:
      The according ArrayOperand.

    • asArray

      public static <T> ArrayOperand<T> asArray(Operand<T> aOperand, int aLength)
      Creates an array representation facade for the encapsulated Operand. This way any Operand can also be used as an array Operand, e.g. it can by provided multiple times in the command line arguments.
      Type Parameters:
      T - The type of the Operand for which to create an ArrayOperand.
      Parameters:
      aOperand - The Operand which's array counterpart is to be defined.
      aLength - The number of array elements, or -1 if there is no limit.
      Returns:
      The according ArrayOperand.

    • asArray

      public static <T> ArrayOperand<T> asArray(Operand<T> aOperand, int aMinLength, int aMaxLength)
      Creates an array representation facade for the encapsulated Operand. This way any Operand can also be used as an array Operand, e.g. it can by provided multiple times in the command line arguments.
      Type Parameters:
      T - The type of the Operand for which to create an ArrayOperand.
      Parameters:
      aOperand - The Operand which's array counterpart is to be defined.
      aMinLength - The minimum number of array elements, or -1 if there is no limit.
      aMaxLength - The maximum number of array elements, or -1 if there is no limit.
      Returns:
      The according ArrayOperand.