com.pivotal.gemfirexd.tools.internal

Class GfxdHelpFormatter

java.lang.Object

org.apache.commons.cli.HelpFormatter

com.pivotal.gemfirexd.tools.internal.GfxdHelpFormatter

public final class GfxdHelpFormatter
extends org.apache.commons.cli.HelpFormatter

Overrides commons CLI HelpFormatter to change formatting as per GemFireXD (in particular use '=' to separate option and value rather than a space). Like GfxdOption this will probably better also go into a modified version of commons CLI HelpFormatter since that class does not look to be designed to be overridden.

Since:

7.0

Field Summary

Fields inherited from class org.apache.commons.cli.HelpFormatter

DEFAULT_ARG_NAME, DEFAULT_DESC_PAD, DEFAULT_LEFT_PAD, DEFAULT_LONG_OPT_PREFIX, DEFAULT_LONG_OPT_SEPARATOR, DEFAULT_OPT_PREFIX, DEFAULT_SYNTAX_PREFIX, DEFAULT_WIDTH, defaultArgName, defaultDescPad, defaultLeftPad, defaultLongOptPrefix, defaultNewLine, defaultOptPrefix, defaultSyntaxPrefix, defaultWidth, optionComparator

Constructor Summary

Constructors

Constructor and Description
GfxdHelpFormatter()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	appendOption(StringBuilder buff, org.apache.commons.cli.Option option, boolean required) Appends the usage clause for an Option to a StringBuffer.
protected void	appendOptionGroup(StringBuilder buff, org.apache.commons.cli.OptionGroup group) Appends the usage clause for an OptionGroup to a StringBuilder.
String	getSyntaxPrefix() Returns the 'syntaxPrefix'.
void	printUsage(PrintWriter pw, int width, String cmdLineSyntax) Print the cmdLineSyntax to the specified writer, using the specified width.
void	printUsage(PrintWriter pw, int width, String app, org.apache.commons.cli.Options options) Prints the usage statement for the specified application.
protected StringBuffer	renderOptions(StringBuffer sb, int width, org.apache.commons.cli.Options options, int leftPad, int descPad) Render the specified Options and return the rendered Options in a StringBuffer.

Methods inherited from class org.apache.commons.cli.HelpFormatter

createPadding, findWrapPos, getArgName, getDescPadding, getLeftPadding, getLongOptPrefix, getLongOptSeparator, getNewLine, getOptionComparator, getOptPrefix, getWidth, printHelp, printHelp, printHelp, printHelp, printHelp, printHelp, printHelp, printHelp, printOptions, printWrapped, printWrapped, renderWrappedText, rtrim, setArgName, setDescPadding, setLeftPadding, setLongOptPrefix, setLongOptSeparator, setNewLine, setOptionComparator, setOptPrefix, setSyntaxPrefix, setWidth

Methods inherited from class java.lang.Object

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

Constructor Detail

GfxdHelpFormatter

public GfxdHelpFormatter()

Method Detail

printUsage

public void printUsage(PrintWriter pw,
              int width,
              String cmdLineSyntax)

Print the cmdLineSyntax to the specified writer, using the specified width.

Overrides:

printUsage in class org.apache.commons.cli.HelpFormatter

Parameters:

pw - The printWriter to write the help to

width - The number of characters per line for the usage statement.

cmdLineSyntax - The usage statement.

printUsage

public void printUsage(PrintWriter pw,
              int width,
              String app,
              org.apache.commons.cli.Options options)

Prints the usage statement for the specified application.

Overrides:

printUsage in class org.apache.commons.cli.HelpFormatter

Parameters:

pw - The PrintWriter to print the usage statement

width - The number of characters to display per line

app - The application name

options - The command line Options

getSyntaxPrefix

public String getSyntaxPrefix()

Returns the 'syntaxPrefix'.

Overrides:

getSyntaxPrefix in class org.apache.commons.cli.HelpFormatter

appendOptionGroup

protected void appendOptionGroup(StringBuilder buff,
                     org.apache.commons.cli.OptionGroup group)

Appends the usage clause for an OptionGroup to a StringBuilder. The clause is wrapped in square brackets if the group is not required. The display of the options is handled by appendOption

Parameters:

buff - the StringBuilder to append to

group - the group to append

See Also:

HelpFormatter.appendOption(StringBuffer,Option,boolean)

appendOption

protected void appendOption(StringBuilder buff,
                org.apache.commons.cli.Option option,
                boolean required)

Appends the usage clause for an Option to a StringBuffer.

Parameters:

buff - the StringBuffer to append to

option - the Option to append

required - whether the Option is required or not

renderOptions

protected StringBuffer renderOptions(StringBuffer sb,
                         int width,
                         org.apache.commons.cli.Options options,
                         int leftPad,
                         int descPad)

Render the specified Options and return the rendered Options in a StringBuffer.

Overrides:

renderOptions in class org.apache.commons.cli.HelpFormatter

Parameters:

sb - The StringBuffer to place the rendered Options into.

width - The number of characters to display per line

options - The command line Options

leftPad - the number of characters of padding to be prefixed to each line

descPad - the number of characters of padding to be prefixed to each description line

Returns:

the StringBuffer with the rendered Options contents.