org.jminor.common

Class TextUtil

java.lang.Object

org.jminor.common.TextUtil

public final class TextUtil
extends java.lang.Object

A utility class for working with text, such as sorting a reading from files

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TextUtil.Alignment Left or right alignment

Field Summary

Fields

Modifier and Type	Field and Description
static PropertyValue<java.lang.String>	DEFAULT_COLLATOR_LANGUAGE Specifies the default collator locale language. Value type: String Default value: Locale.getDefault().getLanguage().

Method Summary

Modifier and Type	Method and Description
static void	collate(java.util.List values) Sorts the string representations of this lists contents, using the space aware collator
static void	collateSansSpaces(java.text.Collator collator, java.util.List list) Collates the contents of the list, replacing spaces with underscores before sorting
static int	collateSansSpaces(java.text.Collator collator, java.lang.String stringOne, java.lang.String stringTwo) Collates the given strings after replacing spaces with underscores
static java.lang.String	createRandomString(int minLength, int maxLength) Creates a random string from alphanumeric uppercase characters
static java.lang.String	getArrayContentsAsString(java.lang.Object[] items, boolean onePerLine)
static java.lang.String	getCollectionContentsAsString(java.util.Collection collection, boolean onePerLine)
static java.lang.String	getDelimitedString(java.lang.String[][] headers, java.lang.String[][] data, java.lang.String delimiter)
static java.lang.Double	getDouble(java.lang.String text) Parses a Double from the given String.
static java.lang.Integer	getInt(java.lang.String text) Parses an Integer from the given String.
static java.lang.Long	getLong(java.lang.String text) Parses a Long from the given String.
static <T> java.util.Comparator<T>	getSpaceAwareCollator()
static <T> java.util.Comparator<T>	getSpaceAwareCollator(java.util.Locale locale)
static java.lang.String	getTextFileContents(java.lang.Class resourceClass, java.lang.String resourceName) Fetch the entire contents of a resource text file, and return it in a String, using the default Charset.
static java.lang.String	getTextFileContents(java.lang.Class resourceClass, java.lang.String resourceName, java.nio.charset.Charset charset) Fetch the entire contents of a resource textfile, and return it in a String.
static java.lang.String	getTextFileContents(java.io.File file, java.nio.charset.Charset charset) Fetch the entire contents of a textfile, and return it in a String
static java.lang.String	getTextFileContents(java.io.InputStream inputStream, java.nio.charset.Charset charset) Fetch the entire contents of an InputStream, and return it in a String.
static java.lang.String	getTextFileContents(java.lang.String filename, java.nio.charset.Charset charset) Fetch the entire contents of a textfile, and return it in a String
static java.lang.String	padString(java.lang.String string, int length, char padChar, TextUtil.Alignment alignment) Pads the given string with the given pad character until a length of length has been reached
static java.util.List<java.lang.String>	parseCommaSeparatedValues(java.lang.String commaSeparatedValues)

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_COLLATOR_LANGUAGE

public static final PropertyValue<java.lang.String> DEFAULT_COLLATOR_LANGUAGE

Specifies the default collator locale language.
Value type: String
Default value: Locale.getDefault().getLanguage().

See Also:

getSpaceAwareCollator(), collate(List), Locale.toLanguageTag()

Method Detail

getInt

public static java.lang.Integer getInt(java.lang.String text)

Parses an Integer from the given String. A null or empty String results in null, "-" in -1.

Parameters:

text - the text to parse

Returns:

an Integer based on the given text

getDouble

public static java.lang.Double getDouble(java.lang.String text)

Parses a Double from the given String. A null or empty String results in null, "-" in -1.

Parameters:

text - the text to parse

Returns:

a Double based on the given text

getLong

public static java.lang.Long getLong(java.lang.String text)

Parses a Long from the given String. A null or empty String results in null, "-" in -1.

Parameters:

text - the text to parse

Returns:

a Long based on the given text

createRandomString

public static java.lang.String createRandomString(int minLength,
                                                  int maxLength)

Creates a random string from alphanumeric uppercase characters

Parameters:

minLength - the minimum length

maxLength - the maximum length

Returns:

a random string

collate

public static void collate(java.util.List values)

Sorts the string representations of this lists contents, using the space aware collator

Parameters:

values - the list to sort (collate)

See Also:

getSpaceAwareCollator()

getSpaceAwareCollator

public static <T> java.util.Comparator<T> getSpaceAwareCollator()

Type Parameters:

T - the comparison type

Returns:

a Comparator which compares the string representations of the objects using the default Collator, taking spaces into account.

See Also:

DEFAULT_COLLATOR_LANGUAGE

getSpaceAwareCollator

public static <T> java.util.Comparator<T> getSpaceAwareCollator(java.util.Locale locale)

Type Parameters:

T - the comparison type

Parameters:

locale - the collator locale

Returns:

a Comparator which compares the string representations of the objects using the default Collator, taking spaces into account.

collateSansSpaces

public static void collateSansSpaces(java.text.Collator collator,
                                     java.util.List list)

Collates the contents of the list, replacing spaces with underscores before sorting

Parameters:

collator - the collator

list - the list

collateSansSpaces

public static int collateSansSpaces(java.text.Collator collator,
                                    java.lang.String stringOne,
                                    java.lang.String stringTwo)

Collates the given strings after replacing spaces with underscores

Parameters:

collator - the collator to use

stringOne - the first string

stringTwo - the second string

Returns:

the collation result

padString

public static java.lang.String padString(java.lang.String string,
                                         int length,
                                         char padChar,
                                         TextUtil.Alignment alignment)

Pads the given string with the given pad character until a length of length has been reached

Parameters:

string - the string to pad

length - the desired length

padChar - the character to use for padding

alignment - the padding alignment, left or right side

Returns:

the padded string

getDelimitedString

public static java.lang.String getDelimitedString(java.lang.String[][] headers,
                                                  java.lang.String[][] data,
                                                  java.lang.String delimiter)

Parameters:

headers - the headers

data - the data

delimiter - the delimiter

Returns:

a String comprised of the given headers and data with the given delimiter

getTextFileContents

public static java.lang.String getTextFileContents(java.lang.Class resourceClass,
                                                   java.lang.String resourceName)
                                            throws java.io.IOException

Fetch the entire contents of a resource text file, and return it in a String, using the default Charset.

Parameters:

resourceClass - the resource class

resourceName - the name of the resource to retrieve

Returns:

the contents of the resource file

Throws:

java.io.IOException - in case an IOException occurs

getTextFileContents

public static java.lang.String getTextFileContents(java.lang.Class resourceClass,
                                                   java.lang.String resourceName,
                                                   java.nio.charset.Charset charset)
                                            throws java.io.IOException

Fetch the entire contents of a resource textfile, and return it in a String.

Parameters:

resourceClass - the resource class

resourceName - the name of the resource to retrieve

charset - the Charset to use when reading the file contents

Returns:

the contents of the resource file

Throws:

java.io.IOException - in case an IOException occurs

getTextFileContents

public static java.lang.String getTextFileContents(java.lang.String filename,
                                                   java.nio.charset.Charset charset)
                                            throws java.io.IOException

Fetch the entire contents of a textfile, and return it in a String

Parameters:

filename - the name of the file

charset - the charset to use

Returns:

the file contents as a String

Throws:

java.io.IOException - in case of an exception

getTextFileContents

public static java.lang.String getTextFileContents(java.io.File file,
                                                   java.nio.charset.Charset charset)
                                            throws java.io.IOException

Fetch the entire contents of a textfile, and return it in a String

Parameters:

file - the file

charset - the charset to use

Returns:

the file contents as a String

Throws:

java.io.IOException - in case of an exception

getTextFileContents

public static java.lang.String getTextFileContents(java.io.InputStream inputStream,
                                                   java.nio.charset.Charset charset)
                                            throws java.io.IOException

Fetch the entire contents of an InputStream, and return it in a String. Does not close the stream.

Parameters:

inputStream - the input stream to read

charset - the charset to use

Returns:

the stream contents as a String

Throws:

java.io.IOException - in case of an exception

getCollectionContentsAsString

public static java.lang.String getCollectionContentsAsString(java.util.Collection collection,
                                                             boolean onePerLine)

Parameters:

collection - the collection

onePerLine - if true then each item is put on a separate line, otherwise a comma separator is used

Returns:

the collection contents as a string (using toString())

getArrayContentsAsString

public static java.lang.String getArrayContentsAsString(java.lang.Object[] items,
                                                        boolean onePerLine)

Parameters:

items - the items

onePerLine - if true then each item is put on a separate line, otherwise a comma separator is used

Returns:

the array contents as a string (using toString())

parseCommaSeparatedValues

public static java.util.List<java.lang.String> parseCommaSeparatedValues(java.lang.String commaSeparatedValues)

Parameters:

commaSeparatedValues - a String with comma separated values

Returns:

the trimmed values