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

Interface Constituent

All Superinterfaces:
org.refcodes.mixin.DescriptionAccessor, org.refcodes.mixin.Resetable, org.refcodes.mixin.Schemable<CliSchema>, Synopsisable
All Known Subinterfaces:
Condition, Operand<T>, Option<T>
All Known Implementing Classes:
AbstractCondition, AbstractOperand, AbstractOption, AllCondition, AndCondition, AnyCondition, ArrayOperand, ArrayOption, CasesCondition, CharOption, CleanFlag, ConfigOption, DaemonFlag, DebugFlag, DoubleOption, EnumOption, FileOption, Flag, FloatOption, ForceFlag, HelpFlag, InitFlag, IntOption, LongOption, NoneOperand, Operation, OrCondition, QuietFlag, StringOperand, StringOption, SysInfoFlag, VerboseFlag, XorCondition
public interface Constituent extends org.refcodes.mixin.Resetable, Synopsisable, org.refcodes.mixin.DescriptionAccessor, org.refcodes.mixin.Schemable<CliSchema>
A Constituent defines the methods at least required when building a command line arguments syntax tree for traversing the syntax tree; either for parsing command line arguments or for constructing the command line arguments syntax. By providing various implementations of the Constituent's subclasses such as Operand, Option or Condition, a command line arguments syntax tree can be constructed. This syntax tree can be use to create a human readable (verbose) command line arguments syntax and to parse an array of command line arguments for determining the Operands', the Flages' or the Options' values.

  • Method Details

    • toSyntax

      default String toSyntax(SyntaxNotation aSyntaxNotation)
      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 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.
      Parameters:
      aSyntaxNotation - The syntax notation used for generating the command line arguments syntax.
      Returns:
      The human readable (verbose) command line arguments syntax.

    • toSyntax

      default String toSyntax()
      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 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. This method uses the SyntaxNotation.LOGICAL be default!
      Returns:
      The human readable (verbose) command line arguments syntax.

    • toSyntax

      default String toSyntax(String aOptEscCode, String aParamEscCode, String aResetEscCode)
      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 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. This method uses the SyntaxNotation.LOGICAL be default!
      Parameters:
      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.

    • toSyntax

      default String toSyntax(SyntaxNotation aSyntaxNotation, String aOptEscCode, String aParamEscCode, String aResetEscCode)
      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 toSyntax(SyntaxNotation, String, String, String) 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.
      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.

    • toSyntax

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

    • toSynopsis

      default String toSynopsis(CliContext aCliCtx)
      Returns the human readable (verbose) syntax of implementing class ATTENTION: As of different parenthesis settings for some notations regarding the root Constituent and the child Constituents, the method toSyntax(CliContext) is called from inside a Constituent hierarchy. In case the syntax is to be retrieved from the root Constituent 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:
      aCliCtx - The CliContext for which the syntax is being generated.
      Returns:
      The human readable (verbose) command line arguments syntax.

    • parseArgs

      default List<? extends Operand<?>> parseArgs(String[] aArgs, 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' 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 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 parseArgs(String[], String[], CliContext) method as ignoring superfluous command line arguments will cause unexpected behavior from the point of view of the invoker.
      Parameters:
      aArgs - The command line arguments to be parsed.
      aCliCtx - The CliContext to use when parsing the arguments.
      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.

    • parseArgs

      List<? extends Operand<?>> parseArgs(String[] aArgs, String[] aOptions, CliContext aCliContext) 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' 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 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 parseArgs(String[], String[], CliContext) method as ignoring superfluous command line arguments will cause 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.
      aCliContext - 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.

    • toValue

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