Class CharDirective

java.lang.Object
org.refcodes.cli.AbstractOperand<Character>
org.refcodes.cli.AbstractDirective<Character>
org.refcodes.cli.CharDirective
All Implemented Interfaces:
Cloneable, Comparable<Operand<?>>, Directive<Character>, MatchCountAccessor, Operand<Character>, OperationAccessor, ParsedArgsAccessor, Synopsisable, Term, ExceptionAccessor<ArgsSyntaxException>, VisibleAccessor, VisibleAccessor.VisibleBuilder<Term>, VisibleAccessor.VisibleMutator, VisibleAccessor.VisibleProperty, AliasAccessor, Clonable, DescriptionAccessor, Resetable, TypeAccessor<Character>, ValueAccessor<Character>, Diagnosable, Schemable<DiagnosticOptions>
public class CharDirective extends AbstractDirective<Character>
The CharDirective represents a Directive holding String values.

  • Field Details

    • _description

      protected String _description

    • _exception

      protected ArgsSyntaxException _exception

    • _isVisible

      protected boolean _isVisible

  • Constructor Details

    • CharDirective

      public CharDirective(String aOperation, String aDescription)
      Instantiates a new CharDirective with the given arguments. In case a long option is provided, the intance's alias will automatically be set with the long option, else the short option is used as alias.
      Parameters:
      aOperation - The operation identifying this CharDirective.
      aDescription - The description of the CharDirective

    • CharDirective

      public CharDirective(String aOperation, String aDescription, Consumer<CharDirective> aConsumer)
      Instantiates a new CharDirective with the given arguments. In case a long option is provided, the intance's alias will automatically be set with the long option, else the short option is used as alias.
      Parameters:
      aOperation - The operation identifying this CharDirective.
      aDescription - The description of the CharDirective.
      aConsumer - The Consumer being invoked in case this CharDirective participated in successfully parsing the command line arguments.

    • CharDirective

      public CharDirective(String aOperation, String aAlias, String aDescription)
      Instantiates a new CharDirective with the given arguments.
      Parameters:
      aOperation - The operation identifying this CharDirective.
      aAlias - The alias to be used for naming purposes.
      aDescription - The description of the CharDirective

    • CharDirective

      public CharDirective(String aOperation, String aAlias, String aDescription, Consumer<CharDirective> aConsumer)
      Instantiates a new CharDirective with the given arguments.
      Parameters:
      aOperation - The operation identifying this CharDirective.
      aAlias - The alias to be used for naming purposes.
      aDescription - The description of the CharDirective.
      aConsumer - The Consumer being invoked in case this CharDirective participated in successfully parsing the command line arguments.

    • CharDirective

      public CharDirective(Relation<String, Character> aProperty)
      Instantiates a new CharDirective with the alias being the proerty's key and the value being the property's value. Depending on the provided property's key, the key is either used for the short option or the long option.
      Parameters:
      aProperty - The key (=alias) and the value for the operand.

    • CharDirective

      public CharDirective(Relation<String, Character> aProperty, Consumer<CharDirective> aConsumer)
      Instantiates a new CharDirective with the alias being the proerty's key and the value being the property's value. Depending on the provided property's key, the key is either used for the short option or the long option.
      Parameters:
      aProperty - The key (=alias) and the value for the operand.
      aConsumer - The Consumer being invoked in case this CharDirective participated in successfully parsing the command line arguments.

  • Method Details

    • withVisible

      public CharDirective withVisible(boolean isVisible)

      Visibility in this context means displaying or hiding this Term's existence to the user (defaults to true).

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

    • getDescription

      public String getDescription()
      Specified by:
      getDescription in interface DescriptionAccessor

    • getException

      public ArgsSyntaxException getException()
      Retrieves the ArgsSyntaxException exception in case invoking Term.parseArgs(String[], CliContext) failed. The exception (and the according suppressed ones alongside the causes) does not necessarily have been thrown by the Term.parseArgs(String[], CliContext) method depending on the semantics of the Term handing the exception (the AnyCondition provides any exceptions it caught even though it did not throw them as of its semantics).
      Specified by:
      getException in interface ExceptionAccessor<ArgsSyntaxException>
      Specified by:
      getException in interface Term
      Returns:
      The ArgsSyntaxException exception occurring while parsing the arguments.

    • setVisible

      public void setVisible(boolean isVisible)

      Visibility in this context means displaying or hiding this Term's existence to the user (defaults to true).

      Specified by:
      setVisible in interface Term
      Specified by:
      setVisible in interface VisibleAccessor.VisibleMutator

    • isVisible

      public boolean isVisible()

      Visibility in this context means displaying or hiding this Term's existence to the user (defaults to true).

      Specified by:
      isVisible in interface Term
      Specified by:
      isVisible in interface VisibleAccessor

    • toArgsDiff

      protected static String[] toArgsDiff(String[] aArgs, List<? extends Operand<?>> aArgsSubset)
      Creates the difference between the provided set and the provided Lists therein found argument arrays subset (as of Operand.getParsedArgs()).
      Parameters:
      aArgs - The set to be used for the diff operation.
      aArgsSubset - The subset to be used for the diff operation being the lists containing the Operand instances whose command line arguments are to be diffed.
      Returns:
      The difference between the set and the subset.

    • toArgsDiff

      protected static String[] toArgsDiff(String[] aArgs, Operand<?>[] aArgsSubset)
      Creates the difference between the provided set and the provided Lists therein found argument arrays subset (as of Operand.getParsedArgs()).
      Parameters:
      aArgs - The set to be used for the diff operation.
      aArgsSubset - The subset to be used for the diff operation being the lists containing the Operand instances whose command line arguments are to be diffed.
      Returns:
      The difference between the set and the subset.

    • toArgsDiff

      protected static String[] toArgsDiff(String[] aArgs, String[] aArgsSubset)
      Creates the difference between the provided set and the provided subset.
      Parameters:
      aArgs - The set to be used for the diff operation.
      aArgsSubset - The subset to be used for the diff operation.
      Returns:
      The difference between the set and the subset.

    • toParsedArgs

      protected static String[] toParsedArgs(Operand<?>[]... aOperands)
      Takes all Operand instances found in the provided Lists and adds all therein found argument arrays (as of Operand.getParsedArgs()) to the result.
      Parameters:
      aOperands - The lists containing the Operand instances whose command line arguments are to be added to the result.
      Returns:
      All the command line arguments detected in the provided Operands Lists.