Class StringOperand

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


    public class StringOperand
    extends AbstractOperand<java.lang.String>
    An Operand (neither a short option nor a long option prepended nor being a switch) being s String. An Operand stands by itself and represents itself.
    • 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
      StringOperand​(java.lang.String aAlias, java.lang.String aDescription)
      Instantiates a new string operand impl.
      StringOperand​(org.refcodes.structure.Relation<java.lang.String,java.lang.String> aProperty)
      Instantiates a new string operand impl.
    • Constructor Detail

      • StringOperand

        public StringOperand​(java.lang.String aAlias,
                             java.lang.String aDescription)
        Instantiates a new string operand impl.
        Parameters:
        aAlias - The identifier to be used when printing the syntax via the AbstractOperand.toSyntax(SyntaxNotation, String, String) method.
        aDescription - A description without any line breaks.
      • StringOperand

        public StringOperand​(org.refcodes.structure.Relation<java.lang.String,java.lang.String> aProperty)
        Instantiates a new string operand impl.
        Parameters:
        aProperty - The key (= alias) and the value for the operand.
    • Method Detail

      • toValue

        protected java.lang.String toValue​(java.lang.String aArg)
        To value.
        Specified by:
        toValue in class AbstractOperand<java.lang.String>
        Parameters:
        aArg - the arg
        Returns:
        the string
      • 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.