Package org.refcodes.console

Class AbstractOption<T>

    • Nested Class Summary

      • Nested classes/interfaces inherited from interface org.refcodes.mixin.AliasAccessor

        org.refcodes.mixin.AliasAccessor.AliasBuilder<B extends org.refcodes.mixin.AliasAccessor.AliasBuilder<B>>, org.refcodes.mixin.AliasAccessor.AliasMutator, org.refcodes.mixin.AliasAccessor.AliasProperty

      • Nested classes/interfaces inherited from interface org.refcodes.mixin.DescriptionAccessor

        org.refcodes.mixin.DescriptionAccessor.DescriptionBuilder<B extends org.refcodes.mixin.DescriptionAccessor.DescriptionBuilder<B>>, org.refcodes.mixin.DescriptionAccessor.DescriptionMutator, org.refcodes.mixin.DescriptionAccessor.DescriptionProperty

      • Nested classes/interfaces inherited from interface org.refcodes.mixin.TypeAccessor

        org.refcodes.mixin.TypeAccessor.TypeMutator<T extends java.lang.Object>, org.refcodes.mixin.TypeAccessor.TypeProperty<T extends java.lang.Object>

      • Nested classes/interfaces inherited from interface org.refcodes.mixin.ValueAccessor

        org.refcodes.mixin.ValueAccessor.ValueBuilder<V extends java.lang.Object,B extends org.refcodes.mixin.ValueAccessor.ValueBuilder<V,B>>, org.refcodes.mixin.ValueAccessor.ValueMutator<V extends java.lang.Object>, org.refcodes.mixin.ValueAccessor.ValueProperty<V extends java.lang.Object>

    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      protected AbstractOption​(java.lang.String aShortOption, java.lang.String aLongOption, java.lang.Class<T> aType, java.lang.String aDescription)
      Constructs a Option with the given arguments.
        AbstractOption​(java.lang.String aShortOption, java.lang.String aLongOption, java.lang.Class<T> aType, java.lang.String aAlias, java.lang.String aDescription)
      Constructs a Option with the given arguments.
        AbstractOption​(org.refcodes.structure.Relation<java.lang.String,T> aProperty, java.lang.Class<T> aType)
      Instantiates a new option.

    • Constructor Detail

      • AbstractOption

        public AbstractOption​(java.lang.String aShortOption,
                      java.lang.String aLongOption,
                      java.lang.Class<T> aType,
                      java.lang.String aAlias,
                      java.lang.String aDescription)
        Constructs a Option with the given arguments.
        Parameters:
        aShortOption - The short-option being a single character with the additional single hyphen-minus "-" prefix.
        aLongOption - The long-option being a multi-character sequence with at least two characters with the additional double hyphen-minus "--" prefix.
        aType - The type of the value returned by the AbstractOperand.getValue() method.
        aAlias - The option argument's name to be used when constructing the syntax.
        aDescription - A description without any line breaks.

      • AbstractOption

        protected AbstractOption​(java.lang.String aShortOption,
                         java.lang.String aLongOption,
                         java.lang.Class<T> aType,
                         java.lang.String aDescription)
        Constructs a Option with the given arguments.
        Parameters:
        aShortOption - The short-option being a single character with the additional single hyphen-minus "-" prefix.
        aLongOption - The long-option being a multi-character sequence with at least two characters with the additional double hyphen-minus "--" prefix.
        aType - The type of the value returned by the AbstractOperand.getValue() method.
        aDescription - A description without any line breaks.

      • AbstractOption

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

    • Method Detail

      • parseArgs

        public java.util.List<Operand<T>> parseArgs​(java.lang.String[] aArgs)
                                     throws UnknownArgsException,
                                            AmbiguousArgsException,
                                            ParseArgsException
        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 Condition, traversing the child Syntaxable instances' Syntaxable.parseArgs(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[]) 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[]) 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<T>
        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:
        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

      • getShortOption

        public java.lang.String getShortOption​()
        Returns the short-option representing an Option instance. A short option usually is being prefixed with a single hyphen-minus "-" as defined in CommandArgPrefix.POSIX_SHORT_OPTION.
        Specified by:
        getShortOption in interface Option<T>
        Returns:
        The short-option String.

      • getLongOption

        public java.lang.String getLongOption​()
        TODO: Make the option to be required without the hyphen-minuses "--" Returns the long-option representing an Option instance. A long option usually is being prefixed with a double hyphen-minus "--" as defined in CommandArgPrefix.POSIX_LONGT_OPTION.
        Specified by:
        getLongOption in interface Option<T>
        Returns:
        The long-option String.

      • toState

        public java.lang.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
        Overrides:
        toState in class AbstractOperand<T>
        Returns:
        The state of this Syntaxable instance and (if any) its children.

      • toUsage

        public java.lang.String toUsage​(SyntaxNotation aSyntaxNotation)
        Description copied from interface: SyntaxUsage
        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) 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.
        Returns:
        The human readable (verbose) command line arguments syntax.