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

Class CharOption

java.lang.Object
org.refcodes.cli.AbstractOperand<T>
org.refcodes.cli.AbstractOption<Character>
org.refcodes.cli.CharOption
All Implemented Interfaces:
Cloneable, Comparable<Operand<?>>, ArgsAccessor, Operand<Character>, Option<Character>, Synopsisable, Syntaxable, org.refcodes.mixin.AliasAccessor, org.refcodes.mixin.Clonable, org.refcodes.mixin.DescriptionAccessor, org.refcodes.mixin.Resetable, org.refcodes.mixin.Schemable<CliSchema>, org.refcodes.mixin.TypeAccessor<Character>, org.refcodes.mixin.ValueAccessor<Character>
public class CharOption extends AbstractOption<Character>
The CharOption represents an Option holding String values.

  • Constructor Details

    • CharOption

      public CharOption(String aShortOption, String aLongOption, String aAlias, String aDescription)
      Instantiates a new character option.
      Parameters:
      aShortOption - the short option
      aLongOption - the long option
      aAlias - the option arg name
      aDescription - the description

    • CharOption

      public CharOption(String aLongOption, String aAlias, String aDescription)
      Instantiates a new character option.
      Parameters:
      aLongOption - the long option
      aAlias - the option arg name
      aDescription - the description

    • CharOption

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

  • Method Details

    • toType

      protected Character toType(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:
      toType in class AbstractOperand<Character>
      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.

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