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

Interface Syntaxable

    • Method Detail

      • toSyntax

        default String toSyntax​(String aOptEscCode,
                        String aParamEscCode,
                        String aResetEscCode)
        This method is to be called from inside the Syntaxable hierarchy; use the method Synopsis.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 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 Synopsis.toSynopsis(SyntaxNotation), as for some notations it will for example not create the most outer braces. This method uses the SyntaxNotation.REFCODES 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

        String toSyntax​(SyntaxNotation aSyntaxNotation,
                String aOptEscCode,
                String aParamEscCode,
                String aResetEscCode)
        This method is to be called from inside the Syntaxable hierarchy; use the method Synopsis.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 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 Synopsis.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.

      • parseArgs

        default List<? extends Operand<?>> parseArgs​(String[] aArgs)
                                      throws ArgsSyntaxException
        Parses the provided command line arguments and determines the according values by evaluating this Syntaxable instance or, in case of being a node in the syntax tree (such as a ArgsSyntax, traversing the child Syntaxable instances' parseArgs(String[], String[]) methods. In case of successfully parsing this Syntaxable and / or the child Syntaxable instances, the evaluated command line arguments are returned: Depending on the Syntaxable 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 Syntaxable instance being traversed. This method is commonly used by a root Syntaxable's ArgsParser.evalArgs(String[]) method, which delegates to the parseArgs(String[], String[]) 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[]) 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.
        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)
                              throws ArgsSyntaxException
        Parses the provided command line arguments and determines the according values by evaluating this Syntaxable instance or, in case of being a node in the syntax tree (such as a ArgsSyntax, traversing the child Syntaxable instances' parseArgs(String[], String[]) methods. In case of successfully parsing this Syntaxable and / or the child Syntaxable instances, the evaluated command line arguments are returned: Depending on the Syntaxable 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 Syntaxable instance being traversed. This method is commonly used by a root Syntaxable's ArgsParser.evalArgs(String[]) method, which delegates to the parseArgs(String[], String[]) 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[]) 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.
        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.

      • toState

        String toState()
        The toState() method might be used by the Object.toString() method and prints out the state of the syntaxable and (if any) its children. Even in case parsing command line arguments failed, the state till failure can be inspected with this method.
        Returns:
        The state of this Syntaxable instance and (if any) its children.