Module org.refcodes.cli
Package org.refcodes.cli

Class AbstractOption<T>

java.lang.Object
org.refcodes.cli.AbstractOperand<T>
org.refcodes.cli.AbstractOption<T>
Type Parameters:
T - the generic type
All Implemented Interfaces:
Cloneable, Comparable<Operand<?>>, ArgsAccessor, Constituent, Operand<T>, Option<T>, Synopsisable, org.refcodes.mixin.AliasAccessor, org.refcodes.mixin.Clonable, org.refcodes.mixin.DescriptionAccessor, org.refcodes.mixin.Resetable, org.refcodes.mixin.Schemable<CliSchema>, org.refcodes.mixin.TypeAccessor<T>, org.refcodes.mixin.ValueAccessor<T>
Direct Known Subclasses:
CharOption, DoubleOption, EnumOption, FileOption, Flag, FloatOption, IntOption, LongOption, StringOption
public abstract class AbstractOption<T> extends AbstractOperand<T> implements Option<T>
The AbstractOption is an abstract implementation of an Option providing the boiler plate when implementing the Option interface.

  • Field Details

    • _description

      protected String _description

  • Constructor Details

    • AbstractOption

      public AbstractOption(String aLongOption, Class<T> aType, String aDescription)
      Constructs an AbstractOption with the given arguments.
      Parameters:
      aLongOption - The long-option being a multi-character sequence with at least two characters with the additional double hyphen-minus "--" prefix.
      aType - The type of the value returned by the AbstractOperand.getValue() method.
      aDescription - The description to be used (without any line breaks).

    • AbstractOption

      public AbstractOption(String aLongOption, Class<T> aType, String aAlias, String aDescription)
      Constructs an AbstractOption with the given arguments.
      Parameters:
      aLongOption - The long-option being a multi-character sequence with at least two characters with the additional double hyphen-minus "--" prefix.
      aType - The type of the value returned by the AbstractOperand.getValue() method.
      aAlias - The option argument's name to be used when constructing the syntax.
      aDescription - The description to be used (without any line breaks).

    • AbstractOption

      protected AbstractOption(Character aShortOption, String aLongOption, Class<T> aType, String aDescription)
      Constructs an AbstractOption with the given arguments.
      Parameters:
      aShortOption - The short-option being a single character with the additional single hyphen-minus "-" prefix.
      aLongOption - The long-option being a multi-character sequence with at least two characters with the additional double hyphen-minus "--" prefix.
      aType - The type of the value returned by the AbstractOperand.getValue() method.
      aDescription - The description to be used (without any line breaks).

    • AbstractOption

      public AbstractOption(Character aShortOption, String aLongOption, Class<T> aType, String aAlias, String aDescription)
      Constructs an AbstractOption with the given arguments.
      Parameters:
      aShortOption - The short-option being a single character with the additional single hyphen-minus "-" prefix.
      aLongOption - The long-option being a multi-character sequence with at least two characters with the additional double hyphen-minus "--" prefix.
      aType - The type of the value returned by the AbstractOperand.getValue() method.
      aAlias - The option argument's name to be used when constructing the syntax.
      aDescription - The description to be used (without any line breaks).

    • AbstractOption

      public AbstractOption(org.refcodes.struct.Relation<String,T> aProperty, Class<T> aType)
      Constructs an AbstractOption with the given arguments.
      Parameters:
      aProperty - The key (= alias) and the value for the operand.
      aType - the type

  • Method Details

    • parseArgs

      public List<Operand<T>> parseArgs(String[] aArgs, String[] aOptions, CliContext aCliCtx) throws ArgsSyntaxException
      Parses the provided command line arguments and determines the according values by evaluating this Constituent instance or, in case of being a node in the syntax tree (such as a Condition, traversing the child Constituent instances' Constituent.parseArgs(String[], String[], CliContext) methods. In case of successfully parsing this Constituent and / or the child Constituent instances, the evaluated command line arguments are returned: Depending on the Constituent subclasses representing the evaluated command line arguments, instances of Flag classes, Option classes or Operand classes may be found in the result. In case of parsing failure, an according exception is thrown. ATTENTION: This method does not test for superfluous command line arguments being passed; e.g. command line arguments not being evaluated by any of the Constituent instance being traversed. This method is commonly used by a root Constituent's ArgsParser.evalArgs(String[]) method, which delegates to the Constituent.parseArgs(String[], String[], CliContext) method and after which it determines whether there are superfluous arguments to be taken care of (by throwing an according exception). Business logic therefore should invoke the root node's Constituent.parseArgs(String[], String[], CliContext) method as ignoring superfluous command line arguments will cause unexpected behavior from the point of view of the invoker.
      Specified by:
      parseArgs in interface Constituent
      Overrides:
      parseArgs in class AbstractOperand<T>
      Parameters:
      aArgs - The command line arguments to be parsed.
      aOptions - The list of options (short and as well as long) which are reserved and cannot be used as value.
      aCliCtx - the cli context
      Returns:
      The list of evaluated command line arguments being instances of the Operand interfaces or its sub-types.
      Throws:
      ArgsSyntaxException - thrown in case of a command line arguments mismatch regarding provided and expected args.

    • getShortOption

      public Character getShortOption()
      Returns the short-option representing an Option instance. A short option usually is being prefixed with a single hyphen-minus "-" as defined in ArgsPrefix.POSIX_SHORT_OPTION.
      Specified by:
      getShortOption in interface Option<T>
      Returns:
      The short-option String.

    • getLongOption

      public String getLongOption()
      Returns the long-option representing an Option instance. A long option usually is being prefixed with a double hyphen-minus "--" as defined in ArgsPrefix.POSIX_LONG_OPTION.
      Specified by:
      getLongOption in interface Option<T>
      Returns:
      The long-option String.

    • toSyntax

      public String toSyntax(CliContext aCliCtx)
      This method is to be called from inside the Constituent hierarchy; use the method Synopsisable.toSynopsis(SyntaxNotation) in case you invoke syntax retrieval from the root Constituent. Returns the human readable (verbose) syntax of this Constituent instance including, in case of being a node in the syntax tree (such as a Condition, the syntax of the child Constituent instances. ATTENTION: As of different parenthesis settings for some notations regarding the root Constituent and the child Constituents, the method Constituent.toSyntax(CliContext) is called from inside the Constituent hierarchy. In case the syntax is to be retrieved from the root Constituent, then the applicable method to be called is Synopsisable.toSynopsis(SyntaxNotation), as for some notations it will for example not create the most outer braces.
      Specified by:
      toSyntax in interface Constituent
      Overrides:
      toSyntax in class AbstractOperand<T>
      Parameters:
      aCliCtx - The CliContext for which the syntax is being generated.
      Returns:
      The human readable (verbose) command line arguments syntax.

    • clone

      public Object clone() throws CloneNotSupportedException
      Specified by:
      clone in interface org.refcodes.mixin.Clonable
      Overrides:
      clone in class AbstractOperand<T>
      Throws:
      CloneNotSupportedException

    • toSchema

      public CliSchema toSchema()
      Specified by:
      toSchema in interface org.refcodes.mixin.Schemable<T>
      Overrides:
      toSchema in class AbstractOperand<T>

    • setValue

      protected void setValue(T aValue)
      Sets the value for the Operand as parsed by the AbstractOperand.parseArgs(String[], String[], CliContext) method.
      Overrides:
      setValue in class AbstractOperand<T>
      Parameters:
      aValue - The value to be set for this Operand.

    • setParsedArgs

      protected void setParsedArgs(String[] aArgs)
      Sets the command line argument(s) representing the Operand and its value as parsed by the AbstractOperand.parseArgs(String[], String[], CliContext) method.
      Overrides:
      setParsedArgs in class AbstractOperand<T>
      Parameters:
      aArgs - The command line arguments representing this Operand with its value.

    • contains

      protected static boolean contains(String[] aArgs, String aArg)
      Determines whether a given String is contained in the given String array.
      Parameters:
      aArgs - The String array to be tested whether it contains the given String.
      aArg - The String to be tested whether it is contained in the provided String array.
      Returns:
      True in case the String is contained in the array, else false.

    • toOptionArgument

      protected static org.refcodes.struct.Relation<String,String> toOptionArgument(Option<?> aOption, String[] aArgs, String[] aOptions, CliContext aCliCtx)
      Takes the Option's short-option and long-option and tries to determine that Option's value in the provided command line arguments. Depending on whether the short-option or the long-option was detected with a value, the result contains the according option as the key with the detected value in the Relation instance. Null is returned when either no option was found or no value for one of the options.
      Parameters:
      aOption - The option for which to get the value
      aArgs - The command line arguments from which to determine the Option's value.
      aOptions - The list of options (short and well as long) which are reserved and cannot be used as value.
      aCliCtx - The CliContext to run this method with.
      Returns:
      A key/value-pair containing the detected (short / long) option alongside the detected value.

    • toOptionArgument

      protected static org.refcodes.struct.Relation<String,String> toOptionArgument(String[] aArgs, String aOption, String[] aOptions)
      Takes the Option's short-option and long-option and tries to determine that Option's value in the provided command line arguments. Depending on whether the short-option or the long-option was detected with a value, the result contains the according option as the key with the detected value in the Relation instance. Null is returned when either no option was found or no value for one of the options.
      Parameters:
      aArgs - The command line arguments from which to determine the Option's value.
      aOption - The option for which to get the value
      aOptions - The list of options (short and well as long) which are reserved and cannot be used as value.
      Returns:
      A key/value-pair containing the detected (short / long) option alongside the detected value.

    • getDescription

      public String getDescription()
      Specified by:
      getDescription in interface org.refcodes.mixin.DescriptionAccessor