org.yarnandtail.andhow.util

Class TextUtil

java.lang.Object

org.yarnandtail.andhow.util.TextUtil

public class TextUtil
extends Object

Text utility used for formatting output for reports, auto generated descriptions and Problems.

Author:

ericeverman

Field Summary

Fields

Modifier and Type	Field and Description
static String[]	EMPTY_STRING_ARRAY
static List<String>	EMPTY_STRING_LIST
static String	NULL_PRINT
static String	SECOND_LINE_INDENT

Constructor Summary

Constructors

Constructor and Description
TextUtil()

Method Summary

Modifier and Type	Method and Description
static String	escapeXml(String text)
static int	findFirstInstanceOf(String toBeSearched, int searchFrom, String... toBeFound) Find the first occurrence of one of an array of possible strings in another string, starting at the specified position, looking to the right.
static int	findLastInstanceOf(String toBeSearched, int searchFrom, String... toBeFound) Find the first occurrence of one of an array of possible strings in another string, starting at the specified position and seeking to the left.
static String	format(String pattern, Object... args) Creates a message with {} instances replaced with values from the args list, similar to how SLF4J formats messages.
static String	nullToEmpty(String source) Converts a null string to empty.
static String	padRight(String base, String repeatString, int totalLength) Pads the right side of the string with repeating repeatString's until the specified totalLength is reached.
static void	println(PrintStream out, int maxLineLength, String linePrefix, String content) println to the passed PrintStream, wrapped to a specified line length.
static void	println(PrintStream out, int maxLineLength, String linePrefix, String pattern, Object... args) println to the passed PrintStream using the format {} patterning and wrapping to a specified line length.
static void	println(PrintStream out, String pattern, Object... args) println to the passed PrintStream using the format {} patterning.
static String	repeat(String base, int repeat)
static String	trimToEmpty(String source)
static String	trimToNull(String source)
static List<String>	wrap(String in, int length) Wraps text to be no longer than the specified length, if possible.
static List<String>	wrap(String in, int length, String prefix, String wrappedLineIndent) Wraps text to be no longer than the specified length, if possible, and adds a prefix to each line, which is subtracted from the overall length.

Methods inherited from class java.lang.Object

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

Field Detail

EMPTY_STRING_ARRAY

public static final String[] EMPTY_STRING_ARRAY

EMPTY_STRING_LIST

public static final List<String> EMPTY_STRING_LIST

NULL_PRINT

public static final String NULL_PRINT

See Also:

Constant Field Values

SECOND_LINE_INDENT

public static final String SECOND_LINE_INDENT

See Also:

Constant Field Values

Constructor Detail

TextUtil

public TextUtil()

Method Detail

println

public static void println(PrintStream out,
                           String pattern,
                           Object... args)

println to the passed PrintStream using the format {} patterning.

Parameters:

out -

pattern -

args -

println

public static void println(PrintStream out,
                           int maxLineLength,
                           String linePrefix,
                           String pattern,
                           Object... args)

println to the passed PrintStream using the format {} patterning and wrapping to a specified line length. As each line is wrapped, linePrefix is added to the beginning of each line (this allows use as comments in things like properties files). Additionally, each wrapped line is given SECOND_LINE_INDENT of indent after the prefix.

Parameters:

out -

maxLineLength - Max characters to place on one line (best effort)

linePrefix - Each line will receive this prefix, which counts toward line length

pattern - Replacement pattern, using the format methods in this class

args - Arguments for replacement

println

public static void println(PrintStream out,
                           int maxLineLength,
                           String linePrefix,
                           String content)

println to the passed PrintStream, wrapped to a specified line length. As each line is wrapped, linePrefix is added to the beginning of each line (this allows use as comments in things like properties files). Additionally, each wrapped line is given SECOND_LINE_INDENT of indent after the prefix.

Parameters:

out -

maxLineLength - Max characters to place on one line (best effort)

linePrefix - Each line will receive this prefix, which counts toward line length

content - String to be split up.

format

public static String format(String pattern,
                            Object... args)

Creates a message with {} instances replaced with values from the args list, similar to how SLF4J formats messages. LIMITATION: \{} is recognized as escaping the {}, however, \\{} is not correctly recognized as preceding the {} with a '\' character. In other words, the sequence '\{}' is the only exception that is looked for / handled.

Parameters:

pattern - A string pattern with may contain {} references to items in the args list.

args - Values to call .toString on to fill in, in order, the {} refs.

Returns:

repeat

public static String repeat(String base,
                            int repeat)

padRight

public static String padRight(String base,
                              String repeatString,
                              int totalLength)

Pads the right side of the string with repeating repeatString's until the specified totalLength is reached. If the initial base string is longer than the totalLength, it is not modified. If the repeatString is multi-character, the final string will be trimmed to the totalLength, thus, the repeat string may be partially truncated. A null base string will return null. A null repeatString will be treated as a single space.

Parameters:

base -

repeatString -

totalLength -

Returns:

trimToNull

public static String trimToNull(String source)

nullToEmpty

public static String nullToEmpty(String source)

Converts a null string to empty. Non null strings are unmodified.

Parameters:

source - The string to convert

Returns:

A non-null string.

trimToEmpty

public static String trimToEmpty(String source)

wrap

public static List<String> wrap(String in,
                                int length,
                                String prefix,
                                String wrappedLineIndent)

Wraps text to be no longer than the specified length, if possible, and adds a prefix to each line, which is subtracted from the overall length. Long words may continue on the same line - there is no guarentee that the text will be wrapped to be less than the length parameter. The wrappedLineIndent is a character string that is added to each wrapped line (ie not the first line) after the prefix. This allows multi-lines to be clearly readable in the code formatting way. For simplicity, the wrappedLineIndent is not subtracted from the line length.

Parameters:

in -

length -

prefix -

wrappedLineIndent - Added to each wrapped line after the prefix, not including the first line.

Returns:

wrap

public static List<String> wrap(String in,
                                int length)

Wraps text to be no longer than the specified length, if possible. Long words may continue on the same line - there is no guarentee that the text will be wrapped to be less than the length parameter.

Parameters:

in -

length -

Returns:

findFirstInstanceOf

public static int findFirstInstanceOf(String toBeSearched,
                                      int searchFrom,
                                      String... toBeFound)

Find the first occurrence of one of an array of possible strings in another string, starting at the specified position, looking to the right. If there are more than one string arguments to be searched from, it returns the index of the argument which is of the lower index

Parameters:

toBeSearched -

searchFrom - Same symantics as String.indexOf(String, int)

toBeFound -

Returns:

findLastInstanceOf

public static int findLastInstanceOf(String toBeSearched,
                                     int searchFrom,
                                     String... toBeFound)

Find the first occurrence of one of an array of possible strings in another string, starting at the specified position and seeking to the left. If there are more than one string arguments to be searched from, it returns the index of the argument which is of the higher index

Parameters:

toBeSearched -

searchFrom - Start looking from this position and to the left

toBeFound -

Returns:

escapeXml

public static String escapeXml(String text)