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

Interface ArgsProcessorBuilder<B extends ArgsProcessorBuilder<B>>

Type Parameters:
B - The type of the builder to be returned for chaining of operations.
All Superinterfaces:
ArgsSyntaxAccessor.ArgsSyntaxBuilder<B>, ArgumentEscapeCodeAccessor.ArgumentEscapeCodeBuilder<B>, BannerBorderEscapeCodeAccessor.BannerBorderEscapeCodeBuilder<B>, BannerEscapeCodeAccessor.BannerEscapeCodeBuilder<B>, BannerFontAccessor.BannerFontBuilder<B>, BannerFontPaletteAccessor.BannerFontPaletteBuilder<B>, CommandEscapeCodeAccessor.CommandEscapeCodeBuilder<B>, org.refcodes.mixin.ConsoleWidthAccessor.ConsoleWidthBuilder<B>, CopyrightAccessor.CopyrightBuilder<B>, org.refcodes.mixin.DescriptionAccessor.DescriptionBuilder<B>, DescriptionEscapeCodeAccessor.DescriptionEscapeCodeBuilder<B>, org.refcodes.mixin.EscapeCodesStatusAccessor.EscapeCodeStatusBuilder<B>, ExamplesAccessor.ExamplesBuilder<B>, LicenseAccessor.LicenseBuilder<B>, org.refcodes.mixin.LineBreakAccessor.LineBreakBuilder<B>, LineSeparatorEscapeCodeAccessor.LineSeparatorEscapeCodeBuilder<B>, LongOptionPrefixAccessor.LongOptionPrefixBuilder<B>, org.refcodes.mixin.MaxConsoleWidthAccessor.MaxConsoleWidthBuilder<B>, org.refcodes.mixin.NameAccessor.NameBuilder<B>, OptionEscapeCodeAccessor.OptionEscapeCodeBuilder<B>, org.refcodes.mixin.ResetEscapeCodeAccessor.ResetEscapeCodeBuilder<B>, ShortOptionPrefixAccessor.ShortOptionPrefixBuilder<B>, SyntaxMetricsAccessor.SyntaxMetricsBuilder<B>, org.refcodes.textual.TextBoxGridAccessor.TextBoxGridBuilder<B>, org.refcodes.mixin.TitleAccessor.TitleBuilder<B>
All Known Subinterfaces:
ParseArgs
All Known Implementing Classes:
ArgsParser
public interface ArgsProcessorBuilder<B extends ArgsProcessorBuilder<B>> extends org.refcodes.mixin.LineBreakAccessor.LineBreakBuilder<B>, LineSeparatorEscapeCodeAccessor.LineSeparatorEscapeCodeBuilder<B>, DescriptionEscapeCodeAccessor.DescriptionEscapeCodeBuilder<B>, LicenseAccessor.LicenseBuilder<B>, CopyrightAccessor.CopyrightBuilder<B>, org.refcodes.mixin.ConsoleWidthAccessor.ConsoleWidthBuilder<B>, org.refcodes.mixin.MaxConsoleWidthAccessor.MaxConsoleWidthBuilder<B>, BannerFontPaletteAccessor.BannerFontPaletteBuilder<B>, BannerFontAccessor.BannerFontBuilder<B>, CommandEscapeCodeAccessor.CommandEscapeCodeBuilder<B>, BannerEscapeCodeAccessor.BannerEscapeCodeBuilder<B>, BannerBorderEscapeCodeAccessor.BannerBorderEscapeCodeBuilder<B>, ExamplesAccessor.ExamplesBuilder<B>, org.refcodes.mixin.TitleAccessor.TitleBuilder<B>, org.refcodes.mixin.NameAccessor.NameBuilder<B>, org.refcodes.mixin.DescriptionAccessor.DescriptionBuilder<B>, org.refcodes.mixin.EscapeCodesStatusAccessor.EscapeCodeStatusBuilder<B>, org.refcodes.mixin.ResetEscapeCodeAccessor.ResetEscapeCodeBuilder<B>, OptionEscapeCodeAccessor.OptionEscapeCodeBuilder<B>, ArgumentEscapeCodeAccessor.ArgumentEscapeCodeBuilder<B>, SyntaxMetricsAccessor.SyntaxMetricsBuilder<B>, ShortOptionPrefixAccessor.ShortOptionPrefixBuilder<B>, LongOptionPrefixAccessor.LongOptionPrefixBuilder<B>, org.refcodes.textual.TextBoxGridAccessor.TextBoxGridBuilder<B>, ArgsSyntaxAccessor.ArgsSyntaxBuilder<B>
The ArgsProcessorBuilder provides common minimum builder functionality required by to build an argument processing instance.

  • Method Details

    • withAddExample

      B withAddExample(Example aExamples)
      Builder method adding an application's Example element.
      Parameters:
      aExamples - The application's Example element to be added.
      Returns:
      This builder as of the builder pattern.

    • withAddExample

      B withAddExample(String aDescription, Operand<?>... aOperands)
      Builder method adding an application's Example element.
      Parameters:
      aDescription - The example's description.
      aOperands - The command line arguments required by the example.
      Returns:
      This builder as of the builder pattern.

    • withErrorOut

      B withErrorOut(PrintStream aErrorOut)
      Set the error out PrintStream and make other adjustments with the result (with regards to the Builder-Pattern).
      Parameters:
      aErrorOut - The error out PrintStream to set.
      Returns:
      This instance with regard to the builder pattern.

    • withSeparatorLnChar

      B withSeparatorLnChar(char aSeparatorLnChar)
      Builder method adding an separator line char.
      Parameters:
      aSeparatorLnChar - THe according separator line char to use.
      Returns:
      This builder as of the builder pattern.

    • withStandardOut

      B withStandardOut(PrintStream aStandardOut)
      Set the standard out PrintStream and make other adjustments with the result (with regards to the Builder-Pattern).
      Parameters:
      aStandardOut - The standard out PrintStream to set.
      Returns:
      This instance with regard to the builder pattern.