org.kuali.common.util

Class Str

java.lang.Object

org.kuali.common.util.Str

public class Str
extends Object

Operations on String that are null safe

Field Summary

Fields

Modifier and Type	Field and Description
static String	CDATA_PREFIX
static String	CDATA_SUFFIX
static String	COLON
static String	COMMA
static String	CR
static String	DOT
static char	DOUBLE_QUOTE
static String[]	EMPTY_ARRAY
static String	EMPTY_STRING
static String	FORWARD_SLASH
static String	LF
static String	SPACE
static String	UTF8

Constructor Summary

Constructors

Constructor and Description
Str()

Method Summary

Methods

Modifier and Type	Method and Description
static String	cdata(String s) Turn the string into CDATA - http://en.wikipedia.org/wiki/CDATA
static String	conceal(String text) A trivial way to conceal text.
static boolean	contains(List<String> tokens, String value, boolean caseSensitive)
static boolean	equals(String s1, String s2, boolean caseSensitive)
static String	flatten(String s) Replace carriage returns and linefeeds with a space
static String	flatten(String s, String cr, String lf) Replace carriage returns with cr and linefeeds with lf.
static byte[]	getAsciiBytes(String s)
static String	getAsciiString(byte[] bytes)
static byte[]	getBytes(String s, String encoding)
static String	getId(String... tokens) Convert the tokens into a string delimited by the colon ":" character
static String	getPath(String s) Convert dots to forward slashes and trim.
static String	getString(byte[] bytes, String encoding)
static byte[]	getUTF8Bytes(String s)
static String	getUTF8String(byte[] bytes)
static String	inflate(String s, String cr, String lf) Replace cr with carriage return and lf with linefeed.
static boolean	isConcealed(String text) Return true if text is concealed
static boolean	matches(String s, String prefix, String suffix) Return true if s starts with prefix and ends with suffix
static String	quote(String s) Surround the string with double quotes.
static String	remove(String s, String prefix, String suffix)
static String	removePrefix(String s, String prefix) If s starts with prefix, remove it
static String	removeSuffix(String s, String suffix) If s ends with suffix, remove it
static String	reveal(String text) Reveal the original contents of a string concealed by the conceal method.
static String[]	split(String s, String separatorChars, boolean trim) Split the string into tokens using the indicated separator chars, optionally trimming the tokens.
static String[]	splitAndTrim(String s, String separatorChars) Split the string into tokens using the indicated separator, trimming as we go.
static String[]	splitAndTrimCSV(String csv) Split comma separated values into tokens, trimming as we go.
static String[]	splitCSV(String csv, boolean trim) Split comma separated values into tokens, optionally trimming the tokens.
static String	toEmpty(String s) If s is null return "" otherwise return s
static String[]	toEmptyArray(String[] strings) If strings are null return EMPTY_ARRAY, otherwise return strings.
static String	toString(String[] tokens) Combine tokens into a String

Methods inherited from class java.lang.Object

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

Field Detail

EMPTY_STRING

public static final String EMPTY_STRING

See Also:

Constant Field Values

UTF8

public static final String UTF8

See Also:

Constant Field Values

COMMA

public static final String COMMA

See Also:

Constant Field Values

SPACE

public static final String SPACE

See Also:

Constant Field Values

CR

public static final String CR

See Also:

Constant Field Values

LF

public static final String LF

See Also:

Constant Field Values

DOT

public static final String DOT

See Also:

Constant Field Values

COLON

public static final String COLON

See Also:

Constant Field Values

FORWARD_SLASH

public static final String FORWARD_SLASH

See Also:

Constant Field Values

DOUBLE_QUOTE

public static final char DOUBLE_QUOTE

See Also:

Constant Field Values

CDATA_PREFIX

public static final String CDATA_PREFIX

See Also:

Constant Field Values

CDATA_SUFFIX

public static final String CDATA_SUFFIX

See Also:

Constant Field Values

EMPTY_ARRAY

public static final String[] EMPTY_ARRAY

Constructor Detail

Str

public Str()

Method Detail

conceal

public static final String conceal(String text)

A trivial way to conceal text. Can be reversed using reveal(). Do NOT use this method in an attempt to obscure sensitive data. The algorithm is completely trivial and exceedingly simple to reverse engineer. Not to mention, the reveal() method can reproduce the original string without requiring any secret knowledge.

The use case here is to help prevent someone with otherwise mostly good intentions from altering a piece of information in a way they should not. This is NOT intended to defeat any serious attempt at discovering the original text.

Think a hungry sales or marketing rep who stumbles across a config file with the entry vending.machine.refill.day=wed in it and tries to change that to mon in order to beat a case of the munchies. :)

If the entry says vending.machine.refill.day=cnc--jrq instead of vending.machine.refill.day=wed they are far more likely to ask around before they change it OR just give up and head out to lunch instead.

See Also:

reveal

reveal

public static final String reveal(String text)

Reveal the original contents of a string concealed by the conceal method.

See Also:

conceal

isConcealed

public static final boolean isConcealed(String text)

Return true if text is concealed

toEmptyArray

public static final String[] toEmptyArray(String[] strings)

If strings are null return EMPTY_ARRAY, otherwise return strings.

getId

public static final String getId(String... tokens)

Convert the tokens into a string delimited by the colon ":" character

   "foo","bar" ,"baz"  -> foo:bar:baz
   "foo", null ,"baz"  -> foo::baz
   "foo", ""   ,"baz"  -> foo::baz
   "foo", null , null  -> foo::
    null,"bar" , null  -> :bar:
 

cdata

public static final String cdata(String s)

Turn the string into CDATA - http://en.wikipedia.org/wiki/CDATA

removeSuffix

public static final String removeSuffix(String s,
                  String suffix)

If s ends with suffix, remove it

removePrefix

public static final String removePrefix(String s,
                  String prefix)

If s starts with prefix, remove it

matches

public static final boolean matches(String s,
              String prefix,
              String suffix)

Return true if s starts with prefix and ends with suffix

remove

public static final String remove(String s,
            String prefix,
            String suffix)

toEmpty

public static final String toEmpty(String s)

If s is null return "" otherwise return s

getAsciiString

public static final String getAsciiString(byte[] bytes)

getUTF8String

public static final String getUTF8String(byte[] bytes)

getString

public static final String getString(byte[] bytes,
               String encoding)

getAsciiBytes

public static final byte[] getAsciiBytes(String s)

getUTF8Bytes

public static final byte[] getUTF8Bytes(String s)

getBytes

public static final byte[] getBytes(String s,
              String encoding)

contains

public static final boolean contains(List<String> tokens,
               String value,
               boolean caseSensitive)

equals

public static final boolean equals(String s1,
             String s2,
             boolean caseSensitive)

toString

public static final String toString(String[] tokens)

Combine tokens into a String

getPath

public static final String getPath(String s)

Convert dots to forward slashes and trim.

quote

public static final String quote(String s)

Surround the string with double quotes.

splitCSV

public static final String[] splitCSV(String csv,
                boolean trim)

Split comma separated values into tokens, optionally trimming the tokens.

splitAndTrimCSV

public static final String[] splitAndTrimCSV(String csv)

Split comma separated values into tokens, trimming as we go.

splitAndTrim

public static final String[] splitAndTrim(String s,
                    String separatorChars)

Split the string into tokens using the indicated separator, trimming as we go.

split

public static final String[] split(String s,
             String separatorChars,
             boolean trim)

Split the string into tokens using the indicated separator chars, optionally trimming the tokens.

flatten

public static final String flatten(String s)

Replace carriage returns and linefeeds with a space

flatten

public static final String flatten(String s,
             String cr,
             String lf)

Replace carriage returns with cr and linefeeds with lf.

inflate

public static final String inflate(String s,
             String cr,
             String lf)

Replace cr with carriage return and lf with linefeed.