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

Class AnyCondition

java.lang.Object
org.refcodes.cli.AbstractCondition
org.refcodes.cli.AnyCondition
All Implemented Interfaces:
Condition, MatchCountAccessor, Synopsisable, Term, org.refcodes.exception.ExceptionAccessor<ArgsSyntaxException>, org.refcodes.mixin.ChildrenAccessor<Term[]>, org.refcodes.mixin.DescriptionAccessor, org.refcodes.mixin.Resetable, org.refcodes.mixin.Schemable
public class AnyCondition extends AbstractCondition
Any of the nested Condition conditions may match for the AnyCondition to match, e.g. all of the nested conditions are optional. The AnyCondition can nested by an AndCondition and encapsulates a Condition which may be provided but does not necessarily needs to be provided in order for the AndCondition to successfully parse the nested Condition items including the AnyCondition.

  • Field Details

  • Constructor Details

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

    • reset

      public void reset()
      Specified by:
      reset in interface org.refcodes.mixin.Resetable
      Overrides:
      reset in class AbstractCondition

    • 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 AbstractCondition
      Parameters:
      aCliCtx - The CliContext for which the syntax is being generated.
      Returns:
      The human readable (verbose) command line arguments syntax.

    • getException

      public ArgsSyntaxException getException()
      Retrieves the ArgsSyntaxException exception caught while invoking the Term.parseArgs(String[], CliContext) method. The exception (and the according suppressed ones alongside the causes) is not thrown by the Term.parseArgs(String[], CliContext) method as of the semantics of this AnyCondition! Nevertheless, the exception can be used to analyze argument parsing failure (e.g. for better error messages).
      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.

    • getDescription

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

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