StringUtil (liquibase-root 4.3.2 API)

java.lang.Object
- liquibase.util.StringUtil

```
public class StringUtil
extends Object
```
Various utility methods for working with strings.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`StringUtil.DefaultFormatter`
`static interface`	`StringUtil.StringUtilFormatter<Type>`
`static class`	`StringUtil.ToStringFormatter`

Constructor Summary

Constructors
Constructor and Description

StringUtil()

Constructors
Constructor and Description
`StringUtil()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static String`	`concatConsistentCase(String baseString, String addition)` Concatenates the addition string to the baseString string, adjusting the case of "addition" to match the base string.
`static boolean`	`equalsIgnoreCaseAndEmpty(String s1, String s2)` Returns if two strings are equal, ignoring: case (uppercase/lowercase) difference between null, and empty string, and a string that only has spaces
`static String`	`escapeHtml(String str)`
`static String`	`escapeXml(CharSequence s)`
`static String`	`getLastBlockComment(String sqlString)`
`static String`	`getLastLineComment(String sqlString)`
`static boolean`	`hasLowerCase(String string)`
`static boolean`	`hasUpperCase(String string)`
`static String`	`indent(String string)`
`static String`	`indent(String string, int padding)`
`static boolean`	`isAscii(char ch)` Returns true if ch is a "7-bit-clean" ASCII character (ordinal number < 128).
`static boolean`	`isAscii(String string)`
`protected static boolean`	`isDelimiter(String piece, String previousPiece, String endDelimiter)` Returns true if the input is a delimiter in one of the popular RDBMSs.
`static boolean`	`isEmpty(String value)` Returns true if the input string is the empty string (null-safe).
`static boolean`	`isMinimumVersion(String minimumVersion, int candidateMajor, int candidateMinor, int candidatePatch)` Compares a minimum version number given in string form (only the first three parts are considered) with a candidate version given as the three ints major, minor and patch.
`static boolean`	`isNotEmpty(String value)` Returns true if the input string is NOT the empty string.
`static boolean`	`isWhitespace(CharSequence string)` Returns true if the given string only consists of whitespace characters (null-safe)
`static String`	`join(Collection<String> collection, String delimiter)`
`static String`	`join(Collection<String> collection, String delimiter, boolean sorted)`
`static String`	`join(Collection collection, String delimiter, StringUtil.StringUtilFormatter formatter)`
`static String`	`join(Collection collection, String delimiter, StringUtil.StringUtilFormatter formatter, boolean sorted)`
`static String`	`join(ExtensibleObject extensibleObject, String delimiter)`
`static String`	`join(ExtensibleObject extensibleObject, String delimiter, StringUtil.StringUtilFormatter formatter)`
`static String`	`join(int[] array, String delimiter)`
`static String`	`join(Integer[] array, String delimiter)`
`static String`	`join(Map map, String delimiter)`
`static String`	`join(Map map, String delimiter, StringUtil.StringUtilFormatter formatter)`
`static String`	`join(Object[] array, String delimiter, StringUtil.StringUtilFormatter formatter)`
`static String`	`join(String[] array, String delimiter)`
`static String`	`leftPad(String value, int length)` Adds spaces to the left of the input value until the string has reached the given length.
`static String`	`limitSize(String string, int maxLength)`
`static String`	`lowerCaseFirst(String string)`
`static String`	`pad(String value, int length)` Adds spaces to the right of the input value until the string has reached the given length.
`static String[]`	`processMutliLineSQL(String multiLineSQL, boolean stripComments, boolean splitStatements, String endDelimiter)` Removes any comments from multiple line SQL using `stripComments(String)` and then extracts each individual statement using `splitSQL(String, String)`.
`static String`	`randomIdentifer(int len)` Produce a random identifer of the given length, consisting only of uppercase letters.
`static String`	`repeat(String string, int times)`
`static List<String>`	`splitAndTrim(String s, String regex)`
`static String[]`	`splitSQL(String multiLineSQL, String endDelimiter)` Splits a candidate multi-line SQL statement along ;'s and "go"'s.
`static String`	`standardizeLineEndings(String string)`
`static boolean`	`startsWith(String value, String startsWith)` Checks if `value` starts with `startsWith`.
`static String`	`stripComments(String multiLineSQL)` Searches through a String which contains SQL code and strips out any comments that are between \/**\/ or anything that matches SP--SP\n (to support the ANSI standard commenting of -- at the end of a line).
`static String`	`stripSqlCommentsAndWhitespacesFromTheEnd(String sqlString)` Strips the comments and whitespaces from the end of given sql string.
`static String`	`substring(String str, int start, int end)` From commonslang3 -> StringUtil
`static String`	`trimRight(String string)` Trims `whitespace` characters from the end of specified `string`
`static String`	`trimToEmpty(String string)` Returns the trimmed (left and right) version of the input string.
`static String`	`trimToNull(String string)` Returns the trimmed (left and right) form of the input string.
`static String`	`upperCaseFirst(String string)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - StringUtil
```
public StringUtil()
```
- Method Detail
  - trimToEmpty
```
public static String trimToEmpty(String string)
```
    Returns the trimmed (left and right) version of the input string. If null is passed, an empty string is returned.
    
    Parameters:
    
    string - the input string to trim
    
    Returns:
    
    the trimmed string, or an empty string if the input was null.
  - trimToNull
```
public static String trimToNull(String string)
```
    Returns the trimmed (left and right) form of the input string. If the string is empty after trimming (or null was passed in the first place), null is returned, i.e. the input string is reduced to nothing.
    
    Parameters:
    
    string - the string to trim
    
    Returns:
    
    the trimmed string or null
  - processMutliLineSQL
```
public static String[] processMutliLineSQL(String multiLineSQL,
                                           boolean stripComments,
                                           boolean splitStatements,
                                           String endDelimiter)
```
    Removes any comments from multiple line SQL using stripComments(String) and then extracts each individual statement using splitSQL(String, String).
    
    Parameters:
    
    multiLineSQL - A String containing all the SQL statements
    
    stripComments - If true then comments will be stripped, if false then they will be left in the code
  - isDelimiter
```
protected static boolean isDelimiter(String piece,
                                     String previousPiece,
                                     String endDelimiter)
```
    Returns true if the input is a delimiter in one of the popular RDBMSs. Recognized delimiters are: semicolon (;), a slash (as the only content) or the word GO (as the only content).
    
    Parameters:
    
    piece - the input line to test
    
    previousPiece - the characters in the input stream that came before piece
    
    endDelimiter - ??? (need to see this in a debugger to find out)
  - splitSQL
```
public static String[] splitSQL(String multiLineSQL,
                                String endDelimiter)
```
    Splits a candidate multi-line SQL statement along ;'s and "go"'s.
  - stripComments
```
public static String stripComments(String multiLineSQL)
```
    Searches through a String which contains SQL code and strips out any comments that are between \/**\/ or anything that matches SP--SP\n (to support the ANSI standard commenting of -- at the end of a line).
    
    Returns:
    
    The String without the comments in
  - join
```
public static String join(Object[] array,
                          String delimiter,
                          StringUtil.StringUtilFormatter formatter)
```
  - join
```
public static String join(String[] array,
                          String delimiter)
```
  - join
```
public static String join(Collection<String> collection,
                          String delimiter)
```
  - join
```
public static String join(Collection collection,
                          String delimiter,
                          StringUtil.StringUtilFormatter formatter)
```
  - join
```
public static String join(Collection collection,
                          String delimiter,
                          StringUtil.StringUtilFormatter formatter,
                          boolean sorted)
```
  - join
```
public static String join(Collection<String> collection,
                          String delimiter,
                          boolean sorted)
```
  - join
```
public static String join(Map map,
                          String delimiter)
```
  - join
```
public static String join(Map map,
                          String delimiter,
                          StringUtil.StringUtilFormatter formatter)
```
  - join
```
public static String join(ExtensibleObject extensibleObject,
                          String delimiter)
```
  - join
```
public static String join(ExtensibleObject extensibleObject,
                          String delimiter,
                          StringUtil.StringUtilFormatter formatter)
```
  - splitAndTrim
```
public static List<String> splitAndTrim(String s,
                                        String regex)
```
  - repeat
```
public static String repeat(String string,
                            int times)
```
  - join
```
public static String join(Integer[] array,
                          String delimiter)
```
  - join
```
public static String join(int[] array,
                          String delimiter)
```
  - indent
```
public static String indent(String string)
```
  - indent
```
public static String indent(String string,
                            int padding)
```
  - lowerCaseFirst
```
public static String lowerCaseFirst(String string)
```
  - upperCaseFirst
```
public static String upperCaseFirst(String string)
```
  - hasUpperCase
```
public static boolean hasUpperCase(String string)
```
  - hasLowerCase
```
public static boolean hasLowerCase(String string)
```
  - standardizeLineEndings
```
public static String standardizeLineEndings(String string)
```
  - isAscii
```
public static boolean isAscii(String string)
```
  - isAscii
```
public static boolean isAscii(char ch)
```
    Returns true if ch is a "7-bit-clean" ASCII character (ordinal number < 128).
    
    Parameters:
    
    ch - the character to test
    
    Returns:
    
    true if 7 bit-clean, false otherwise.
  - escapeHtml
```
public static String escapeHtml(String str)
```
  - pad
```
public static String pad(String value,
                         int length)
```
    Adds spaces to the right of the input value until the string has reached the given length. Nothing is done if the string already has the given length or if the string is even longer.
    
    Parameters:
    
    value - The string to pad (if necessary)
    
    length - the desired length
    
    Returns:
    
    the input string, padded if necessary.
  - leftPad
```
public static String leftPad(String value,
                             int length)
```
    Adds spaces to the left of the input value until the string has reached the given length. Nothing is done if the string already has the given length or if the string is even longer.
    
    Parameters:
    
    value - The string to pad (if necessary)
    
    length - the desired length
    
    Returns:
    
    the input string, padded if necessary.
  - isEmpty
```
public static boolean isEmpty(String value)
```
    Returns true if the input string is the empty string (null-safe).
    
    Parameters:
    
    value - String to be checked
    
    Returns:
    
    true if String is null or empty
  - isNotEmpty
```
public static boolean isNotEmpty(String value)
```
    Returns true if the input string is NOT the empty string. If the string is null, false is returned.
    
    Parameters:
    
    value - String to be checked
    
    Returns:
    
    true if string is not null and not empty (length > 0)
  - startsWith
```
public static boolean startsWith(String value,
                                 String startsWith)
```
    Checks if value starts with startsWith.
    
    Parameters:
    
    value -
    
    startsWith -
    
    Returns:
    
    true if value starts with startsWith, otherwise false. If any of arguments is null returns false
  - isWhitespace
```
public static boolean isWhitespace(CharSequence string)
```
    Returns true if the given string only consists of whitespace characters (null-safe)
    
    Parameters:
    
    string - the string to test
    
    Returns:
    
    true if the string is null or only consists of whitespaces.
  - isMinimumVersion
```
public static boolean isMinimumVersion(String minimumVersion,
                                       int candidateMajor,
                                       int candidateMinor,
                                       int candidatePatch)
```
    Compares a minimum version number given in string form (only the first three parts are considered) with a candidate version given as the three ints major, minor and patch.
    
    Parameters:
    
    minimumVersion - The minimum version that is required, given as a string with up to 3 parts, e.g. "7.4" or "9.6.3"
    
    candidateMajor - the version number to be tested, major part
    
    candidateMinor - the version number to be tested, minor part
    
    candidatePatch - the version number to be tested, patch part
    
    Returns:
    
    true if candidateMajor.candidateMinor.candidatePatch >= minimumVersion or false if not
  - limitSize
```
public static String limitSize(String string,
                               int maxLength)
```
  - randomIdentifer
```
public static String randomIdentifer(int len)
```
    Produce a random identifer of the given length, consisting only of uppercase letters.
    
    Parameters:
    
    len - desired length of the string
    
    Returns:
    
    an identifier of the desired length
  - equalsIgnoreCaseAndEmpty
```
public static boolean equalsIgnoreCaseAndEmpty(String s1,
                                               String s2)
```
    Returns if two strings are equal, ignoring:
    - case (uppercase/lowercase)
    - difference between null, and empty string, and a string that only has spaces
    Parameters:
    
    s1 - the first String to compare (or null)
    
    s2 - the second String to compare (or null)
    
    Returns:
    
    true if the Strings are equal by the above criteria, false in all other cases
  - trimRight
```
public static String trimRight(String string)
```
    Trims whitespace characters from the end of specified string
    
    Parameters:
    
    string - String to trim
    
    Returns:
    
    new String without the whitespace at the end
  - getLastBlockComment
```
public static String getLastBlockComment(String sqlString)
```
    Parameters:
    
    sqlString -
    
    Returns:
    
    the last block comment from a Sql string if any
  - getLastLineComment
```
public static String getLastLineComment(String sqlString)
```
    Parameters:
    
    sqlString -
    
    Returns:
    
    the last line comment from a Sql string if any
  - stripSqlCommentsAndWhitespacesFromTheEnd
```
public static String stripSqlCommentsAndWhitespacesFromTheEnd(String sqlString)
```
    Strips the comments and whitespaces from the end of given sql string.
    
    Parameters:
    
    sqlString -
    
    Returns:
  - substring
```
public static String substring(String str,
                               int start,
                               int end)
```
    From commonslang3 -> StringUtil
    Gets a substring from the specified String avoiding exceptions.
    
    A negative start position can be used to start/end n characters from the end of the String.
    
    The returned substring starts with the character in the start position and ends before the end position. All position counting is zero-based -- i.e., to start at the beginning of the string use start = 0. Negative start and end positions can be used to specify offsets relative to the end of the String.
    
    If start is not strictly to the left of end, "" is returned.
```
 StringUtil.substring(null, *, *)    = null
 StringUtil.substring("", * ,  *)    = "";
 StringUtil.substring("abc", 0, 2)   = "ab"
 StringUtil.substring("abc", 2, 0)   = ""
 StringUtil.substring("abc", 2, 4)   = "c"
 StringUtil.substring("abc", 4, 6)   = ""
 StringUtil.substring("abc", 2, 2)   = ""
 StringUtil.substring("abc", -2, -1) = "b"
 StringUtil.substring("abc", -4, 2)  = "ab"
 
```
    Parameters:
    
    str - the String to get the substring from, may be null
    
    start - the position to start from, negative means count back from the end of the String by this many characters
    
    end - the position to end at (exclusive), negative means count back from the end of the String by this many characters
    
    Returns:
    
    substring from start position to end position, null if null String input
  - escapeXml
```
public static String escapeXml(CharSequence s)
```
  - concatConsistentCase
```
public static String concatConsistentCase(String baseString,
                                          String addition)
```
    Concatenates the addition string to the baseString string, adjusting the case of "addition" to match the base string. If the string is all caps, append addition in all caps. If all lower case, append in all lower case. If baseString is mixed case, make no changes to addition.

Class StringUtil

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

StringUtil

Method Detail

trimToEmpty

trimToNull

processMutliLineSQL

isDelimiter

splitSQL

stripComments

join

join

join

join

join

join

join

join

join

join

splitAndTrim

repeat

join

join

indent

indent

lowerCaseFirst

upperCaseFirst

hasUpperCase

hasLowerCase

standardizeLineEndings

isAscii

isAscii

escapeHtml

pad

leftPad

isEmpty

isNotEmpty

startsWith

isWhitespace

isMinimumVersion

limitSize

randomIdentifer

equalsIgnoreCaseAndEmpty

trimRight

getLastBlockComment

getLastLineComment

stripSqlCommentsAndWhitespacesFromTheEnd

substring

escapeXml

concatConsistentCase