Class StringUtils

Object
org.thymeleaf.util.StringUtils

public final class StringUtils extends Object

Utility methods for String objects.

This class is used as a basis for the methods offered by Strings, which in turn are the methods offered by the #strings utility object in variable expressions.

Since:
1.0
Author:
Daniel Fernández, Le Roux Bernard, Soraya Sánchez Labandeira
  • Method Details

    • toString

      public static String toString(Object target)

      Performs a null-safe toString() operation.

      Parameters:
      target - the object on which toString will be executed
      Returns:
      the result of calling target.toString() if target is not null, null if target is null.
      Since:
      2.0.12
    • abbreviate

      public static String abbreviate(Object target, int maxSize)
    • equals

      public static Boolean equals(Object first, Object second)
      Parameters:
      first - first
      second - second
      Returns:
      the result
      Since:
      2.0.16
    • equalsIgnoreCase

      public static Boolean equalsIgnoreCase(Object first, Object second)
      Parameters:
      first - first
      second - second
      Returns:
      the result
      Since:
      2.0.16
    • contains

      public static Boolean contains(Object target, String fragment)
    • containsIgnoreCase

      public static Boolean containsIgnoreCase(Object target, String fragment, Locale locale)
    • startsWith

      public static Boolean startsWith(Object target, String prefix)
    • endsWith

      public static Boolean endsWith(Object target, String suffix)
    • substring

      public static String substring(Object target, int beginIndex, int endIndex)
    • substring

      public static String substring(Object target, int beginIndex)

      copy a part of target start beginIndex to the end of target. If non-String object, toString() will be called.

      Parameters:
      target - source of the copy.
      beginIndex - index where the copy start.
      Returns:
      part of target, or null if target is null.
      Since:
      1.1.2
    • substringAfter

      public static String substringAfter(Object target, String substr)
    • substringBefore

      public static String substringBefore(Object target, String substr)
    • prepend

      public static String prepend(Object target, String prefix)
    • append

      public static String append(Object target, String suffix)
    • repeat

      public static String repeat(Object target, int times)
      Parameters:
      target - target
      times - times
      Returns:
      the result
      Since:
      2.1.0
    • concat

      public static String concat(Object... values)
      Parameters:
      values - values
      Returns:
      the result
      Since:
      2.0.16
    • concatReplaceNulls

      public static String concatReplaceNulls(String nullValue, Object... values)
      Parameters:
      nullValue - nullValue
      values - values
      Returns:
      the result
      Since:
      2.0.16
    • indexOf

      public static Integer indexOf(Object target, String fragment)
    • isEmpty

      public static boolean isEmpty(String target)
      Parameters:
      target - target
      Returns:
      the result
      Since:
      2.1.0
    • isEmptyOrWhitespace

      public static boolean isEmptyOrWhitespace(String target)
    • join

      public static String join(Object[] target, String separator)
    • join

      public static String join(Iterable<?> target, String separator)
    • join

      public static String join(Iterable<?> target, char separator)
    • split

      public static String[] split(Object target, String separator)
    • length

      public static Integer length(Object target)
    • replace

      public static String replace(Object target, String before, String after)
    • toUpperCase

      public static String toUpperCase(Object target, Locale locale)
    • toLowerCase

      public static String toLowerCase(Object target, Locale locale)
    • trim

      public static String trim(Object target)
    • pack

      public static String pack(String target)
      Removes all whitespaces and control chars at all positions, and transforms to lower case.
      Parameters:
      target - the string to be packed
      Returns:
      the packed string
      Since:
      3.0.12
    • capitalize

      public static String capitalize(Object target)

      Convert the first letter of target to uppercase (title-case, in fact).

      Parameters:
      target - the String to be capitalized. If non-String object, toString() will be called.
      Returns:
      String the result of capitalizing the target.
      Since:
      1.1.2
    • unCapitalize

      public static String unCapitalize(Object target)

      Convert the first letter of target to lowercase.

      Parameters:
      target - the String to be uncapitalized. If non-String object, toString() will be called.
      Returns:
      String the result of uncapitalizing the target.
      Since:
      1.1.2
    • capitalizeWords

      public static String capitalizeWords(Object target)

      Convert all the first letter of the words of target to uppercase (title-case, in fact). The default delimiter characters between the words are the whitespace characters (see Characters.IsWhiteSpace method in the Java doc).

      Parameters:
      target - the String to be capitalized. If non-String object, toString() will be called.
      Returns:
      String the result of capitalizing the target.
      Since:
      1.1.2
    • capitalizeWords

      public static String capitalizeWords(Object target, Object delimiters)

      Convert all the first letter of the words of target to uppercase (title-case, in fact), using the specified delimiter chars for determining word ends/starts.

      Parameters:
      target - the String to be capitalized. If non-String object, toString() will be called.
      delimiters - delimiters of the words. If non-String object, toString() will be called.
      Returns:
      String the result of capitalizing the target.
      Since:
      1.1.2
    • escapeXml

      public static String escapeXml(Object target)

      XML-escapes the specified text.

      Parameters:
      target - the text to be escaped
      Returns:
      the escaped text.
      Since:
      2.0.9
    • escapeJavaScript

      public static String escapeJavaScript(Object target)

      Escapes the specified target text as required for JavaScript code.

      Parameters:
      target - the text to be escaped
      Returns:
      the escaped text.
      Since:
      2.0.11
    • escapeJava

      public static String escapeJava(Object target)

      Escapes the specified target text as required for Java code.

      Parameters:
      target - the text to be escaped
      Returns:
      the escaped text.
      Since:
      2.0.11
    • unescapeJavaScript

      public static String unescapeJavaScript(Object target)

      Un-escapes the specified JavaScript-escaped target text back to normal form.

      Parameters:
      target - the text to be unescaped
      Returns:
      the unescaped text.
      Since:
      2.0.11
    • unescapeJava

      public static String unescapeJava(Object target)

      Un-escapes the specified Java-escaped target text back to normal form.

      Parameters:
      target - the text to be unescaped
      Returns:
      the unescaped text.
      Since:
      2.0.11
    • randomAlphanumeric

      public static String randomAlphanumeric(int count)