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

Class NoneOperand

  • All Implemented Interfaces:
    Cloneable, Comparable<Operand<?>>, ArgsAccessor, Operand<Boolean>, Synopsis, Syntaxable, org.refcodes.component.Resetable, org.refcodes.mixin.AliasAccessor, org.refcodes.mixin.Clonable, org.refcodes.mixin.DescriptionAccessor, org.refcodes.mixin.EnabledAccessor, org.refcodes.mixin.TypeAccessor<Boolean>, org.refcodes.mixin.ValueAccessor<Boolean>
    public class NoneOperand
extends AbstractOperand<Boolean>
implements Operand<Boolean>, org.refcodes.mixin.EnabledAccessor
    The NoneOperand represents an empty set of arguments, e.g. no command line argument is being passed. Usually only makes sense near the root of a Syntaxable tree (e.g. inside the main XorCondition) to test ALL arguments passed to an application and one invocation may have neither optional (as of AnyCondition) nor mandatory arguments allowed.

    • Constructor Detail

      • NoneOperand

        public NoneOperand​(String aDescription)
        Instantiates a new NoneOperand.
        Parameters:
        aDescription - A description without any line breaks.

      • NoneOperand

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

    • Method Detail

      • parseArgs

        public List<Operand<Boolean>> 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' 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
        Overrides:
        parseArgs in class AbstractOperand<Boolean>
        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.

      • 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 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 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 Synopsis.toSynopsis(SyntaxNotation), as for some notations it will for example not create the most outer braces.
        Specified by:
        toSyntax in interface Syntaxable
        Overrides:
        toSyntax in class AbstractOperand<Boolean>
        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.

      • isEnabled

        public boolean isEnabled()
        Determines whether none arguments have been passed.
        Specified by:
        isEnabled in interface org.refcodes.mixin.EnabledAccessor
        Returns:
        True in case none arguments have been passed.

      • 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 Synopsis.toSynopsis(SyntaxNotation), as for some notations it will for example not create the most outer braces.
        Specified by:
        toSynopsis in interface Synopsis
        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.