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

Class AbstractOperand<T>

    • Field Detail

      • _value

        protected T _value

    • Constructor Detail

      • AbstractOperand

        public AbstractOperand​(Class<T> aType,
                       String aAlias,
                       String aDescription)
        Constructs a Operand with the given arguments.
        Parameters:
        aType - The type of the value returned by the getValue() method.
        aAlias - The Operand's name, used for syntax creation.
        aDescription - A description without any line breaks.

      • AbstractOperand

        public AbstractOperand​(org.refcodes.struct.Relation<String,​T> aProperty,
                       Class<T> aType)
        Instantiates a new operand.
        Parameters:
        aProperty - The key (= alias) and the value for the operand.
        aType - the type

    • Method Detail

      • parseArgs

        public List<Operand<T>> parseArgs​(String[] aArgs,
                                  String[] aOptions)
                           throws UnknownArgsException,
                                  AmbiguousArgsException,
                                  ParseArgsException,
                                  SuperfluousArgsException
        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' Syntaxable.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 Syntaxable.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 Syntaxable.parseArgs(String[], String[]) method as ignoring superfluous command line arguments will cause unexpected behavior from the point of view of the invoker.
        Specified by:
        parseArgs in interface Syntaxable
        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:
        UnknownArgsException - Thrown in case not one command line argument matched regarding the provided args vs. the expected args.
        AmbiguousArgsException - Thrown in case at least one command line argument is ambiguous regarding expected args vs. provided args.
        ParseArgsException - Thrown in case the provided command line arguments do not respect the required syntax or cannot be converted to the required type
        SuperfluousArgsException - in case there were arguments found not being used (superfluous arguments), thrown only in very specific cases (throw with care!).

      • getDescription

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

      • toSyntax

        public String toSyntax​(SyntaxNotation aSyntaxNotation,
                       String aOptionEscCode,
                       String aResetEscCode)
        This method is to be called from inside the Syntaxable hierarchy; use the method SyntaxUsage.toUsage(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) 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 SyntaxUsage.toUsage(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.
        aOptionEscCode - The escape code to be used when processing an option, e.g. this can be an ANSI Escape-Code to highlight the option parameters.
        aResetEscCode - The escape code to close (reset) any Escape-Code being set before.
        Returns:
        The human readable (verbose) command line arguments syntax.

      • getAlias

        public String getAlias()
        Retrieves the name (alias) of the parameter value which can be the name of the operand (Operand) or the option argument (Option), depending on the sub-type inheriting from this interface. The parameter name is merely used for constructing the command line arguments syntax String via Syntaxable.toSyntax(SyntaxNotation, String, String) and the command line arguments detail description when creating a command line tool's help output. Attention: The alias can also be used as a key when putting an Operand's key/value-pair into a dictionary such as is done by the RuntimeProperties type provided by the refcodes-properties-ext-runime artifact!
        Specified by:
        getAlias in interface org.refcodes.mixin.AliasAccessor
        Specified by:
        getAlias in interface Operand<T>
        Returns:
        The name of the parameter, e.g the name of the operand or the name of the option argument.

      • getType

        public Class<T> getType()
        Specified by:
        getType in interface org.refcodes.mixin.TypeAccessor<T>

      • getValue

        public T getValue()
        Specified by:
        getValue in interface Operand<T>
        Specified by:
        getValue in interface org.refcodes.mixin.ValueAccessor<T>

      • getArgs

        public String[] getArgs()
        Retrieves the command line arguments from the args property.
        Specified by:
        getArgs in interface ArgsAccessor
        Specified by:
        getArgs in interface Operand<T>
        Returns:
        The command line arguments stored by the args property.

      • reset

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

      • toState

        public String toState()
        The Syntaxable.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.
        Specified by:
        toState in interface Syntaxable
        Returns:
        The state of this Syntaxable instance and (if any) its children.

      • setArgs

        protected void setArgs​(String[] aArgs)
        Sets the command line argument(s) representing the Operand and its value as parsed by the parseArgs(String[], String[]) method.
        Parameters:
        aArgs - The command line arguments representing this Operand with its value.

      • toType

        protected abstract T toType​(String aArg)
                     throws ParseArgsException
        Double dispatch hook to be implemented by subclasses of the AbstractOperand for converting a command line argument to the required Operand's type. In case conversion failed, then an according exception is to be thrown.
        Parameters:
        aArg - The command line argument to be converted to an instance of the given type T.
        Returns:
        An instance of type T from the provided command line argument.
        Throws:
        ParseArgsException - Thrown in case the provided command line arguments do not respect the required syntax or cannot be converted to the required type.

      • toUsage

        public String toUsage​(SyntaxNotation aSyntaxNotation,
                      String aOptionEscCode,
                      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) 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 SyntaxUsage.toUsage(SyntaxNotation), as for some notations it will for example not create the most outer braces.
        Specified by:
        toUsage in interface SyntaxUsage
        Parameters:
        aSyntaxNotation - The syntax notation used for generating the command line arguments syntax.
        aOptionEscCode - The escape code to be used when processing an option, e.g. this can be an ANSI Escape-Code to highlight the option parameters (for example "--help", "-q" and so on).
        aResetEscCode - The escape code to close (reset) any Escape-Code being set before.
        Returns:
        The human readable (verbose) command line arguments syntax.