Package org.refcodes.console

Class IntegerOption

  • All Implemented Interfaces:
    java.lang.Comparable<java.lang.Integer>, org.refcodes.component.Resetable, ArgsAccessor, Operand<java.lang.Integer>, Option<java.lang.Integer>, Syntaxable, SyntaxUsage, org.refcodes.mixin.AliasAccessor, org.refcodes.mixin.DescriptionAccessor, org.refcodes.mixin.TypeAccessor<java.lang.Integer>, org.refcodes.mixin.ValueAccessor<java.lang.Integer>

    public class IntegerOption
extends AbstractOption<java.lang.Integer>
    The IntegerOption represents an Option holding int values.

    • 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 
      Constructor Description
      IntegerOption​(java.lang.String aLongOption, java.lang.String aAlias, java.lang.String aDescription)
      Instantiates a new integer option impl.
      IntegerOption​(java.lang.String aShortOption, java.lang.String aLongOption, java.lang.String aAlias, java.lang.String aDescription)
      Instantiates a new integer option impl.
      IntegerOption​(org.refcodes.structure.Relation<java.lang.String,java.lang.Integer> aProperty)
      Instantiates a new integer option impl.

    • Constructor Detail

      • IntegerOption

        public IntegerOption​(java.lang.String aLongOption,
                     java.lang.String aAlias,
                     java.lang.String aDescription)
        Instantiates a new integer option impl.
        Parameters:
        aLongOption - the long option
        aAlias - the option arg name
        aDescription - the description

      • IntegerOption

        public IntegerOption​(java.lang.String aShortOption,
                     java.lang.String aLongOption,
                     java.lang.String aAlias,
                     java.lang.String aDescription)
        Instantiates a new integer option impl.
        Parameters:
        aShortOption - the short option
        aLongOption - the long option
        aAlias - the option arg name
        aDescription - the description

      • IntegerOption

        public IntegerOption​(org.refcodes.structure.Relation<java.lang.String,java.lang.Integer> aProperty)
        Instantiates a new integer option impl.
        Parameters:
        aProperty - The key (= alias) and the value for the operand.

    • Method Detail

      • toValue

        protected java.lang.Integer toValue​(java.lang.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.
        Specified by:
        toValue in class AbstractOperand<java.lang.Integer>
        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 java.lang.String toUsage​(SyntaxNotation aSyntaxNotation,
                                java.lang.String aOptionEscCode,
                                java.lang.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.