HelpFormatter.Builder

java.lang.Object

org.apache.commons.cli.help.AbstractHelpFormatter.Builder<HelpFormatter.Builder,HelpFormatter>

org.apache.commons.cli.help.HelpFormatter.Builder

All Implemented Interfaces:: Supplier<HelpFormatter>

Enclosing class:: HelpFormatter

public static class HelpFormatter.Builder extends AbstractHelpFormatter.Builder<HelpFormatter.Builder,HelpFormatter>

A builder for the HelpFormatter. Intended to make more complex uses of the HelpFormatter class easier. Default values are:

showSince = true
helpAppendable = a TextHelpAppendable writing to System.out
optionFormatter.Builder = the default OptionFormatter.Builder

Field Summary

Fields

Modifier and Type

Field

Description

private boolean

showSince

If true show the "Since" column, otherwise ignore it.
Constructor Summary

Constructors

Modifier

Constructor

Description

protected

Builder()

Constructs a new instace.
Method Summary

Modifier and Type

Method

Description

HelpFormatter

get()

HelpFormatter.Builder

setShowSince(boolean showSince)

Sets the showSince flag.

Methods inherited from class org.apache.commons.cli.help.AbstractHelpFormatter.Builder
asThis, getComparator, getHelpAppendable, getOptionFormatBuilder, getOptionGroupSeparator, setComparator, setHelpAppendable, setOptionFormatBuilder, setOptionGroupSeparator

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details
- showSince
  
  private boolean showSince
  
  If true show the "Since" column, otherwise ignore it.
Constructor Details
- Builder
  
  protected Builder()
  
  Constructs a new instace.
  Sets showSince to true.
Method Details
- get
  
  public HelpFormatter get()
- setShowSince
  
  public HelpFormatter.Builder setShowSince(boolean showSince)
  
  Sets the showSince flag.
  
  Parameters:
  
  showSince - the desired value of the showSince flag.
  
  Returns:
  
  this instance.