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

Interface ArgsParserBuilder<B extends ArgsParserBuilder<B>>

Type Parameters:
B - the generic type
All Known Subinterfaces:
ParseArgs
All Known Implementing Classes:
ArgsParser
public interface ArgsParserBuilder<B extends ArgsParserBuilder<B>>
This mixin provides builder additions (as of the builder pattern for chained configuring method calls) for parsing command line arguments.

  • Method Summary

    Modifier and Type
    Method
    Description
    B
    withEvalArgs(String[] aArgs)
    Evaluates the provided command line arguments.
    default B
    withEvalArgs(String[] aArgs, Pattern aFilterExp)
    Evaluates the provided command line arguments, filtering (excluding) the arguments matching the provided Pattern.
    default B
    withEvalArgs(String[] aArgs, ArgsFilter aArgsFilter)
    Evaluates the provided command line arguments, filtering (excluding) the arguments matching the provided ArgsFilter.
    default B
    withEvalArgs(List<String> aArgs)
    Evaluates the provided command line arguments .
    default B
    withEvalArgs(List<String> aArgs, Pattern aFilterExp)
    Evaluates the provided command line arguments, filtering (excluding) the arguments matching the provided Pattern.
    default B
    withEvalArgs(List<String> aArgs, ArgsFilter aArgsFilter)
    Evaluates the provided command line arguments, filtering (excluding) the arguments matching the provided ArgsFilter.

  • Method Details

    • withEvalArgs

      default B withEvalArgs(List<String> aArgs) throws ArgsSyntaxException
      Evaluates the provided command line arguments .
      Parameters:
      aArgs - The command line arguments to be evaluated.
      Returns:
      This instance as of the builder pattern to chain further method calls.
      Throws:
      ArgsSyntaxException - thrown in case of a command line arguments mismatch regarding provided and expected args.

    • withEvalArgs

      default B withEvalArgs(List<String> aArgs, ArgsFilter aArgsFilter) throws ArgsSyntaxException
      Evaluates the provided command line arguments, filtering (excluding) the arguments matching the provided ArgsFilter.
      Parameters:
      aArgs - The command line arguments to be evaluated.
      aArgsFilter - The ArgsFilter used to filter (exclude) any "unwanted" or otherwise evaluated arguments.
      Returns:
      This instance as of the builder pattern to chain further method calls.
      Throws:
      ArgsSyntaxException - thrown in case of a command line arguments mismatch regarding provided and expected args.

    • withEvalArgs

      default B withEvalArgs(List<String> aArgs, Pattern aFilterExp) throws ArgsSyntaxException
      Evaluates the provided command line arguments, filtering (excluding) the arguments matching the provided Pattern.
      Parameters:
      aArgs - The command line arguments to be evaluated.
      aFilterExp - The Pattern used to filter (exclude) any "unwanted" or otherwise evaluated arguments.
      Returns:
      This instance as of the builder pattern to chain further method calls.
      Throws:
      ArgsSyntaxException - thrown in case of a command line arguments mismatch regarding provided and expected args.

    • withEvalArgs

      B withEvalArgs(String[] aArgs) throws ArgsSyntaxException
      Evaluates the provided command line arguments.
      Parameters:
      aArgs - The command line arguments to be evaluated.
      Returns:
      This instance as of the builder pattern to chain further method calls.
      Throws:
      ArgsSyntaxException - thrown in case of a command line arguments mismatch regarding provided and expected args.

    • withEvalArgs

      default B withEvalArgs(String[] aArgs, ArgsFilter aArgsFilter) throws ArgsSyntaxException
      Evaluates the provided command line arguments, filtering (excluding) the arguments matching the provided ArgsFilter.
      Parameters:
      aArgs - The command line arguments to be evaluated.
      aArgsFilter - The ArgsFilter used to filter (exclude) any "unwanted" or otherwise evaluated arguments.
      Returns:
      This instance as of the builder pattern to chain further method calls.
      Throws:
      ArgsSyntaxException - thrown in case of a command line arguments mismatch regarding provided and expected args.

    • withEvalArgs

      default B withEvalArgs(String[] aArgs, Pattern aFilterExp) throws ArgsSyntaxException
      Evaluates the provided command line arguments, filtering (excluding) the arguments matching the provided Pattern.
      Parameters:
      aArgs - The command line arguments to be evaluated.
      aFilterExp - The Pattern used to filter (exclude) any "unwanted" or otherwise evaluated arguments.
      Returns:
      This instance as of the builder pattern to chain further method calls.
      Throws:
      ArgsSyntaxException - thrown in case of a command line arguments mismatch regarding provided and expected args.