Class VerboseFlagImpl

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


    public class VerboseFlagImpl
    extends FlagImpl
    A predefined verbose switch.
    • 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
      VerboseFlagImpl​()
      Constructs the predefined verbose switch.
      VerboseFlagImpl​(java.lang.String aDescription)
      Constructs the predefined verbose switch.
    • Constructor Detail

      • VerboseFlagImpl

        public VerboseFlagImpl​(java.lang.String aDescription)
        Constructs the predefined verbose switch.
        Parameters:
        aDescription - A description without any line breaks.
      • VerboseFlagImpl

        public VerboseFlagImpl​()
        Constructs the predefined verbose switch.
    • Method Detail

      • 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.