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

public static final class HelpFormatter.Builder
extends Object
implements Supplier<HelpFormatter>

Builds HelpFormatter.

Since:

1.7.0

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
HelpFormatter	get()
HelpFormatter.Builder	setPrintWriter(PrintWriter printWriter)	Sets the output PrintWriter, defaults to wrapping System.out.
HelpFormatter.Builder	setShowDeprecated(boolean showDeprecated)	Sets whether to show deprecated options.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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.

setShowDeprecated

public HelpFormatter.Builder setShowDeprecated(boolean showDeprecated)

Sets whether to show deprecated options.

Parameters:

showDeprecated - Whether to show deprecated options.

Returns:

this.