com.hp.util.syntax.usage

Class ColumnarTextFormat

java.lang.Object

com.hp.util.syntax.usage.ColumnarTextFormat

public class ColumnarTextFormat
extends Object

Utility class for justifying columnar text output.

Author:

Steve Britt, Thomas Vachuska

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_EOL Maximum length allowed for formatted help text output.
static int	DEFAULT_MAXIMUM_LINE_LENGTH Maximum length allowed for formatted help text output.

Constructor Summary

Constructors

Constructor and Description
ColumnarTextFormat()

Method Summary

Modifier and Type	Method and Description
static String	alignBlock(String toFormat, int leftSpaces) Utility method that formats the provided String according to the assumption that it is composed of one continuous block of text that should be justified, using the default maximum line length.
static String	alignBlock(String toFormat, int leftSpaces, int maximumLineLength, String eol) Utility method that formats the provided String according to the assumption that it is composed of one continuous block of text that should be justified.
static String	alignTwoColumns(String toFormat, int leftSpaces, int separatingSpaces) Utility method that formats the provided String according to the assumption that it is composed of newline-delimited lines, and that each line has the space-delimited format "left right".
static String	alignTwoColumns(String toFormat, int leftSpaces, int separation, int separator) Utility method that formats the provided String according to the assumption that it is composed of newline-delimited lines, and that each line has the space-delimited format "left right".
static String	alignTwoColumns(String toFormat, int leftSpaces, int separation, int separator, int maximumLineLength) Utility method that formats the provided String according to the assumption that it is composed of newline-delimited lines, and that each line has the space-delimited format "left right".
static String	alignTwoColumns(String toFormat, int leftSpaces, int separation, int separator, int maximumLineLength, String eol) Utility method that formats the provided String according to the assumption that it is composed of newline-delimited lines, and that each line has the space-delimited format "left right".
static String	produceTwoColumns(List<String> leftColumn, int leftOffsetSpaces, List<String> rightColumn, int betweenOffset, int betweenCharacter, int maximumLineLength, String eol) Formats one String combining the contents of the provided Vectors assuming each to be parallel in number of entries.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_MAXIMUM_LINE_LENGTH

public static final int DEFAULT_MAXIMUM_LINE_LENGTH

Maximum length allowed for formatted help text output.

See Also:

Constant Field Values

DEFAULT_EOL

public static final String DEFAULT_EOL

Maximum length allowed for formatted help text output.

See Also:

Constant Field Values

Constructor Detail

ColumnarTextFormat

public ColumnarTextFormat()

Method Detail

alignBlock

public static String alignBlock(String toFormat,
                                int leftSpaces)

Utility method that formats the provided String according to the assumption that it is composed of one continuous block of text that should be justified, using the default maximum line length.

Parameters:

toFormat - string to be formatted

leftSpaces - number of spaces on the left indent

Returns:

formatted string

alignBlock

public static String alignBlock(String toFormat,
                                int leftSpaces,
                                int maximumLineLength,
                                String eol)

Utility method that formats the provided String according to the assumption that it is composed of one continuous block of text that should be justified.

Parameters:

toFormat - string to be formatted

leftSpaces - number of spaces on the left indent

maximumLineLength - max line length before wrapping to next line

eol - end of line string to use for wrapping to next line

Returns:

formatted string

alignTwoColumns

public static String alignTwoColumns(String toFormat,
                                     int leftSpaces,
                                     int separatingSpaces)

Utility method that formats the provided String according to the assumption that it is composed of newline-delimited lines, and that each line has the space-delimited format "left right". The right value may actually consist of multiple words but the left value must be one word. Assumes the default maximum line length and that the left and right columns will be separated only by spaces.

Parameters:

toFormat - string to be formatted

leftSpaces - number of spaces on the left indent

separatingSpaces - number of spaces for separating two columns

Returns:

formatted string

alignTwoColumns

public static String alignTwoColumns(String toFormat,
                                     int leftSpaces,
                                     int separation,
                                     int separator)

Utility method that formats the provided String according to the assumption that it is composed of newline-delimited lines, and that each line has the space-delimited format "left right". The right value may actually consist of multiple words but the left value must be one word. Assumes the default maximum line length.

Parameters:

toFormat - string to be formatted

leftSpaces - number of spaces on the left indent

separation - number of separators for separating two columns

separator - separator character

Returns:

formatted string

alignTwoColumns

public static String alignTwoColumns(String toFormat,
                                     int leftSpaces,
                                     int separation,
                                     int separator,
                                     int maximumLineLength)

Utility method that formats the provided String according to the assumption that it is composed of newline-delimited lines, and that each line has the space-delimited format "left right". The right value may actually consist of multiple words but the left value must be one word. This method can be built on top of a more generalized method at some point when there is more time available.

Parameters:

toFormat - string to be formatted

leftSpaces - number of spaces on the left indent

separation - number of separators for separating two columns

separator - separator character

maximumLineLength - max line length before wrapping to next line

Returns:

formatted string

alignTwoColumns

public static String alignTwoColumns(String toFormat,
                                     int leftSpaces,
                                     int separation,
                                     int separator,
                                     int maximumLineLength,
                                     String eol)

Utility method that formats the provided String according to the assumption that it is composed of newline-delimited lines, and that each line has the space-delimited format "left right". The right value may actually consist of multiple words but the left value must be one word. This method can be built on top of a more generalized method at some point when there is more time available.

Parameters:

toFormat - string to be formatted

leftSpaces - number of spaces on the left indent

separation - number of separators for separating two columns

separator - separator character

maximumLineLength - max line length before wrapping to next line

eol - end of line string to use for wrapping to next line

Returns:

formatted string

produceTwoColumns

public static String produceTwoColumns(List<String> leftColumn,
                                       int leftOffsetSpaces,
                                       List<String> rightColumn,
                                       int betweenOffset,
                                       int betweenCharacter,
                                       int maximumLineLength,
                                       String eol)

Formats one String combining the contents of the provided Vectors assuming each to be parallel in number of entries. Assumes that the output will be a series of newline-separated lines of this form:

left right

The left values are extracted from one Vector and the right values from a separate vector, with the number of blank spaces maintained on the left and between columns user-specifiable. The leftmost values are assumed to be relatively short in length. The rightmost values are assumed to be (potentially) long, and will be split into lines. Note that both left and right values may each be multiple words, but the left value will not be split into lines even so. Each right value is split into its individual tokens using a space separator. The longest leftmost value is found, then all left values are justified so they line up and are indented by the specified number of spaces. Then the rightmost values are split into multiple lines by how much space remains on a line and indented appropriately.

The separation between columns will actually be a number of the specified separating characters bookended by blank spaces, one on each end. If two or fewer separating characters then only spaces are applied.

This method can be built on top of a more generalized method at some point when there is more time available.

Parameters:

leftColumn - left column values

leftOffsetSpaces - left offset

rightColumn - right column values

betweenOffset - spacing offset

betweenCharacter - spacing character

maximumLineLength - maximum line length

eol - of of line string

Returns:

formatted string