Class AbstractHelp

java.lang.Object

org.apache.rat.help.AbstractHelp

Direct Known Subclasses:

Help, Licenses

public abstract class AbstractHelp
extends Object

The base class to perform Help processing for programs.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	AbstractHelp.RatHelpFormatter	Provides help for formatting text.

Field Summary

Fields

Modifier and Type	Field	Description
static final Function<org.apache.commons.cli.Option, String>	DEPRECATED_MSG	Function to format deprecated display
static final int	HELP_PADDING	The number of chars to indent output with.
static final int	HELP_WIDTH	The width of the help report in chars.
protected final AbstractHelp.RatHelpFormatter	helpFormatter	The help formatter for this instance
protected final VersionInfo	versionInfo	The version info for this instance

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractHelp()	Base class to perform help output.

Method Summary

Modifier and Type	Method	Description
static String	createPadding(int len)	Create a padding.
static String	header(String txt)	Create a section header for the output.

Methods inherited from class Object

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

Field Details

HELP_WIDTH

public static final int HELP_WIDTH

The width of the help report in chars.

See Also:

• Constant Field Values

HELP_PADDING

public static final int HELP_PADDING

The number of chars to indent output with.

See Also:

• Constant Field Values

helpFormatter

protected final AbstractHelp.RatHelpFormatter helpFormatter

The help formatter for this instance

versionInfo

protected final VersionInfo versionInfo

The version info for this instance

DEPRECATED_MSG

public static final Function<org.apache.commons.cli.Option, String> DEPRECATED_MSG

Function to format deprecated display

Constructor Details

AbstractHelp

protected AbstractHelp()

Base class to perform help output.

Method Details

createPadding

public static String createPadding(int len)

Create a padding.

Parameters:

len - The length of the padding in characters.

Returns:

a string with len blanks.

header

public static String header(String txt)

Create a section header for the output.

Parameters:

txt - the text to put in the header.

Returns:

the Header string.