Class HelpFormatter.Builder

    • Constructor Detail

    • Method Detail

      • setPrintWriter

        public HelpFormatter.Builder setPrintWriter​(java.io.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​(java.util.function.Function<Option,​java.lang.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