com.frostphyr.avail.text

Class TextUtils

java.lang.Object

com.frostphyr.avail.text.TextUtils

public class TextUtils
extends Object

A class containing various utility methods relating to text; most notably String and CharSequence.

Since:

1.5

Method Summary

Modifier and Type	Method and Description
static String	join(boolean[] elements, Object separator) Returns a String of each element of elements joined together by separator.
static String	join(byte[] elements, Object separator) Returns a String of each element of elements joined together by separator.
static String	join(char[] elements, Object separator) Returns a String of each element of elements joined together by separator.
static String	join(double[] elements, Object separator) Returns a String of each element of elements joined together by separator.
static String	join(float[] elements, Object separator) Returns a String of each element of elements joined together by separator.
static String	join(int[] elements, Object separator) Returns a String of each element of elements joined together by separator.
static String	join(Iterable<?> iterable, Object separator) Returns a String of the elements of iterable joined together by separator.
static String	join(long[] elements, Object separator) Returns a String of each element of elements joined together by separator.
static String	join(Object[] elements, Object separator) Returns a String of the elements of elements joined together by separator.
static String	join(short[] elements, Object separator) Returns a String of each element of elements joined together by separator.
static String	substring(String string, int beginIndex, int endIndex, SurrogatePairPolicy policy) Returns a new String that is a substring of the specified String, from beginIndex (inclusive) to endIndex (exclusive).
static String	substring(String string, int beginIndex, int endIndex, SurrogatePairPolicy beginPolicy, SurrogatePairPolicy endPolicy) Returns a new String that is a substring of string, from beginIndex (inclusive) to endIndex (exclusive).
static String	substring(String string, int beginIndex, SurrogatePairPolicy policy) Returns a new String that is a substring of string, from beginIndex (inclusive) to the end of string.

Methods inherited from class java.lang.Object

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

Method Detail

substring

public static String substring(String string,
                               int beginIndex,
                               SurrogatePairPolicy policy)

Returns a new String that is a substring of string, from beginIndex (inclusive) to the end of string.

The difference between this method and String.substring(int) is that this method allows you to specify a SurrogatePairPolicy to determine how a surrogate pair should be handled if the pair would normally be split.

Parameters:

string - the String to create a substring from

beginIndex - the beginning index (inclusive)

policy - the SurrogatePairPolicy to use if a surrogate pair would normally be split

Returns:

a substring of string, beginning at beginIndex, unless changed by policy

Throws:

IllegalArgumentException - if string or policy is null, or beginIndex is negative or greater than the length of string

substring

public static String substring(String string,
                               int beginIndex,
                               int endIndex,
                               SurrogatePairPolicy beginPolicy,
                               SurrogatePairPolicy endPolicy)

Returns a new String that is a substring of string, from beginIndex (inclusive) to endIndex (exclusive).

The difference between this method and String.substring(int, int) is that this method allows you to specify a SurrogatePairPolicy to determine how a surrogate pair should be handled if the pair would normally be split at either the beginIndex or endIndex.

Parameters:

string - the String to create a substring from

beginIndex - the beginning index (inclusive)

endIndex - the ending index (exclusive)

beginPolicy - the SurrogatePairPolicy to use if a surrogate pair would normally be split at the beginIndex

endPolicy - the SurrogatePairPolicy to use if a surrogate pair would normally be split at the endIndex

Returns:

a substring of string, from beginIndex to endIndex, unless changed by either beginPolicy or endPolicy

Throws:

IllegalArgumentException - if string, beginPolicy, or endPolicy is null, beginIndex is negative, endIndex is greater than the length of string, or beginIndex is greater than endIndex

substring

public static String substring(String string,
                               int beginIndex,
                               int endIndex,
                               SurrogatePairPolicy policy)

Returns a new String that is a substring of the specified String, from beginIndex (inclusive) to endIndex (exclusive).

The difference between this method and String.substring(int, int) is that this method allows you to specify a SurrogatePairPolicy to determine how a surrogate pair should be handled if the pair would normally be split.

Parameters:

string - the String to create a substring from

beginIndex - the beginning index (inclusive)

endIndex - the ending index (exclusive)

policy - the SurrogatePairPolicy to use if a surrogate pair would normally be split

Returns:

a substring of the specified String, from beginIndex to endIndex, unless changed by the specified SurrogatePairPolicy

Throws:

IllegalArgumentException - if string or policy is null, beginIndex is negative, endIndex is greater than the length of string, or beginIndex is greater than endIndex

join

public static String join(Iterable<?> iterable,
                          Object separator)

Returns a String of the elements of iterable joined together by separator. The separator and each element will use Object.toString() for its text. If separator is null, the elements will be joined together with no separator. If any element is null, "null" will be used.

Parameters:

iterable - the elements to join

separator - the Object to join the elements with

Returns:

the joined String

Throws:

IllegalArgumentException - if iterable is null

join

public static String join(Object[] elements,
                          Object separator)

Returns a String of the elements of elements joined together by separator. The separator and each element will use Object.toString() for its text. If separator is null, the elements will be joined together with no separator. If any element is null, "null" will be used.

Parameters:

elements - the elements to join

separator - the Object to join the elements with

Returns:

the joined String

Throws:

IllegalArgumentException - if elements is null

join

public static String join(byte[] elements,
                          Object separator)

Returns a String of each element of elements joined together by separator. The separator will use Object.toString() for the separator text. If separator is null, the elements will be joined together with no separator.

Parameters:

elements - the elements to join

separator - the Object to join the elements with

Returns:

the joined String

Throws:

IllegalArgumentException - if elements is null

join

public static String join(short[] elements,
                          Object separator)

Returns a String of each element of elements joined together by separator. The separator will use Object.toString() for the separator text. If separator is null, the elements will be joined together with no separator.

Parameters:

elements - the elements to join

separator - the Object to join the elements with

Returns:

the joined String

Throws:

IllegalArgumentException - if elements is null

join

public static String join(int[] elements,
                          Object separator)

Returns a String of each element of elements joined together by separator. The separator will use Object.toString() for the separator text. If separator is null, the elements will be joined together with no separator.

Parameters:

elements - the elements to join

separator - the Object to join the elements with

Returns:

the joined String

Throws:

IllegalArgumentException - if elements is null

join

public static String join(long[] elements,
                          Object separator)

Returns a String of each element of elements joined together by separator. The separator will use Object.toString() for the separator text. If separator is null, the elements will be joined together with no separator.

Parameters:

elements - the elements to join

separator - the Object to join the elements with

Returns:

the joined String

Throws:

IllegalArgumentException - if elements is null

join

public static String join(float[] elements,
                          Object separator)

Returns a String of each element of elements joined together by separator. The separator will use Object.toString() for the separator text. If separator is null, the elements will be joined together with no separator.

Parameters:

elements - the elements to join

separator - the Object to join the elements with

Returns:

the joined String

Throws:

IllegalArgumentException - if elements is null

join

public static String join(double[] elements,
                          Object separator)

Returns a String of each element of elements joined together by separator. The separator will use Object.toString() for the separator text. If separator is null, the elements will be joined together with no separator.

Parameters:

elements - the elements to join

separator - the Object to join the elements with

Returns:

the joined String

Throws:

IllegalArgumentException - if elements is null

join

public static String join(char[] elements,
                          Object separator)

Returns a String of each element of elements joined together by separator. The separator will use Object.toString() for the separator text. If separator is null, the elements will be joined together with no separator.

Parameters:

elements - the elements to join

separator - the Object to join the elements with

Returns:

the joined String

Throws:

IllegalArgumentException - if elements is null

join

public static String join(boolean[] elements,
                          Object separator)

Returns a String of each element of elements joined together by separator. The separator will use Object.toString() for the separator text. If separator is null, the elements will be joined together with no separator.

Parameters:

elements - the elements to join

separator - the Object to join the elements with

Returns:

the joined String

Throws:

IllegalArgumentException - if elements is null