org.forgerock.util

Class Strings

java.lang.Object

org.forgerock.util.Strings

public final class Strings
extends Object

Common utility methods for Strings.

Method Summary

Modifier and Type	Method and Description
static <T extends Enum<T>> T	asEnum(String value, Class<T> type) Returns the string value as an enum constant of the specified enum type.
static boolean	isBlank(CharSequence charSeq) Check to see if a character sequence is null or blank.
static boolean	isNullOrEmpty(String value) Check to see if the provided String is null or empty.
static void	joinAsString(StringBuilder builder, String separator, Iterable<?> values) Appends into the provided StringBuilder the string representation of the objects contained in the provided iterable concatenated together using the provided separator.
static void	joinAsString(StringBuilder builder, String separator, Object... values) Appends into the provided StringBuilder the string representation of the provided objects concatenated together using the provided separator.
static String	joinAsString(String separator, Iterable<?> values) Returns a string whose content is the string representation of the objects contained in the provided iterable concatenated together using the provided separator.
static String	joinAsString(String separator, Object... values) Returns a string whose content is the string representation of the provided objects concatenated together using the provided separator.

Methods inherited from class java.lang.Object

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

Method Detail

joinAsString

public static String joinAsString(String separator,
                                  Object... values)

Returns a string whose content is the string representation of the provided objects concatenated together using the provided separator.

Parameters:

separator - The separator string.

values - The objects to be joined.

Returns:

A string whose content is the string representation of the provided objects concatenated together using the provided separator.

Throws:

NullPointerException - If values or separator were null.

joinAsString

public static String joinAsString(String separator,
                                  Iterable<?> values)

Returns a string whose content is the string representation of the objects contained in the provided iterable concatenated together using the provided separator.

Parameters:

separator - The separator string.

values - The iterable whose elements are to be joined.

Returns:

A string whose content is the string representation of the objects contained in the provided iterable concatenated together using the provided separator.

Throws:

NullPointerException - If separator or values were null.

joinAsString

public static void joinAsString(StringBuilder builder,
                                String separator,
                                Object... values)

Appends into the provided StringBuilder the string representation of the provided objects concatenated together using the provided separator.

Parameters:

builder - The String builder where to append.

separator - The separator string.

values - The objects to be joined.

Throws:

NullPointerException - If builder, separator or values were null.

joinAsString

public static void joinAsString(StringBuilder builder,
                                String separator,
                                Iterable<?> values)

Appends into the provided StringBuilder the string representation of the objects contained in the provided iterable concatenated together using the provided separator.

Parameters:

builder - The String builder where to append.

separator - The separator string.

values - The iterable whose elements are to be joined.

Throws:

NullPointerException - If builder, separator or values were null.

asEnum

public static <T extends Enum<T>> T asEnum(String value,
                                           Class<T> type)

Returns the string value as an enum constant of the specified enum type. The string value and enum constants are compared, ignoring case considerations. If the string value is null, this method returns null.

Type Parameters:

T - the enum type sub-class.

Parameters:

value - the string value

type - the enum type to match constants with the value.

Returns:

the enum constant represented by the string value.

Throws:

IllegalArgumentException - if type does not represent an enum type, of if value does not match one of the enum constants

NullPointerException - if type is null.

isNullOrEmpty

public static boolean isNullOrEmpty(String value)

Check to see if the provided String is null or empty.

Parameters:

value - The value to check.

Returns:

true if the value is either null or is empty.

isBlank

public static boolean isBlank(CharSequence charSeq)

Check to see if a character sequence is null or blank.

Parameters:

charSeq - Sequence to test (String is also a CharSequence)

Returns:

true if the char sequence is null or blank.