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

Interface ArgsProvidierBuilder<B extends ArgsProvidierBuilder<B>>

Type Parameters:
B - The builder type for chaining builder methods.
public interface ArgsProvidierBuilder<B extends ArgsProvidierBuilder<B>>
The ArgsProvidierBuilder interface provides builder methods for feeding command line arguments.

  • Method Summary

    Modifier and Type
    Method
    Description
    B
    withArgs(String[] aArgs)
    Builder method providing the application's command line arguments.
    default B
    withArgs(String[] aArgs, Pattern aFilterExp)
    Builder method providing the application's command line arguments, filtering (excluding) the arguments matching the provided Pattern.
    default B
    withArgs(String[] aArgs, ArgsFilter aArgsFilter)
    Builder method providing the application's command line arguments, filtering (excluding) the arguments matching the provided ArgsFilter.
    B
    withArgs(List<String> aArgs)
    Builder method providing the application's command line arguments.
    default B
    withArgs(List<String> aArgs, Pattern aFilterExp)
    Builder method providing the application's command line arguments, filtering (excluding) the arguments matching the provided Pattern.
    default B
    withArgs(List<String> aArgs, ArgsFilter aArgsFilter)
    Builder method providing the application's command line arguments, filtering (excluding) the arguments matching the provided ArgsFilter.

  • Method Details

    • withArgs

      B withArgs(List<String> aArgs)
      Builder method providing the application's command line arguments.
      Parameters:
      aArgs - The application's command line arguments.
      Returns:
      This builder as of the builder pattern.

    • withArgs

      default B withArgs(List<String> aArgs, ArgsFilter aArgsFilter)
      Builder method providing the application's command line arguments, filtering (excluding) the arguments matching the provided ArgsFilter.
      Parameters:
      aArgs - The application's command line arguments.
      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.

    • withArgs

      default B withArgs(List<String> aArgs, Pattern aFilterExp)
      Builder method providing the application's command line arguments, filtering (excluding) the arguments matching the provided Pattern.
      Parameters:
      aArgs - The application's command line arguments.
      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.

    • withArgs

      B withArgs(String[] aArgs)
      Builder method providing the application's command line arguments.
      Parameters:
      aArgs - The application's command line arguments.
      Returns:
      This builder as of the builder pattern.

    • withArgs

      default B withArgs(String[] aArgs, ArgsFilter aArgsFilter)
      Builder method providing the application's command line arguments, filtering (excluding) the arguments matching the provided ArgsFilter.
      Parameters:
      aArgs - The application's command line arguments.
      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.

    • withArgs

      default B withArgs(String[] aArgs, Pattern aFilterExp)
      Builder method providing the application's command line arguments, filtering (excluding) the arguments matching the provided Pattern.
      Parameters:
      aArgs - The application's command line arguments.
      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.