Save This Page
Home » commons-lang-2.4-src » org.apache.commons » lang » [javadoc | source]
org.apache.commons.lang
public class: StringUtils [javadoc | source]
java.lang.Object
   org.apache.commons.lang.StringUtils

Operations on java.lang.String that are null safe.

The StringUtils class defines certain words related to String handling.

StringUtils handles null input Strings quietly. That is to say that a null input will return null. Where a boolean or int is being returned details vary by method.

A side effect of the null handling is that a NullPointerException should be considered a bug in StringUtils (except for deprecated methods).

Methods in this class give sample code to explain their operation. The symbol * is used to indicate any input including null.

Field Summary
public static final  String EMPTY    The empty String "".
    since: 2.0 -
 
public static final  int INDEX_NOT_FOUND    Represents a failed index search.
    since: 2.1 -
 
Constructor:
 public StringUtils() 
Method from org.apache.commons.lang.StringUtils Summary:
abbreviate,   abbreviate,   capitalise,   capitaliseAllWords,   capitalize,   center,   center,   center,   chomp,   chomp,   chompLast,   chompLast,   chop,   chopNewline,   clean,   concatenate,   contains,   contains,   containsAny,   containsAny,   containsIgnoreCase,   containsNone,   containsNone,   containsOnly,   containsOnly,   countMatches,   defaultIfEmpty,   defaultString,   defaultString,   deleteSpaces,   deleteWhitespace,   difference,   endsWith,   endsWithIgnoreCase,   equals,   equalsIgnoreCase,   escape,   getChomp,   getCommonPrefix,   getLevenshteinDistance,   getNestedString,   getNestedString,   getPrechomp,   indexOf,   indexOf,   indexOf,   indexOf,   indexOfAny,   indexOfAny,   indexOfAny,   indexOfAnyBut,   indexOfAnyBut,   indexOfDifference,   indexOfDifference,   isAlpha,   isAlphaSpace,   isAlphanumeric,   isAlphanumericSpace,   isAsciiPrintable,   isBlank,   isEmpty,   isNotBlank,   isNotEmpty,   isNumeric,   isNumericSpace,   isWhitespace,   join,   join,   join,   join,   join,   join,   join,   join,   join,   lastIndexOf,   lastIndexOf,   lastIndexOf,   lastIndexOf,   lastIndexOfAny,   left,   leftPad,   leftPad,   leftPad,   length,   lowerCase,   mid,   ordinalIndexOf,   overlay,   overlayString,   prechomp,   remove,   remove,   removeEnd,   removeEndIgnoreCase,   removeStart,   removeStartIgnoreCase,   repeat,   replace,   replace,   replaceChars,   replaceChars,   replaceEach,   replaceEachRepeatedly,   replaceOnce,   reverse,   reverseDelimited,   reverseDelimitedString,   right,   rightPad,   rightPad,   rightPad,   split,   split,   split,   split,   splitByCharacterType,   splitByCharacterTypeCamelCase,   splitByWholeSeparator,   splitByWholeSeparator,   splitByWholeSeparatorPreserveAllTokens,   splitByWholeSeparatorPreserveAllTokens,   splitPreserveAllTokens,   splitPreserveAllTokens,   splitPreserveAllTokens,   splitPreserveAllTokens,   startsWith,   startsWithIgnoreCase,   strip,   strip,   stripAll,   stripAll,   stripEnd,   stripStart,   stripToEmpty,   stripToNull,   substring,   substring,   substringAfter,   substringAfterLast,   substringBefore,   substringBeforeLast,   substringBetween,   substringBetween,   substringsBetween,   swapCase,   trim,   trimToEmpty,   trimToNull,   uncapitalise,   uncapitalize,   upperCase
Methods from java.lang.Object:
equals,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from org.apache.commons.lang.StringUtils Detail:
 public static String abbreviate(String str,
    int maxWidth) 

    Abbreviates a String using ellipses. This will turn "Now is the time for all good men" into "Now is the time for..."

    Specifically:

    • If str is less than maxWidth characters long, return it.
    • Else abbreviate it to (substring(str, 0, max-3) + "...").
    • If maxWidth is less than 4, throw an IllegalArgumentException.
    • In no case will it return a String of length greater than maxWidth.

    StringUtils.abbreviate(null, *) = null
    StringUtils.abbreviate("", 4) = ""
    StringUtils.abbreviate("abcdefg", 6) = "abc..."
    StringUtils.abbreviate("abcdefg", 7) = "abcdefg"
    StringUtils.abbreviate("abcdefg", 8) = "abcdefg"
    StringUtils.abbreviate("abcdefg", 4) = "a..."
    StringUtils.abbreviate("abcdefg", 3) = IllegalArgumentException
    
 public static String abbreviate(String str,
    int offset,
    int maxWidth) 

    Abbreviates a String using ellipses. This will turn "Now is the time for all good men" into "...is the time for..."

    Works like abbreviate(String, int), but allows you to specify a "left edge" offset. Note that this left edge is not necessarily going to be the leftmost character in the result, or the first character following the ellipses, but it will appear somewhere in the result.

    In no case will it return a String of length greater than maxWidth.

    StringUtils.abbreviate(null, *, *) = null
    StringUtils.abbreviate("", 0, 4) = ""
    StringUtils.abbreviate("abcdefghijklmno", -1, 10) = "abcdefg..."
    StringUtils.abbreviate("abcdefghijklmno", 0, 10) = "abcdefg..."
    StringUtils.abbreviate("abcdefghijklmno", 1, 10) = "abcdefg..."
    StringUtils.abbreviate("abcdefghijklmno", 4, 10) = "abcdefg..."
    StringUtils.abbreviate("abcdefghijklmno", 5, 10) = "...fghi..."
    StringUtils.abbreviate("abcdefghijklmno", 6, 10) = "...ghij..."
    StringUtils.abbreviate("abcdefghijklmno", 8, 10) = "...ijklmno"
    StringUtils.abbreviate("abcdefghijklmno", 10, 10) = "...ijklmno"
    StringUtils.abbreviate("abcdefghijklmno", 12, 10) = "...ijklmno"
    StringUtils.abbreviate("abcdefghij", 0, 3) = IllegalArgumentException
    StringUtils.abbreviate("abcdefghij", 5, 6) = IllegalArgumentException
    
 public static String capitalise(String str) 
Deprecated! Use - the standardly named #capitalize(String) . Method will be removed in Commons Lang 3.0.

 public static String capitaliseAllWords(String str) 
Deprecated! Use - the relocated WordUtils#capitalize(String) . Method will be removed in Commons Lang 3.0.

    Capitalizes all the whitespace separated words in a String. Only the first letter of each word is changed.

    Whitespace is defined by Character#isWhitespace(char) . A null input String returns null.

 public static String capitalize(String str) 

    Capitalizes a String changing the first letter to title case as per Character#toTitleCase(char) . No other letters are changed.

    For a word based algorithm, see WordUtils#capitalize(String) . A null input String returns null.

    StringUtils.capitalize(null) = null
    StringUtils.capitalize("") = ""
    StringUtils.capitalize("cat") = "Cat"
    StringUtils.capitalize("cAt") = "CAt"
    
 public static String center(String str,
    int size) 

    Centers a String in a larger String of size size using the space character (' ').

    If the size is less than the String length, the String is returned. A null String returns null. A negative size is treated as zero.

    Equivalent to center(str, size, " ").

    StringUtils.center(null, *) = null
    StringUtils.center("", 4) = " "
    StringUtils.center("ab", -1) = "ab"
    StringUtils.center("ab", 4) = " ab "
    StringUtils.center("abcd", 2) = "abcd"
    StringUtils.center("a", 4) = " a "
    
 public static String center(String str,
    int size,
    char padChar) 

    Centers a String in a larger String of size size. Uses a supplied character as the value to pad the String with.

    If the size is less than the String length, the String is returned. A null String returns null. A negative size is treated as zero.

    StringUtils.center(null, *, *) = null
    StringUtils.center("", 4, ' ') = " "
    StringUtils.center("ab", -1, ' ') = "ab"
    StringUtils.center("ab", 4, ' ') = " ab"
    StringUtils.center("abcd", 2, ' ') = "abcd"
    StringUtils.center("a", 4, ' ') = " a "
    StringUtils.center("a", 4, 'y') = "yayy"
    
 public static String center(String str,
    int size,
    String padStr) 

    Centers a String in a larger String of size size. Uses a supplied String as the value to pad the String with.

    If the size is less than the String length, the String is returned. A null String returns null. A negative size is treated as zero.

    StringUtils.center(null, *, *) = null
    StringUtils.center("", 4, " ") = " "
    StringUtils.center("ab", -1, " ") = "ab"
    StringUtils.center("ab", 4, " ") = " ab"
    StringUtils.center("abcd", 2, " ") = "abcd"
    StringUtils.center("a", 4, " ") = " a "
    StringUtils.center("a", 4, "yz") = "yayz"
    StringUtils.center("abc", 7, null) = " abc "
    StringUtils.center("abc", 7, "") = " abc "
    
 public static String chomp(String str) 

    Removes one newline from end of a String if it's there, otherwise leave it alone. A newline is "\n", "\r", or "\r\n".

    NOTE: This method changed in 2.0. It now more closely matches Perl chomp.

    StringUtils.chomp(null) = null
    StringUtils.chomp("") = ""
    StringUtils.chomp("abc \r") = "abc "
    StringUtils.chomp("abc\n") = "abc"
    StringUtils.chomp("abc\r\n") = "abc"
    StringUtils.chomp("abc\r\n\r\n") = "abc\r\n"
    StringUtils.chomp("abc\n\r") = "abc\n"
    StringUtils.chomp("abc\n\rabc") = "abc\n\rabc"
    StringUtils.chomp("\r") = ""
    StringUtils.chomp("\n") = ""
    StringUtils.chomp("\r\n") = ""
    
 public static String chomp(String str,
    String separator) 

    Removes separator from the end of str if it's there, otherwise leave it alone.

    NOTE: This method changed in version 2.0. It now more closely matches Perl chomp. For the previous behavior, use #substringBeforeLast(String, String) . This method uses String#endsWith(String) .

    StringUtils.chomp(null, *) = null
    StringUtils.chomp("", *) = ""
    StringUtils.chomp("foobar", "bar") = "foo"
    StringUtils.chomp("foobar", "baz") = "foobar"
    StringUtils.chomp("foo", "foo") = ""
    StringUtils.chomp("foo ", "foo") = "foo "
    StringUtils.chomp(" foo", "foo") = " "
    StringUtils.chomp("foo", "foooo") = "foo"
    StringUtils.chomp("foo", "") = "foo"
    StringUtils.chomp("foo", null) = "foo"
    
 public static String chompLast(String str) 
Deprecated! Use - #chomp(String) instead. Method will be removed in Commons Lang 3.0.

    Remove any "\n" if and only if it is at the end of the supplied String.

 public static String chompLast(String str,
    String sep) 
Deprecated! Use - #chomp(String,String) instead. Method will be removed in Commons Lang 3.0.

    Remove a value if and only if the String ends with that value.

 public static String chop(String str) 

    Remove the last character from a String.

    If the String ends in \r\n, then remove both of them.

    StringUtils.chop(null) = null
    StringUtils.chop("") = ""
    StringUtils.chop("abc \r") = "abc "
    StringUtils.chop("abc\n") = "abc"
    StringUtils.chop("abc\r\n") = "abc"
    StringUtils.chop("abc") = "ab"
    StringUtils.chop("abc\nabc") = "abc\nab"
    StringUtils.chop("a") = ""
    StringUtils.chop("\r") = ""
    StringUtils.chop("\n") = ""
    StringUtils.chop("\r\n") = ""
    
 public static String chopNewline(String str) 
Deprecated! Use - #chomp(String) instead. Method will be removed in Commons Lang 3.0.

    Removes \n from end of a String if it's there. If a \r precedes it, then remove that too.

 public static String clean(String str) 
Deprecated! Use - the clearer named #trimToEmpty(String) . Method will be removed in Commons Lang 3.0.

    Removes control characters (char <= 32) from both ends of this String, handling null by returning an empty String ("").

    StringUtils.clean(null) = ""
    StringUtils.clean("") = ""
    StringUtils.clean("abc") = "abc"
    StringUtils.clean(" abc ") = "abc"
    StringUtils.clean(" ") = ""
    
 public static String concatenate(Object[] array) 
Deprecated! Use - the better named #join(Object[]) instead. Method will be removed in Commons Lang 3.0.

    Concatenates elements of an array into a single String. Null objects or empty strings within the array are represented by empty strings.

    StringUtils.concatenate(null) = null
    StringUtils.concatenate([]) = ""
    StringUtils.concatenate([null]) = ""
    StringUtils.concatenate(["a", "b", "c"]) = "abc"
    StringUtils.concatenate([null, "", "a"]) = "a"
    
 public static boolean contains(String str,
    char searchChar) 

    Checks if String contains a search character, handling null. This method uses String#indexOf(int) .

    A null or empty ("") String will return false.

    StringUtils.contains(null, *) = false
    StringUtils.contains("", *) = false
    StringUtils.contains("abc", 'a') = true
    StringUtils.contains("abc", 'z') = false
    
 public static boolean contains(String str,
    String searchStr) 

    Checks if String contains a search String, handling null. This method uses String#indexOf(String) .

    A null String will return false.

    StringUtils.contains(null, *) = false
    StringUtils.contains(*, null) = false
    StringUtils.contains("", "") = true
    StringUtils.contains("abc", "") = true
    StringUtils.contains("abc", "a") = true
    StringUtils.contains("abc", "z") = false
    
 public static boolean containsAny(String str,
    char[] searchChars) 

    Checks if the String contains any character in the given set of characters.

    A null String will return false. A null or zero length search array will return false.

    StringUtils.containsAny(null, *) = false
    StringUtils.containsAny("", *) = false
    StringUtils.containsAny(*, null) = false
    StringUtils.containsAny(*, []) = false
    StringUtils.containsAny("zzabyycdxx",['z','a']) = true
    StringUtils.containsAny("zzabyycdxx",['b','y']) = true
    StringUtils.containsAny("aba", ['z']) = false
    
 public static boolean containsAny(String str,
    String searchChars) 

    Checks if the String contains any character in the given set of characters.

    A null String will return false. A null search string will return false.

    StringUtils.containsAny(null, *) = false
    StringUtils.containsAny("", *) = false
    StringUtils.containsAny(*, null) = false
    StringUtils.containsAny(*, "") = false
    StringUtils.containsAny("zzabyycdxx", "za") = true
    StringUtils.containsAny("zzabyycdxx", "by") = true
    StringUtils.containsAny("aba","z") = false
    
 public static boolean containsIgnoreCase(String str,
    String searchStr) 

    Checks if String contains a search String irrespective of case, handling null. This method uses #contains(String, String) .

    A null String will return false.

    StringUtils.contains(null, *) = false
    StringUtils.contains(*, null) = false
    StringUtils.contains("", "") = true
    StringUtils.contains("abc", "") = true
    StringUtils.contains("abc", "a") = true
    StringUtils.contains("abc", "z") = false
    StringUtils.contains("abc", "A") = true
    StringUtils.contains("abc", "Z") = false
    
 public static boolean containsNone(String str,
    char[] invalidChars) 

    Checks that the String does not contain certain characters.

    A null String will return true. A null invalid character array will return true. An empty String ("") always returns true.

    StringUtils.containsNone(null, *) = true
    StringUtils.containsNone(*, null) = true
    StringUtils.containsNone("", *) = true
    StringUtils.containsNone("ab", '') = true
    StringUtils.containsNone("abab", 'xyz') = true
    StringUtils.containsNone("ab1", 'xyz') = true
    StringUtils.containsNone("abz", 'xyz') = false
    
 public static boolean containsNone(String str,
    String invalidChars) 

    Checks that the String does not contain certain characters.

    A null String will return true. A null invalid character array will return true. An empty String ("") always returns true.

    StringUtils.containsNone(null, *) = true
    StringUtils.containsNone(*, null) = true
    StringUtils.containsNone("", *) = true
    StringUtils.containsNone("ab", "") = true
    StringUtils.containsNone("abab", "xyz") = true
    StringUtils.containsNone("ab1", "xyz") = true
    StringUtils.containsNone("abz", "xyz") = false
    
 public static boolean containsOnly(String str,
    char[] valid) 

    Checks if the String contains only certain characters.

    A null String will return false. A null valid character array will return false. An empty String ("") always returns true.

    StringUtils.containsOnly(null, *) = false
    StringUtils.containsOnly(*, null) = false
    StringUtils.containsOnly("", *) = true
    StringUtils.containsOnly("ab", '') = false
    StringUtils.containsOnly("abab", 'abc') = true
    StringUtils.containsOnly("ab1", 'abc') = false
    StringUtils.containsOnly("abz", 'abc') = false
    
 public static boolean containsOnly(String str,
    String validChars) 

    Checks if the String contains only certain characters.

    A null String will return false. A null valid character String will return false. An empty String ("") always returns true.

    StringUtils.containsOnly(null, *) = false
    StringUtils.containsOnly(*, null) = false
    StringUtils.containsOnly("", *) = true
    StringUtils.containsOnly("ab", "") = false
    StringUtils.containsOnly("abab", "abc") = true
    StringUtils.containsOnly("ab1", "abc") = false
    StringUtils.containsOnly("abz", "abc") = false
    
 public static int countMatches(String str,
    String sub) 

    Counts how many times the substring appears in the larger String.

    A null or empty ("") String input returns 0.

    StringUtils.countMatches(null, *) = 0
    StringUtils.countMatches("", *) = 0
    StringUtils.countMatches("abba", null) = 0
    StringUtils.countMatches("abba", "") = 0
    StringUtils.countMatches("abba", "a") = 2
    StringUtils.countMatches("abba", "ab") = 1
    StringUtils.countMatches("abba", "xxx") = 0
    
 public static String defaultIfEmpty(String str,
    String defaultStr) 

    Returns either the passed in String, or if the String is empty or null, the value of defaultStr.

    StringUtils.defaultIfEmpty(null, "NULL") = "NULL"
    StringUtils.defaultIfEmpty("", "NULL") = "NULL"
    StringUtils.defaultIfEmpty("bat", "NULL") = "bat"
    
 public static String defaultString(String str) 

    Returns either the passed in String, or if the String is null, an empty String ("").

    StringUtils.defaultString(null) = ""
    StringUtils.defaultString("") = ""
    StringUtils.defaultString("bat") = "bat"
    
 public static String defaultString(String str,
    String defaultStr) 

    Returns either the passed in String, or if the String is null, the value of defaultStr.

    StringUtils.defaultString(null, "NULL") = "NULL"
    StringUtils.defaultString("", "NULL") = ""
    StringUtils.defaultString("bat", "NULL") = "bat"
    
 public static String deleteSpaces(String str) 
Deprecated! Use - the better localized #deleteWhitespace(String) . Method will be removed in Commons Lang 3.0.

    Deletes all 'space' characters from a String as defined by Character#isSpace(char) .

    This is the only StringUtils method that uses the isSpace definition. You are advised to use #deleteWhitespace(String) instead as whitespace is much better localized.

    StringUtils.deleteSpaces(null) = null
    StringUtils.deleteSpaces("") = ""
    StringUtils.deleteSpaces("abc") = "abc"
    StringUtils.deleteSpaces(" \t abc \n ") = "abc"
    StringUtils.deleteSpaces("ab c") = "abc"
    StringUtils.deleteSpaces("a\nb\tc ") = "abc"
    

    Spaces are defined as {' ', '\t', '\r', '\n', '\b'} in line with the deprecated isSpace method.

 public static String deleteWhitespace(String str) 

    Deletes all whitespaces from a String as defined by Character#isWhitespace(char) .

    StringUtils.deleteWhitespace(null) = null
    StringUtils.deleteWhitespace("") = ""
    StringUtils.deleteWhitespace("abc") = "abc"
    StringUtils.deleteWhitespace(" ab c ") = "abc"
    
 public static String difference(String str1,
    String str2) 

    Compares two Strings, and returns the portion where they differ. (More precisely, return the remainder of the second String, starting from where it's different from the first.)

    For example, difference("i am a machine", "i am a robot") -> "robot".

    StringUtils.difference(null, null) = null
    StringUtils.difference("", "") = ""
    StringUtils.difference("", "abc") = "abc"
    StringUtils.difference("abc", "") = ""
    StringUtils.difference("abc", "abc") = ""
    StringUtils.difference("ab", "abxyz") = "xyz"
    StringUtils.difference("abcde", "abxyz") = "xyz"
    StringUtils.difference("abcde", "xyz") = "xyz"
    
 public static boolean endsWith(String str,
    String suffix) 

    Check if a String ends with a specified suffix.

    nulls are handled without exceptions. Two null references are considered to be equal. The comparison is case sensitive.

    StringUtils.endsWith(null, null) = true
    StringUtils.endsWith(null, "abcdef") = false
    StringUtils.endsWith("def", null) = false
    StringUtils.endsWith("def", "abcdef") = true
    StringUtils.endsWith("def", "ABCDEF") = false
    
 public static boolean endsWithIgnoreCase(String str,
    String suffix) 

    Case insensitive check if a String ends with a specified suffix.

    nulls are handled without exceptions. Two null references are considered to be equal. The comparison is case insensitive.

    StringUtils.endsWithIgnoreCase(null, null) = true
    StringUtils.endsWithIgnoreCase(null, "abcdef") = false
    StringUtils.endsWithIgnoreCase("def", null) = false
    StringUtils.endsWithIgnoreCase("def", "abcdef") = true
    StringUtils.endsWithIgnoreCase("def", "ABCDEF") = false
    
 public static boolean equals(String str1,
    String str2) 

    Compares two Strings, returning true if they are equal.

    nulls are handled without exceptions. Two null references are considered to be equal. The comparison is case sensitive.

    StringUtils.equals(null, null) = true
    StringUtils.equals(null, "abc") = false
    StringUtils.equals("abc", null) = false
    StringUtils.equals("abc", "abc") = true
    StringUtils.equals("abc", "ABC") = false
    
 public static boolean equalsIgnoreCase(String str1,
    String str2) 

    Compares two Strings, returning true if they are equal ignoring the case.

    nulls are handled without exceptions. Two null references are considered equal. Comparison is case insensitive.

    StringUtils.equalsIgnoreCase(null, null) = true
    StringUtils.equalsIgnoreCase(null, "abc") = false
    StringUtils.equalsIgnoreCase("abc", null) = false
    StringUtils.equalsIgnoreCase("abc", "abc") = true
    StringUtils.equalsIgnoreCase("abc", "ABC") = true
    
 public static String escape(String str) 
Deprecated! Use - StringEscapeUtils#escapeJava(String) This method will be removed in Commons Lang 3.0

    Escapes any values it finds into their String form.

    So a tab becomes the characters '\\' and 't'.

    As of Lang 2.0, this calls StringEscapeUtils#escapeJava(String) behind the scenes.

 public static String getChomp(String str,
    String sep) 
Deprecated! Use - #substringAfterLast(String, String) instead (although this doesn't include the separator) Method will be removed in Commons Lang 3.0.

    Remove everything and return the last value of a supplied String, and everything after it from a String.

 public static String getCommonPrefix(String[] strs) 

    Compares all Strings in an array and returns the initial sequence of characters that is common to all of them.

    For example, getCommonPrefix(new String[] {"i am a machine", "i am a robot"}) -> "i am a "

    StringUtils.getCommonPrefix(null) = ""
    StringUtils.getCommonPrefix(new String[] {}) = ""
    StringUtils.getCommonPrefix(new String[] {"abc"}) = "abc"
    StringUtils.getCommonPrefix(new String[] {null, null}) = ""
    StringUtils.getCommonPrefix(new String[] {"", ""}) = ""
    StringUtils.getCommonPrefix(new String[] {"", null}) = ""
    StringUtils.getCommonPrefix(new String[] {"abc", null, null}) = ""
    StringUtils.getCommonPrefix(new String[] {null, null, "abc"}) = ""
    StringUtils.getCommonPrefix(new String[] {"", "abc"}) = ""
    StringUtils.getCommonPrefix(new String[] {"abc", ""}) = ""
    StringUtils.getCommonPrefix(new String[] {"abc", "abc"}) = "abc"
    StringUtils.getCommonPrefix(new String[] {"abc", "a"}) = "a"
    StringUtils.getCommonPrefix(new String[] {"ab", "abxyz"}) = "ab"
    StringUtils.getCommonPrefix(new String[] {"abcde", "abxyz"}) = "ab"
    StringUtils.getCommonPrefix(new String[] {"abcde", "xyz"}) = ""
    StringUtils.getCommonPrefix(new String[] {"xyz", "abcde"}) = ""
    StringUtils.getCommonPrefix(new String[] {"i am a machine", "i am a robot"}) = "i am a "
    
 public static int getLevenshteinDistance(String s,
    String t) 

    Find the Levenshtein distance between two Strings.

    This is the number of changes needed to change one String into another, where each change is a single character modification (deletion, insertion or substitution).

    The previous implementation of the Levenshtein distance algorithm was from http://www.merriampark.com/ld.htm

    Chas Emerick has written an implementation in Java, which avoids an OutOfMemoryError which can occur when my Java implementation is used with very large strings.
    This implementation of the Levenshtein distance algorithm is from http://www.merriampark.com/ldjava.htm

    StringUtils.getLevenshteinDistance(null, *) = IllegalArgumentException
    StringUtils.getLevenshteinDistance(*, null) = IllegalArgumentException
    StringUtils.getLevenshteinDistance("","") = 0
    StringUtils.getLevenshteinDistance("","a") = 1
    StringUtils.getLevenshteinDistance("aaapppp", "") = 7
    StringUtils.getLevenshteinDistance("frog", "fog") = 1
    StringUtils.getLevenshteinDistance("fly", "ant") = 3
    StringUtils.getLevenshteinDistance("elephant", "hippo") = 7
    StringUtils.getLevenshteinDistance("hippo", "elephant") = 7
    StringUtils.getLevenshteinDistance("hippo", "zzzzzzzz") = 8
    StringUtils.getLevenshteinDistance("hello", "hallo") = 1
    
 public static String getNestedString(String str,
    String tag) 
Deprecated! Use - the better named #substringBetween(String, String) . Method will be removed in Commons Lang 3.0.

    Gets the String that is nested in between two instances of the same String.

    A null input String returns null. A null tag returns null.

    StringUtils.getNestedString(null, *) = null
    StringUtils.getNestedString("", "") = ""
    StringUtils.getNestedString("", "tag") = null
    StringUtils.getNestedString("tagabctag", null) = null
    StringUtils.getNestedString("tagabctag", "") = ""
    StringUtils.getNestedString("tagabctag", "tag") = "abc"
    
 public static String getNestedString(String str,
    String open,
    String close) 
Deprecated! Use - the better named #substringBetween(String, String, String) . Method will be removed in Commons Lang 3.0.

    Gets the String that is nested in between two Strings. Only the first match is returned.

    A null input String returns null. A null open/close returns null (no match). An empty ("") open/close returns an empty string.

    StringUtils.getNestedString(null, *, *) = null
    StringUtils.getNestedString("", "", "") = ""
    StringUtils.getNestedString("", "", "tag") = null
    StringUtils.getNestedString("", "tag", "tag") = null
    StringUtils.getNestedString("yabcz", null, null) = null
    StringUtils.getNestedString("yabcz", "", "") = ""
    StringUtils.getNestedString("yabcz", "y", "z") = "abc"
    StringUtils.getNestedString("yabczyabcz", "y", "z") = "abc"
    
 public static String getPrechomp(String str,
    String sep) 
Deprecated! Use - #substringBefore(String,String) instead (although this doesn't include the separator). Method will be removed in Commons Lang 3.0.

    Remove and return everything before the first value of a supplied String from another String.

 public static int indexOf(String str,
    char searchChar) 

    Finds the first index within a String, handling null. This method uses String#indexOf(int) .

    A null or empty ("") String will return -1.

    StringUtils.indexOf(null, *) = -1
    StringUtils.indexOf("", *) = -1
    StringUtils.indexOf("aabaabaa", 'a') = 0
    StringUtils.indexOf("aabaabaa", 'b') = 2
    
 public static int indexOf(String str,
    String searchStr) 

    Finds the first index within a String, handling null. This method uses String#indexOf(String) .

    A null String will return -1.

    StringUtils.indexOf(null, *) = -1
    StringUtils.indexOf(*, null) = -1
    StringUtils.indexOf("", "") = 0
    StringUtils.indexOf("aabaabaa", "a") = 0
    StringUtils.indexOf("aabaabaa", "b") = 2
    StringUtils.indexOf("aabaabaa", "ab") = 1
    StringUtils.indexOf("aabaabaa", "") = 0
    
 public static int indexOf(String str,
    char searchChar,
    int startPos) 

    Finds the first index within a String from a start position, handling null. This method uses String#indexOf(int, int) .

    A null or empty ("") String will return -1. A negative start position is treated as zero. A start position greater than the string length returns -1.

    StringUtils.indexOf(null, *, *) = -1
    StringUtils.indexOf("", *, *) = -1
    StringUtils.indexOf("aabaabaa", 'b', 0) = 2
    StringUtils.indexOf("aabaabaa", 'b', 3) = 5
    StringUtils.indexOf("aabaabaa", 'b', 9) = -1
    StringUtils.indexOf("aabaabaa", 'b', -1) = 2
    
 public static int indexOf(String str,
    String searchStr,
    int startPos) 

    Finds the first index within a String, handling null. This method uses String#indexOf(String, int) .

    A null String will return -1. A negative start position is treated as zero. An empty ("") search String always matches. A start position greater than the string length only matches an empty search String.

    StringUtils.indexOf(null, *, *) = -1
    StringUtils.indexOf(*, null, *) = -1
    StringUtils.indexOf("", "", 0) = 0
    StringUtils.indexOf("aabaabaa", "a", 0) = 0
    StringUtils.indexOf("aabaabaa", "b", 0) = 2
    StringUtils.indexOf("aabaabaa", "ab", 0) = 1
    StringUtils.indexOf("aabaabaa", "b", 3) = 5
    StringUtils.indexOf("aabaabaa", "b", 9) = -1
    StringUtils.indexOf("aabaabaa", "b", -1) = 2
    StringUtils.indexOf("aabaabaa", "", 2) = 2
    StringUtils.indexOf("abc", "", 9) = 3
    
 public static int indexOfAny(String str,
    char[] searchChars) 

    Search a String to find the first index of any character in the given set of characters.

    A null String will return -1. A null or zero length search array will return -1.

    StringUtils.indexOfAny(null, *) = -1
    StringUtils.indexOfAny("", *) = -1
    StringUtils.indexOfAny(*, null) = -1
    StringUtils.indexOfAny(*, []) = -1
    StringUtils.indexOfAny("zzabyycdxx",['z','a']) = 0
    StringUtils.indexOfAny("zzabyycdxx",['b','y']) = 3
    StringUtils.indexOfAny("aba", ['z']) = -1
    
 public static int indexOfAny(String str,
    String searchChars) 

    Search a String to find the first index of any character in the given set of characters.

    A null String will return -1. A null search string will return -1.

    StringUtils.indexOfAny(null, *) = -1
    StringUtils.indexOfAny("", *) = -1
    StringUtils.indexOfAny(*, null) = -1
    StringUtils.indexOfAny(*, "") = -1
    StringUtils.indexOfAny("zzabyycdxx", "za") = 0
    StringUtils.indexOfAny("zzabyycdxx", "by") = 3
    StringUtils.indexOfAny("aba","z") = -1
    
 public static int indexOfAny(String str,
    String[] searchStrs) 

    Find the first index of any of a set of potential substrings.

    A null String will return -1. A null or zero length search array will return -1. A null search array entry will be ignored, but a search array containing "" will return 0 if str is not null. This method uses String#indexOf(String) .

    StringUtils.indexOfAny(null, *) = -1
    StringUtils.indexOfAny(*, null) = -1
    StringUtils.indexOfAny(*, []) = -1
    StringUtils.indexOfAny("zzabyycdxx", ["ab","cd"]) = 2
    StringUtils.indexOfAny("zzabyycdxx", ["cd","ab"]) = 2
    StringUtils.indexOfAny("zzabyycdxx", ["mn","op"]) = -1
    StringUtils.indexOfAny("zzabyycdxx", ["zab","aby"]) = 1
    StringUtils.indexOfAny("zzabyycdxx", [""]) = 0
    StringUtils.indexOfAny("", [""]) = 0
    StringUtils.indexOfAny("", ["a"]) = -1
    
 public static int indexOfAnyBut(String str,
    char[] searchChars) 

    Search a String to find the first index of any character not in the given set of characters.

    A null String will return -1. A null or zero length search array will return -1.

    StringUtils.indexOfAnyBut(null, *) = -1
    StringUtils.indexOfAnyBut("", *) = -1
    StringUtils.indexOfAnyBut(*, null) = -1
    StringUtils.indexOfAnyBut(*, []) = -1
    StringUtils.indexOfAnyBut("zzabyycdxx",'za') = 3
    StringUtils.indexOfAnyBut("zzabyycdxx", '') = 0
    StringUtils.indexOfAnyBut("aba", 'ab') = -1
    
 public static int indexOfAnyBut(String str,
    String searchChars) 

    Search a String to find the first index of any character not in the given set of characters.

    A null String will return -1. A null search string will return -1.

    StringUtils.indexOfAnyBut(null, *) = -1
    StringUtils.indexOfAnyBut("", *) = -1
    StringUtils.indexOfAnyBut(*, null) = -1
    StringUtils.indexOfAnyBut(*, "") = -1
    StringUtils.indexOfAnyBut("zzabyycdxx", "za") = 3
    StringUtils.indexOfAnyBut("zzabyycdxx", "") = 0
    StringUtils.indexOfAnyBut("aba","ab") = -1
    
 public static int indexOfDifference(String[] strs) 

    Compares all Strings in an array and returns the index at which the Strings begin to differ.

    For example, indexOfDifference(new String[] {"i am a machine", "i am a robot"}) -> 7

    StringUtils.indexOfDifference(null) = -1
    StringUtils.indexOfDifference(new String[] {}) = -1
    StringUtils.indexOfDifference(new String[] {"abc"}) = -1
    StringUtils.indexOfDifference(new String[] {null, null}) = -1
    StringUtils.indexOfDifference(new String[] {"", ""}) = -1
    StringUtils.indexOfDifference(new String[] {"", null}) = 0
    StringUtils.indexOfDifference(new String[] {"abc", null, null}) = 0
    StringUtils.indexOfDifference(new String[] {null, null, "abc"}) = 0
    StringUtils.indexOfDifference(new String[] {"", "abc"}) = 0
    StringUtils.indexOfDifference(new String[] {"abc", ""}) = 0
    StringUtils.indexOfDifference(new String[] {"abc", "abc"}) = -1
    StringUtils.indexOfDifference(new String[] {"abc", "a"}) = 1
    StringUtils.indexOfDifference(new String[] {"ab", "abxyz"}) = 2
    StringUtils.indexOfDifference(new String[] {"abcde", "abxyz"}) = 2
    StringUtils.indexOfDifference(new String[] {"abcde", "xyz"}) = 0
    StringUtils.indexOfDifference(new String[] {"xyz", "abcde"}) = 0
    StringUtils.indexOfDifference(new String[] {"i am a machine", "i am a robot"}) = 7
    
 public static int indexOfDifference(String str1,
    String str2) 

    Compares two Strings, and returns the index at which the Strings begin to differ.

    For example, indexOfDifference("i am a machine", "i am a robot") -> 7

    StringUtils.indexOfDifference(null, null) = -1
    StringUtils.indexOfDifference("", "") = -1
    StringUtils.indexOfDifference("", "abc") = 0
    StringUtils.indexOfDifference("abc", "") = 0
    StringUtils.indexOfDifference("abc", "abc") = -1
    StringUtils.indexOfDifference("ab", "abxyz") = 2
    StringUtils.indexOfDifference("abcde", "abxyz") = 2
    StringUtils.indexOfDifference("abcde", "xyz") = 0
    
 public static boolean isAlpha(String str) 

    Checks if the String contains only unicode letters.

    null will return false. An empty String ("") will return true.

    StringUtils.isAlpha(null) = false
    StringUtils.isAlpha("") = true
    StringUtils.isAlpha(" ") = false
    StringUtils.isAlpha("abc") = true
    StringUtils.isAlpha("ab2c") = false
    StringUtils.isAlpha("ab-c") = false
    
 public static boolean isAlphaSpace(String str) 

    Checks if the String contains only unicode letters and space (' ').

    null will return false An empty String ("") will return true.

    StringUtils.isAlphaSpace(null) = false
    StringUtils.isAlphaSpace("") = true
    StringUtils.isAlphaSpace(" ") = true
    StringUtils.isAlphaSpace("abc") = true
    StringUtils.isAlphaSpace("ab c") = true
    StringUtils.isAlphaSpace("ab2c") = false
    StringUtils.isAlphaSpace("ab-c") = false
    
 public static boolean isAlphanumeric(String str) 

    Checks if the String contains only unicode letters or digits.

    null will return false. An empty String ("") will return true.

    StringUtils.isAlphanumeric(null) = false
    StringUtils.isAlphanumeric("") = true
    StringUtils.isAlphanumeric(" ") = false
    StringUtils.isAlphanumeric("abc") = true
    StringUtils.isAlphanumeric("ab c") = false
    StringUtils.isAlphanumeric("ab2c") = true
    StringUtils.isAlphanumeric("ab-c") = false
    
 public static boolean isAlphanumericSpace(String str) 

    Checks if the String contains only unicode letters, digits or space (' ').

    null will return false. An empty String ("") will return true.

    StringUtils.isAlphanumeric(null) = false
    StringUtils.isAlphanumeric("") = true
    StringUtils.isAlphanumeric(" ") = true
    StringUtils.isAlphanumeric("abc") = true
    StringUtils.isAlphanumeric("ab c") = true
    StringUtils.isAlphanumeric("ab2c") = true
    StringUtils.isAlphanumeric("ab-c") = false
    
 public static boolean isAsciiPrintable(String str) 

    Checks if the string contains only ASCII printable characters.

    null will return false. An empty String ("") will return true.

    StringUtils.isAsciiPrintable(null) = false
    StringUtils.isAsciiPrintable("") = true
    StringUtils.isAsciiPrintable(" ") = true
    StringUtils.isAsciiPrintable("Ceki") = true
    StringUtils.isAsciiPrintable("ab2c") = true
    StringUtils.isAsciiPrintable("!ab-c~") = true
    StringUtils.isAsciiPrintable("\u0020") = true
    StringUtils.isAsciiPrintable("\u0021") = true
    StringUtils.isAsciiPrintable("\u007e") = true
    StringUtils.isAsciiPrintable("\u007f") = false
    StringUtils.isAsciiPrintable("Ceki G\u00fclc\u00fc") = false
    
 public static boolean isBlank(String str) 

    Checks if a String is whitespace, empty ("") or null.

    StringUtils.isBlank(null) = true
    StringUtils.isBlank("") = true
    StringUtils.isBlank(" ") = true
    StringUtils.isBlank("bob") = false
    StringUtils.isBlank(" bob ") = false
    
 public static boolean isEmpty(String str) 

    Checks if a String is empty ("") or null.

    StringUtils.isEmpty(null) = true
    StringUtils.isEmpty("") = true
    StringUtils.isEmpty(" ") = false
    StringUtils.isEmpty("bob") = false
    StringUtils.isEmpty(" bob ") = false
    

    NOTE: This method changed in Lang version 2.0. It no longer trims the String. That functionality is available in isBlank().

 public static boolean isNotBlank(String str) 

    Checks if a String is not empty (""), not null and not whitespace only.

    StringUtils.isNotBlank(null) = false
    StringUtils.isNotBlank("") = false
    StringUtils.isNotBlank(" ") = false
    StringUtils.isNotBlank("bob") = true
    StringUtils.isNotBlank(" bob ") = true
    
 public static boolean isNotEmpty(String str) 

    Checks if a String is not empty ("") and not null.

    StringUtils.isNotEmpty(null) = false
    StringUtils.isNotEmpty("") = false
    StringUtils.isNotEmpty(" ") = true
    StringUtils.isNotEmpty("bob") = true
    StringUtils.isNotEmpty(" bob ") = true
    
 public static boolean isNumeric(String str) 

    Checks if the String contains only unicode digits. A decimal point is not a unicode digit and returns false.

    null will return false. An empty String ("") will return true.

    StringUtils.isNumeric(null) = false
    StringUtils.isNumeric("") = true
    StringUtils.isNumeric(" ") = false
    StringUtils.isNumeric("123") = true
    StringUtils.isNumeric("12 3") = false
    StringUtils.isNumeric("ab2c") = false
    StringUtils.isNumeric("12-3") = false
    StringUtils.isNumeric("12.3") = false
    
 public static boolean isNumericSpace(String str) 

    Checks if the String contains only unicode digits or space (' '). A decimal point is not a unicode digit and returns false.

    null will return false. An empty String ("") will return true.

    StringUtils.isNumeric(null) = false
    StringUtils.isNumeric("") = true
    StringUtils.isNumeric(" ") = true
    StringUtils.isNumeric("123") = true
    StringUtils.isNumeric("12 3") = true
    StringUtils.isNumeric("ab2c") = false
    StringUtils.isNumeric("12-3") = false
    StringUtils.isNumeric("12.3") = false
    
 public static boolean isWhitespace(String str) 

    Checks if the String contains only whitespace.

    null will return false. An empty String ("") will return true.

    StringUtils.isWhitespace(null) = false
    StringUtils.isWhitespace("") = true
    StringUtils.isWhitespace(" ") = true
    StringUtils.isWhitespace("abc") = false
    StringUtils.isWhitespace("ab2c") = false
    StringUtils.isWhitespace("ab-c") = false
    
 public static String join(Object[] array) 

    Joins the elements of the provided array into a single String containing the provided list of elements.

    No separator is added to the joined String. Null objects or empty strings within the array are represented by empty strings.

    StringUtils.join(null) = null
    StringUtils.join([]) = ""
    StringUtils.join([null]) = ""
    StringUtils.join(["a", "b", "c"]) = "abc"
    StringUtils.join([null, "", "a"]) = "a"
    
 public static String join(Object[] array,
    char separator) 

    Joins the elements of the provided array into a single String containing the provided list of elements.

    No delimiter is added before or after the list. Null objects or empty strings within the array are represented by empty strings.

    StringUtils.join(null, *) = null
    StringUtils.join([], *) = ""
    StringUtils.join([null], *) = ""
    StringUtils.join(["a", "b", "c"], ';') = "a;b;c"
    StringUtils.join(["a", "b", "c"], null) = "abc"
    StringUtils.join([null, "", "a"], ';') = ";;a"
    
 public static String join(Object[] array,
    String separator) 

    Joins the elements of the provided array into a single String containing the provided list of elements.

    No delimiter is added before or after the list. A null separator is the same as an empty String (""). Null objects or empty strings within the array are represented by empty strings.

    StringUtils.join(null, *) = null
    StringUtils.join([], *) = ""
    StringUtils.join([null], *) = ""
    StringUtils.join(["a", "b", "c"], "--") = "a--b--c"
    StringUtils.join(["a", "b", "c"], null) = "abc"
    StringUtils.join(["a", "b", "c"], "") = "abc"
    StringUtils.join([null, "", "a"], ',') = ",,a"
    
 public static String join(Iterator iterator,
    char separator) 

    Joins the elements of the provided Iterator into a single String containing the provided elements.

    No delimiter is added before or after the list. Null objects or empty strings within the iteration are represented by empty strings.

    See the examples here: #join(Object[],char) .

 public static String join(Iterator iterator,
    String separator) 

    Joins the elements of the provided Iterator into a single String containing the provided elements.

    No delimiter is added before or after the list. A null separator is the same as an empty String ("").

    See the examples here: #join(Object[],String) .

 public static String join(Collection collection,
    char separator) 

    Joins the elements of the provided Collection into a single String containing the provided elements.

    No delimiter is added before or after the list. Null objects or empty strings within the iteration are represented by empty strings.

    See the examples here: #join(Object[],char) .

 public static String join(Collection collection,
    String separator) 

    Joins the elements of the provided Collection into a single String containing the provided elements.

    No delimiter is added before or after the list. A null separator is the same as an empty String ("").

    See the examples here: #join(Object[],String) .

 public static String join(Object[] array,
    char separator,
    int startIndex,
    int endIndex) 

    Joins the elements of the provided array into a single String containing the provided list of elements.

    No delimiter is added before or after the list. Null objects or empty strings within the array are represented by empty strings.

    StringUtils.join(null, *) = null
    StringUtils.join([], *) = ""
    StringUtils.join([null], *) = ""
    StringUtils.join(["a", "b", "c"], ';') = "a;b;c"
    StringUtils.join(["a", "b", "c"], null) = "abc"
    StringUtils.join([null, "", "a"], ';') = ";;a"
    
 public static String join(Object[] array,
    String separator,
    int startIndex,
    int endIndex) 

    Joins the elements of the provided array into a single String containing the provided list of elements.

    No delimiter is added before or after the list. A null separator is the same as an empty String (""). Null objects or empty strings within the array are represented by empty strings.

    StringUtils.join(null, *) = null
    StringUtils.join([], *) = ""
    StringUtils.join([null], *) = ""
    StringUtils.join(["a", "b", "c"], "--") = "a--b--c"
    StringUtils.join(["a", "b", "c"], null) = "abc"
    StringUtils.join(["a", "b", "c"], "") = "abc"
    StringUtils.join([null, "", "a"], ',') = ",,a"
    
 public static int lastIndexOf(String str,
    char searchChar) 

    Finds the last index within a String, handling null. This method uses String#lastIndexOf(int) .

    A null or empty ("") String will return -1.

    StringUtils.lastIndexOf(null, *) = -1
    StringUtils.lastIndexOf("", *) = -1
    StringUtils.lastIndexOf("aabaabaa", 'a') = 7
    StringUtils.lastIndexOf("aabaabaa", 'b') = 5
    
 public static int lastIndexOf(String str,
    String searchStr) 

    Finds the last index within a String, handling null. This method uses String#lastIndexOf(String) .

    A null String will return -1.

    StringUtils.lastIndexOf(null, *) = -1
    StringUtils.lastIndexOf(*, null) = -1
    StringUtils.lastIndexOf("", "") = 0
    StringUtils.lastIndexOf("aabaabaa", "a") = 0
    StringUtils.lastIndexOf("aabaabaa", "b") = 2
    StringUtils.lastIndexOf("aabaabaa", "ab") = 1
    StringUtils.lastIndexOf("aabaabaa", "") = 8
    
 public static int lastIndexOf(String str,
    char searchChar,
    int startPos) 

    Finds the last index within a String from a start position, handling null. This method uses String#lastIndexOf(int, int) .

    A null or empty ("") String will return -1. A negative start position returns -1. A start position greater than the string length searches the whole string.

    StringUtils.lastIndexOf(null, *, *) = -1
    StringUtils.lastIndexOf("", *, *) = -1
    StringUtils.lastIndexOf("aabaabaa", 'b', 8) = 5
    StringUtils.lastIndexOf("aabaabaa", 'b', 4) = 2
    StringUtils.lastIndexOf("aabaabaa", 'b', 0) = -1
    StringUtils.lastIndexOf("aabaabaa", 'b', 9) = 5
    StringUtils.lastIndexOf("aabaabaa", 'b', -1) = -1
    StringUtils.lastIndexOf("aabaabaa", 'a', 0) = 0
    
 public static int lastIndexOf(String str,
    String searchStr,
    int startPos) 

    Finds the first index within a String, handling null. This method uses String#lastIndexOf(String, int) .

    A null String will return -1. A negative start position returns -1. An empty ("") search String always matches unless the start position is negative. A start position greater than the string length searches the whole string.

    StringUtils.lastIndexOf(null, *, *) = -1
    StringUtils.lastIndexOf(*, null, *) = -1
    StringUtils.lastIndexOf("aabaabaa", "a", 8) = 7
    StringUtils.lastIndexOf("aabaabaa", "b", 8) = 5
    StringUtils.lastIndexOf("aabaabaa", "ab", 8) = 4
    StringUtils.lastIndexOf("aabaabaa", "b", 9) = 5
    StringUtils.lastIndexOf("aabaabaa", "b", -1) = -1
    StringUtils.lastIndexOf("aabaabaa", "a", 0) = 0
    StringUtils.lastIndexOf("aabaabaa", "b", 0) = -1
    
 public static int lastIndexOfAny(String str,
    String[] searchStrs) 

    Find the latest index of any of a set of potential substrings.

    A null String will return -1. A null search array will return -1. A null or zero length search array entry will be ignored, but a search array containing "" will return the length of str if str is not null. This method uses String#indexOf(String)

    StringUtils.lastIndexOfAny(null, *) = -1
    StringUtils.lastIndexOfAny(*, null) = -1
    StringUtils.lastIndexOfAny(*, []) = -1
    StringUtils.lastIndexOfAny(*, [null]) = -1
    StringUtils.lastIndexOfAny("zzabyycdxx", ["ab","cd"]) = 6
    StringUtils.lastIndexOfAny("zzabyycdxx", ["cd","ab"]) = 6
    StringUtils.lastIndexOfAny("zzabyycdxx", ["mn","op"]) = -1
    StringUtils.lastIndexOfAny("zzabyycdxx", ["mn","op"]) = -1
    StringUtils.lastIndexOfAny("zzabyycdxx", ["mn",""]) = 10
    
 public static String left(String str,
    int len) 

    Gets the leftmost len characters of a String.

    If len characters are not available, or the String is null, the String will be returned without an exception. An exception is thrown if len is negative.

    StringUtils.left(null, *) = null
    StringUtils.left(*, -ve) = ""
    StringUtils.left("", *) = ""
    StringUtils.left("abc", 0) = ""
    StringUtils.left("abc", 2) = "ab"
    StringUtils.left("abc", 4) = "abc"
    
 public static String leftPad(String str,
    int size) 

    Left pad a String with spaces (' ').

    The String is padded to the size of size.

    StringUtils.leftPad(null, *) = null
    StringUtils.leftPad("", 3) = " "
    StringUtils.leftPad("bat", 3) = "bat"
    StringUtils.leftPad("bat", 5) = " bat"
    StringUtils.leftPad("bat", 1) = "bat"
    StringUtils.leftPad("bat", -1) = "bat"
    
 public static String leftPad(String str,
    int size,
    char padChar) 

    Left pad a String with a specified character.

    Pad to a size of size.

    StringUtils.leftPad(null, *, *) = null
    StringUtils.leftPad("", 3, 'z') = "zzz"
    StringUtils.leftPad("bat", 3, 'z') = "bat"
    StringUtils.leftPad("bat", 5, 'z') = "zzbat"
    StringUtils.leftPad("bat", 1, 'z') = "bat"
    StringUtils.leftPad("bat", -1, 'z') = "bat"
    
 public static String leftPad(String str,
    int size,
    String padStr)