net.morimekta.console.args

Class ArgumentOptions

java.lang.Object

net.morimekta.console.args.ArgumentOptions

public class ArgumentOptions
extends Object

Options for configuring the argument parser.

Constructor Summary

Constructors

Constructor and Description
ArgumentOptions(STTY tty)

Method Summary

Modifier and Type	Method and Description
static ArgumentOptions	defaults()
static ArgumentOptions	defaults(STTY tty)
boolean	getDefaultsShown()
Comparator<BaseOption>	getOptionComparator()
int	getUsageWidth()
ArgumentOptions	withDefaultsShown(boolean show) Set whether the default values should be printed in usage.
ArgumentOptions	withMaxUsageWidth(int maxWidth) Set the maximum usage width.
ArgumentOptions	withOptionComparator(Comparator<BaseOption> comparator)
ArgumentOptions	withUsageWidth(int usageWidth) Set the number of columns to be used for usage printing.

Methods inherited from class java.lang.Object

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

Constructor Detail

ArgumentOptions

public ArgumentOptions(STTY tty)

Method Detail

defaults

public static ArgumentOptions defaults()

defaults

public static ArgumentOptions defaults(STTY tty)

withDefaultsShown

public ArgumentOptions withDefaultsShown(boolean show)

Set whether the default values should be printed in usage.

Parameters:

show - If the default values should be printed.

Returns:

The Argument options.

getDefaultsShown

public boolean getDefaultsShown()

Returns:

True if the default values should be printed in usage.

withUsageWidth

public ArgumentOptions withUsageWidth(int usageWidth)

Set the number of columns to be used for usage printing.

Parameters:

usageWidth - The number of columns.

Returns:

The Argument options.

withMaxUsageWidth

public ArgumentOptions withMaxUsageWidth(int maxWidth)

Set the maximum usage width. The width is set as wide as possible based on the terminal column count, but maximum the maxWidth.

Parameters:

maxWidth - The maximum width.

Returns:

The Argument options.

getUsageWidth

public int getUsageWidth()

Returns:

Number of columns to be used for usage printing.

withOptionComparator

public ArgumentOptions withOptionComparator(Comparator<BaseOption> comparator)

getOptionComparator

public Comparator<BaseOption> getOptionComparator()