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

Class AbstractCondition

java.lang.Object
org.refcodes.cli.AbstractCondition
All Implemented Interfaces:
ArgsSyntax, Condition, Synopsisable, Syntaxable, org.refcodes.mixin.Resetable, org.refcodes.mixin.Schemable<CliSchema>
Direct Known Subclasses:
AllCondition, AndCondition, AnyCondition, OptionCondition, OrCondition, XorCondition
public abstract class AbstractCondition extends Object implements Condition
The AbstractCondition is an abstract implementation of the ArgsSyntax interface providing the boiler plate when implementing the ArgsSyntax interface as done by the AbstractCondition's sub-classes.

  • Constructor Details

    • AbstractCondition

      public AbstractCondition(String aDescription, Syntaxable... aElements)
      Instantiates a new abstract condition.
      Parameters:
      aDescription - The description of this Condition.
      aElements - the elements

  • Method Details

    • toSyntax

      public String toSyntax(SyntaxNotation aSyntaxNotation, String aOptEscCode, String aParamEscCode, String aResetEscCode)
      This method is to be called from inside the Syntaxable hierarchy; use the method Synopsisable.toSynopsis(SyntaxNotation) in case you invoke syntax retrieval from the root Syntaxable. Returns the human readable (verbose) syntax of this Syntaxable instance including, in case of being a node in the syntax tree (such as a ArgsSyntax, the syntax of the child Syntaxable instances. ATTENTION: As of different parenthesis settings for some notations regarding the root Syntaxable and the child Syntaxables, the method Syntaxable.toSyntax(SyntaxNotation, String, String, String) is called from inside the Syntaxable hierarchy. In case the syntax is to be retrieved from the root Syntaxable, 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 Syntaxable
      Parameters:
      aSyntaxNotation - The syntax notation used for generating the command line arguments syntax.
      aOptEscCode - The escape code to be used when processing an option, e.g. this can be an ANSI Escape-Code to highlight the option.
      aParamEscCode - The escape code to be used when processing a keyword, e.g. this can be an ANSI Escape-Code to highlight the option and/or parameters.
      aResetEscCode - The escape code to close (reset) any Escape-Code being set before.
      Returns:
      The human readable (verbose) command line arguments syntax.

    • reset

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

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • toSchema

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

    • toOperands

      public List<Operand<?>> toOperands()
      Traverses the hierarchy of ArgsSyntaxs and collects all therein found Operands and sub-types such as the Flag or the Option. This is most useful when creating a list of Options, Flages and Operands when printing out detailed help.
      Specified by:
      toOperands in interface ArgsSyntax
      Returns:
      The according Operand elements.

    • getChildren

      protected List<Syntaxable> getChildren()
      Gets the children.
      Returns:
      the children

    • getFirst

      protected Syntaxable getFirst()
      Gets the first child. It is up to the developer to make sure that there actually is(!) a child!
      Returns:
      the first child.

    • addChild

      protected void addChild(Syntaxable aArgumentizer)
      Adds the child.
      Parameters:
      aArgumentizer - the argumentizer

    • toValue

      public <V> V toValue(String aAlias)
      Searches for a value being set for the given for given alias in the syntax tree parsing the command line arguments; if a node in the syntax tree has a value for the given alias, then this value is returned.
      Specified by:
      toValue in interface Syntaxable
      Type Parameters:
      V - The type of the value being expected.
      Parameters:
      aAlias - The alias for which to seek for a value being set.
      Returns:
      The according value or null if none has been set for the given alias.

    • toOperand

      public <T extends Operand<?>> T toOperand(String aAlias, Class<T> aType)
      Traverses the hierarchy of ArgsSyntax tree and returns the (first) operand matching the given alias and type.
      Specified by:
      toOperand in interface ArgsSyntax
      Type Parameters:
      T - the generic type
      Parameters:
      aAlias - The alias for which to seek for.
      aType - The type for which to seek for.
      Returns:
      The according Operand element or null if none matching was found

    • toSynopsis

      public String toSynopsis(SyntaxNotation aSyntaxNotation, String aOptEscCode, String aParamEscCode, String aResetEscCode)
      Returns the human readable (verbose) syntax of implementing class ATTENTION: As of different parenthesis settings for some notations regarding the root Syntaxable and the child Syntaxables, the method Syntaxable.toSyntax(SyntaxNotation, String, String, String) is called from inside a Syntaxable hierarchy. In case the syntax is to be retrieved from the root Syntaxable or an encapsulating and different type, 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:
      toSynopsis in interface Synopsisable
      Parameters:
      aSyntaxNotation - The syntax notation used for generating the command line arguments syntax.
      aOptEscCode - The escape code to be used when processing an option, e.g. this can be an ANSI Escape-Code to highlight the option.
      aParamEscCode - The escape code to be used when processing am argument, e.g. this can be an ANSI Escape-Code to highlight the option.
      aResetEscCode - The escape code to close (reset) any Escape-Code being set before.
      Returns:
      The human readable (verbose) command line arguments syntax.