Class HelpFormatter.Builder

java.lang.Object
org.apache.commons.cli.HelpFormatter.Builder
All Implemented Interfaces:
Supplier<HelpFormatter>
Enclosing class:
HelpFormatter

public static class HelpFormatter.Builder extends Object implements Supplier<HelpFormatter>
Since:
1.7.0
  • Field Details

    • DEFAULT_DEPRECATED_FORMAT

      private static final Function<Option,String> DEFAULT_DEPRECATED_FORMAT
      A function to convert a description (not null) and a deprecated Option (not null) to help description
    • deprecatedFormatFunction

      private Function<Option,String> deprecatedFormatFunction
      Formatter for deprecated options.
    • printStream

      private PrintWriter printStream
      The output PrintWriter, defaults to wrapping System.out.
    • showSince

      private boolean showSince
      The flag to determine if the since values should be dispalyed
  • Constructor Details

    • Builder

      public Builder()
  • Method Details

    • get

      public HelpFormatter get()
      Specified by:
      get in interface Supplier<HelpFormatter>
    • setPrintWriter

      public HelpFormatter.Builder setPrintWriter(PrintWriter printWriter)
      Sets the output PrintWriter, defaults to wrapping System.out.
      Parameters:
      printWriter - the output PrintWriter, not null.
      Returns:
      this instance.
    • setShowDeprecated

      public HelpFormatter.Builder setShowDeprecated(boolean useDefaultFormat)
      Sets whether to show deprecated options.
      Parameters:
      useDefaultFormat - if true use the default format, otherwise clear the formatter.
      Returns:
      this instance.
    • setShowDeprecated

      public HelpFormatter.Builder setShowDeprecated(Function<Option,String> deprecatedFormatFunction)
      Sets whether to show deprecated options.
      Parameters:
      deprecatedFormatFunction - Specify the format for the deprecated options.
      Returns:
      this instance.
      Since:
      1.8.0
    • setShowSince

      public HelpFormatter.Builder setShowSince(boolean showSince)
      Sets whether to show the date the option was first added.
      Parameters:
      showSince - if @{code true} the date the options was first added will be shown.
      Returns:
      this builder.
      Since:
      1.9.0