net.shibboleth.utilities.java.support.primitive

Class StringSupport

java.lang.Object

net.shibboleth.utilities.java.support.primitive.StringSupport

public final class StringSupport
extends java.lang.Object

String utility methods.

Constructor Summary

Constructors

Modifier	Constructor and Description
private	StringSupport() Constructor.

Method Summary

Modifier and Type	Method and Description
static java.lang.String	inputStreamToString(java.io.InputStream input, java.nio.charset.CharsetDecoder decoder) Reads an input stream into a string.
static java.lang.String	listToStringValue(java.util.List<java.lang.String> values, java.lang.String delimiter) Converts a List of strings into a single string, with values separated by a specified delimiter.
static java.util.Collection<java.lang.String>	normalizeStringCollection(java.util.Collection<java.lang.String> values) Normalize a string collection by: Safely trimming each member. Converting all empty members to null. Removing any null members.
static java.util.List<java.lang.String>	stringToList(java.lang.String string, java.lang.String delimiter) Converts a delimited string into a list.
static java.lang.String	trim(java.lang.String s) Safely trims a string.
static java.lang.String	trimOrNull(java.lang.String s) Safely trims a string and, if empty, converts it to null.

Methods inherited from class java.lang.Object

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

Constructor Detail

StringSupport

private StringSupport()

Constructor.

Method Detail

inputStreamToString

@Nonnull
public static java.lang.String inputStreamToString(@Nonnull
                                                            java.io.InputStream input,
                                                            @Nullable
                                                            java.nio.charset.CharsetDecoder decoder)
                                                     throws java.io.IOException

Reads an input stream into a string. The provided stream is not closed.

Parameters:

input - the input stream to read

decoder - character decoder to use, if null, system default character set is used

Returns:

the string read from the stream

Throws:

java.io.IOException - thrown if there is a problem reading from the stream and decoding it

listToStringValue

@Nonnull
public static java.lang.String listToStringValue(@Nonnull
                                                          java.util.List<java.lang.String> values,
                                                          @Nonnull
                                                          java.lang.String delimiter)

Converts a List of strings into a single string, with values separated by a specified delimiter.

Parameters:

values - list of strings

delimiter - the delimiter used between values

Returns:

delimited string of values

stringToList

@Nonnull
public static java.util.List<java.lang.String> stringToList(@Nonnull
                                                                     java.lang.String string,
                                                                     @Nonnull
                                                                     java.lang.String delimiter)

Converts a delimited string into a list. We cannot use an ungarnished tokenizer since it doesn't add an empty String if the end of the input String was the delimiter. Hence we have to explicitly check.

Parameters:

string - the string to be split into a list

delimiter - the delimiter between values. This string may contain multiple delimiter characters, as allowed by StringTokenizer

Returns:

the list of values or an empty list if the given string is empty

trim

@Nullable
public static java.lang.String trim(@Nullable
                                              java.lang.String s)

Safely trims a string.

Parameters:

s - the string to trim, may be null

Returns:

the trimmed string or null if the given string was null

trimOrNull

@Nullable
public static java.lang.String trimOrNull(@Nullable
                                                    java.lang.String s)

Safely trims a string and, if empty, converts it to null.

Parameters:

s - the string to trim, may be null

Returns:

the trimmed string or null if the given string was null or the trimmed string was empty

normalizeStringCollection

@Nonnull
 @NonnullElements
public static java.util.Collection<java.lang.String> normalizeStringCollection(@Nullable @NullableElements
                                                                                                          java.util.Collection<java.lang.String> values)

Normalize a string collection by:

1. Safely trimming each member.
2. Converting all empty members to null.
3. Removing any null members.

Parameters:

values - the collection of string values

Returns:

the normalized collection of string values