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

Class AbstractPropertyOption<T>

java.lang.Object
org.refcodes.cli.AbstractOperand<T>
org.refcodes.cli.AbstractOption<T>
org.refcodes.cli.AbstractPropertyOption<T>
Type Parameters:
T - The generic type of the AbstractPropertyOption's value.
All Implemented Interfaces:
Cloneable, Comparable<Operand<?>>, MatchCountAccessor, Operand<T>, Option<T>, ParsedArgsAccessor, PropertyOption<T>, Synopsisable, Term, org.refcodes.exception.ExceptionAccessor<ArgsSyntaxException>, org.refcodes.graphical.VisibleAccessor, org.refcodes.graphical.VisibleAccessor.VisibleBuilder<Term>, org.refcodes.graphical.VisibleAccessor.VisibleMutator, org.refcodes.graphical.VisibleAccessor.VisibleProperty, org.refcodes.mixin.AliasAccessor, org.refcodes.mixin.Clonable, org.refcodes.mixin.DescriptionAccessor, org.refcodes.mixin.Resetable, org.refcodes.mixin.TypeAccessor<T>, org.refcodes.mixin.ValueAccessor<T>, org.refcodes.schema.Schemable
Direct Known Subclasses:
BooleanProperty, CharProperty, DoubleProperty, EnumProperty, FileProperty, FloatProperty, IntProperty, LongProperty, StringProperty
public abstract class AbstractPropertyOption<T> extends AbstractOption<T> implements PropertyOption<T>
The AbstractPropertyOption is an abstract implementation of a PropertyOption providing the boiler plate when implementing the PropertyOption interface. A PropertyOption is a key=value pair passed as a single argument (e.g. "--file=someFile").

  • Field Details

    • _description

      protected String _description

    • _exception

      protected ArgsSyntaxException _exception

    • _isVisible

      protected boolean _isVisible

  • Constructor Details

    • AbstractPropertyOption

      public AbstractPropertyOption(Character aShortProperty, String aLongProperty, Class<T> aType, String aAlias, String aDescription)
      Constructs an AbstractPropertyOption with the given arguments.
      Parameters:
      aShortProperty - The short-option being a single character with the additional single hyphen-minus "-" prefix.
      aLongProperty - 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).

    • AbstractPropertyOption

      public AbstractPropertyOption(Character aShortProperty, String aLongProperty, Class<T> aType, String aAlias, String aDescription, Consumer<? extends Operand<T>> aConsumer)
      Constructs an AbstractPropertyOption with the given arguments.
      Parameters:
      aShortProperty - The short-option being a single character with the additional single hyphen-minus "-" prefix.
      aLongProperty - 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).
      aConsumer - The Consumer being invoked in case this PropertyOption participated in successfully parsing the command line arguments.

    • AbstractPropertyOption

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

    • AbstractPropertyOption

      public AbstractPropertyOption(org.refcodes.struct.Relation<String,T> aProperty, Class<T> aType, Consumer<? extends Operand<T>> aConsumer)
      Constructs an AbstractPropertyOption with the given arguments.
      Parameters:
      aProperty - The key (= alias) and the value for the operand.
      aType - the type
      aConsumer - The Consumer being invoked in case this PropertyOption participated in successfully parsing the command line arguments.

    • AbstractPropertyOption

      public AbstractPropertyOption(String aLongProperty, Class<T> aType, String aDescription)
      Constructs an AbstractPropertyOption with the given arguments.
      Parameters:
      aLongProperty - 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).

    • AbstractPropertyOption

      public AbstractPropertyOption(String aLongProperty, Class<T> aType, String aDescription, Consumer<? extends Operand<T>> aConsumer)
      Constructs an AbstractPropertyOption with the given arguments.
      Parameters:
      aLongProperty - 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).
      aConsumer - The Consumer being invoked in case this PropertyOption participated in successfully parsing the command line arguments.

    • AbstractPropertyOption

      public AbstractPropertyOption(String aLongProperty, Class<T> aType, String aAlias, String aDescription)
      Constructs an AbstractPropertyOption with the given arguments.
      Parameters:
      aLongProperty - 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).

    • AbstractPropertyOption

      public AbstractPropertyOption(String aLongProperty, Class<T> aType, String aAlias, String aDescription, Consumer<? extends Operand<T>> aConsumer)
      Constructs an AbstractPropertyOption with the given arguments.
      Parameters:
      aLongProperty - 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).
      aConsumer - The Consumer being invoked in case this PropertyOption participated in successfully parsing the command line arguments.

    • AbstractPropertyOption

      protected AbstractPropertyOption(Character aShortProperty, String aLongProperty, Class<T> aType, String aDescription)
      Constructs an AbstractPropertyOption with the given arguments.
      Parameters:
      aShortProperty - The short-option being a single character with the additional single hyphen-minus "-" prefix.
      aLongProperty - 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).

    • AbstractPropertyOption

      protected AbstractPropertyOption(Character aShortProperty, String aLongProperty, Class<T> aType, String aDescription, Consumer<? extends Operand<T>> aConsumer)
      Constructs an AbstractPropertyOption with the given arguments.
      Parameters:
      aShortProperty - The short-option being a single character with the additional single hyphen-minus "-" prefix.
      aLongProperty - 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).
      aConsumer - The Consumer being invoked in case this PropertyOption participated in successfully parsing the command line arguments.

  • Method Details

    • parseArgs

      public Operand<?>[] parseArgs(String[] aArgs, String[] aOptions, CliContext aCliCtx) throws ArgsSyntaxException
      Parses the provided command line arguments and determines the according values by evaluating this Term instance or, in case of being a node in the syntax tree (such as a Condition, traversing the child Term instances' Term.parseArgs(String[], String[], CliContext) methods. In case of successfully parsing this Term and / or the child Term instances, the evaluated command line arguments are returned: Depending on the Term 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 Term instance being traversed. This method is commonly used by a root Term's ParseArgs.evalArgs(String[]) method, which delegates to the Term.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 Term.parseArgs(String[], String[], CliContext) method as ignoring superfluous command line arguments will aCause unexpected behavior from the point of view of the invoker.
      Specified by:
      parseArgs in interface Term
      Overrides:
      parseArgs in class AbstractOption<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.

    • toUsage

      public String toUsage(CliContext aCliContext)
      Creates a specification for this Operand, helpful e.g. in human readable messages.
      Specified by:
      toUsage in interface Operand<T>
      Parameters:
      aCliContext - The CliContext to use when creating a beautiful usage text.
      Returns:
      The according usage text.

    • toSyntax

      public String toSyntax(CliContext aCliCtx)
      This method is to be called from inside the Term hierarchy; use the method Synopsisable.toSynopsis(SyntaxNotation) in case you invoke syntax retrieval from the root Term. Returns the human readable (verbose) syntax of this Term instance including, in case of being a node in the syntax tree (such as a Condition, the syntax of the child Term instances. ATTENTION: As of different parenthesis settings for some notations regarding the root Term and the child Terms, the method Term.toSyntax(CliContext) is called from inside the Term hierarchy. In case the syntax is to be retrieved from the root Term, 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 Term
      Overrides:
      toSyntax in class AbstractOption<T>
      Parameters:
      aCliCtx - The CliContext for which the syntax is being generated.
      Returns:
      The human readable (verbose) command line arguments syntax.

    • toPropertyArgument

      protected org.refcodes.struct.Relation<String,String> toPropertyArgument(String[] aArgs, 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:
      aArgs - The command line arguments from which to determine the Option's value.
      aCliCtx - The CliContext to run this method with.
      Returns:
      A key/value-pair containing the detected (short / long) option alongside the detected value.

    • toPropertyArgument

      protected static org.refcodes.struct.Relation<String,String> toPropertyArgument(String[] aArgs, String aOption)
      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 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

    • getException

      public ArgsSyntaxException getException()
      Retrieves the ArgsSyntaxException exception in case invoking Term.parseArgs(String[], CliContext) failed. The exception (and the according suppressed ones alongside the causes) does not necessarily have been thrown by the Term.parseArgs(String[], CliContext) method depending on the semantics of the Term handing the exception (the AnyCondition provides any exceptions it caught even though it did not throw them as of its semantics).
      Specified by:
      getException in interface org.refcodes.exception.ExceptionAccessor<ArgsSyntaxException>
      Specified by:
      getException in interface Term
      Returns:
      The ArgsSyntaxException exception occurring while parsing the arguments.

    • setVisible

      public void setVisible(boolean isVisible)
      Visibility in this context means displaying or hiding this Term's existence to the user (defaults to true).
      Specified by:
      setVisible in interface Term
      Specified by:
      setVisible in interface org.refcodes.graphical.VisibleAccessor.VisibleMutator

    • isVisible

      public boolean isVisible()
      Visibility in this context means displaying or hiding this Term's existence to the user (defaults to true).
      Specified by:
      isVisible in interface Term
      Specified by:
      isVisible in interface org.refcodes.graphical.VisibleAccessor

    • toArgsDiff

      protected static String[] toArgsDiff(String[] aArgs, List<? extends Operand<?>> aArgsSubset)
      Creates the difference between the provided set and the provided Lists therein found argument arrays subset (as of Operand.getParsedArgs()).
      Parameters:
      aArgs - The set to be used for the diff operation.
      aArgsSubset - The subset to be used for the diff operation being the lists containing the Operand instances whose command line arguments are to be diffed.
      Returns:
      The difference between the set and the subset.

    • toArgsDiff

      protected static String[] toArgsDiff(String[] aArgs, Operand<?>[] aArgsSubset)
      Creates the difference between the provided set and the provided Lists therein found argument arrays subset (as of Operand.getParsedArgs()).
      Parameters:
      aArgs - The set to be used for the diff operation.
      aArgsSubset - The subset to be used for the diff operation being the lists containing the Operand instances whose command line arguments are to be diffed.
      Returns:
      The difference between the set and the subset.

    • toArgsDiff

      protected static String[] toArgsDiff(String[] aArgs, String[] aArgsSubset)
      Creates the difference between the provided set and the provided subset.
      Parameters:
      aArgs - The set to be used for the diff operation.
      aArgsSubset - The subset to be used for the diff operation.
      Returns:
      The difference between the set and the subset.

    • toParsedArgs

      protected static String[] toParsedArgs(Operand<?>[]... aOperands)
      Takes all Operand instances found in the provided Lists and adds all therein found argument arrays (as of Operand.getParsedArgs()) to the result.
      Parameters:
      aOperands - The lists containing the Operand instances whose command line arguments are to be added to the result.
      Returns:
      All the command line arguments detected in the provided Operands Lists.