Package org.apache.commons.cli
Class HelpFormatter.Builder
java.lang.Object
org.apache.commons.cli.HelpFormatter.Builder
- All Implemented Interfaces:
Supplier<HelpFormatter>
- Enclosing class:
- HelpFormatter
Builds
HelpFormatter.- Since:
- 1.7.0
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionget()setPrintWriter(PrintWriter printWriter) Sets the output PrintWriter, defaults to wrappingSystem.out.setShowDeprecated(boolean useDefaultFormat) Sets whether to show deprecated options.setShowDeprecated(Function<Option, String> deprecatedFormatFunction) Sets whether to show deprecated options.setShowSince(boolean showSince) Sets whether to show the date the option was first added.
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
get
- Specified by:
getin interfaceSupplier<HelpFormatter>
-
setPrintWriter
Sets the output PrintWriter, defaults to wrappingSystem.out.- Parameters:
printWriter- the output PrintWriter, not null.- Returns:
thisinstance.
-
setShowDeprecated
Sets whether to show deprecated options.- Parameters:
useDefaultFormat- iftrueuse the default format, otherwise clear the formatter.- Returns:
thisinstance.
-
setShowDeprecated
Sets whether to show deprecated options.- Parameters:
deprecatedFormatFunction- Specify the format for the deprecated options.- Returns:
thisinstance.- Since:
- 1.8.0
-
setShowSince
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
-