Package org.thymeleaf.util

Class StringUtils

  • public final class StringUtils
extends java.lang.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

    • Field Summary

      Fields 
      Modifier and Type Field Description
      private static java.lang.String ALPHA_NUMERIC  
      private static java.util.Random RANDOM  

    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      private StringUtils()  

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static java.lang.String abbreviate​(java.lang.Object target, int maxSize)  
      static java.lang.String append​(java.lang.Object target, java.lang.String suffix)  
      static java.lang.String capitalize​(java.lang.Object target)
      Convert the first letter of target to uppercase (title-case, in fact).
      static java.lang.String capitalizeWords​(java.lang.Object target)
      Convert all the first letter of the words of target to uppercase (title-case, in fact).
      static java.lang.String capitalizeWords​(java.lang.Object target, java.lang.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.
      static java.lang.String concat​(java.lang.Object... values)  
      static java.lang.String concatReplaceNulls​(java.lang.String nullValue, java.lang.Object... values)  
      static java.lang.Boolean contains​(java.lang.Object target, java.lang.String fragment)  
      static java.lang.Boolean containsIgnoreCase​(java.lang.Object target, java.lang.String fragment, java.util.Locale locale)  
      static java.lang.Boolean endsWith​(java.lang.Object target, java.lang.String suffix)  
      static java.lang.Boolean equals​(java.lang.Object first, java.lang.Object second)  
      static java.lang.Boolean equalsIgnoreCase​(java.lang.Object first, java.lang.Object second)  
      static java.lang.String escapeJava​(java.lang.Object target)
      Escapes the specified target text as required for Java code.
      static java.lang.String escapeJavaScript​(java.lang.Object target)
      Escapes the specified target text as required for JavaScript code.
      static java.lang.String escapeXml​(java.lang.Object target)
      XML-escapes the specified text.
      private static int findNextWord​(char[] buffer, int idx, char[] delimiterChars)  
      static java.lang.Integer indexOf​(java.lang.Object target, java.lang.String fragment)  
      static boolean isEmpty​(java.lang.String target)  
      static boolean isEmptyOrWhitespace​(java.lang.String target)  
      static java.lang.String join​(java.lang.Iterable<?> target, char separator)  
      static java.lang.String join​(java.lang.Iterable<?> target, java.lang.String separator)  
      static java.lang.String join​(java.lang.Object[] target, java.lang.String separator)  
      static java.lang.Integer length​(java.lang.Object target)  
      static java.lang.String pack​(java.lang.String target)
      Removes all whitespaces and control chars at all positions, and transforms to lower case.
      static java.lang.String prepend​(java.lang.Object target, java.lang.String prefix)  
      static java.lang.String randomAlphanumeric​(int count)  
      static java.lang.String repeat​(java.lang.Object target, int times)  
      static java.lang.String replace​(java.lang.Object target, java.lang.String before, java.lang.String after)  
      static java.lang.String[] split​(java.lang.Object target, java.lang.String separator)  
      static java.lang.Boolean startsWith​(java.lang.Object target, java.lang.String prefix)  
      static java.lang.String substring​(java.lang.Object target, int beginIndex)
      copy a part of target start beginIndex to the end of target.
      static java.lang.String substring​(java.lang.Object target, int beginIndex, int endIndex)  
      static java.lang.String substringAfter​(java.lang.Object target, java.lang.String substr)  
      static java.lang.String substringBefore​(java.lang.Object target, java.lang.String substr)  
      static java.lang.String toLowerCase​(java.lang.Object target, java.util.Locale locale)  
      static java.lang.String toString​(java.lang.Object target)
      Performs a null-safe toString() operation.
      static java.lang.String toUpperCase​(java.lang.Object target, java.util.Locale locale)  
      static java.lang.String trim​(java.lang.Object target)  
      static java.lang.String unCapitalize​(java.lang.Object target)
      Convert the first letter of target to lowercase.
      static java.lang.String unescapeJava​(java.lang.Object target)
      Un-escapes the specified Java-escaped target text back to normal form.
      static java.lang.String unescapeJavaScript​(java.lang.Object target)
      Un-escapes the specified JavaScript-escaped target text back to normal form.

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • RANDOM

        private static final java.util.Random RANDOM

    • Constructor Detail

      • StringUtils

        private StringUtils()

    • Method Detail

      • toString

        public static java.lang.String toString​(java.lang.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 java.lang.String abbreviate​(java.lang.Object target,
                                          int maxSize)

      • equals

        public static java.lang.Boolean equals​(java.lang.Object first,
                                       java.lang.Object second)
        Parameters:
        first - first
        second - second
        Returns:
        the result
        Since:
        2.0.16

      • equalsIgnoreCase

        public static java.lang.Boolean equalsIgnoreCase​(java.lang.Object first,
                                                 java.lang.Object second)
        Parameters:
        first - first
        second - second
        Returns:
        the result
        Since:
        2.0.16

      • contains

        public static java.lang.Boolean contains​(java.lang.Object target,
                                         java.lang.String fragment)

      • containsIgnoreCase

        public static java.lang.Boolean containsIgnoreCase​(java.lang.Object target,
                                                   java.lang.String fragment,
                                                   java.util.Locale locale)

      • startsWith

        public static java.lang.Boolean startsWith​(java.lang.Object target,
                                           java.lang.String prefix)

      • endsWith

        public static java.lang.Boolean endsWith​(java.lang.Object target,
                                         java.lang.String suffix)

      • substring

        public static java.lang.String substring​(java.lang.Object target,
                                         int beginIndex,
                                         int endIndex)

      • substring

        public static java.lang.String substring​(java.lang.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 java.lang.String substringAfter​(java.lang.Object target,
                                              java.lang.String substr)

      • substringBefore

        public static java.lang.String substringBefore​(java.lang.Object target,
                                               java.lang.String substr)

      • prepend

        public static java.lang.String prepend​(java.lang.Object target,
                                       java.lang.String prefix)

      • append

        public static java.lang.String append​(java.lang.Object target,
                                      java.lang.String suffix)

      • repeat

        public static java.lang.String repeat​(java.lang.Object target,
                                      int times)
        Parameters:
        target - target
        times - times
        Returns:
        the result
        Since:
        2.1.0

      • concat

        public static java.lang.String concat​(java.lang.Object... values)
        Parameters:
        values - values
        Returns:
        the result
        Since:
        2.0.16

      • concatReplaceNulls

        public static java.lang.String concatReplaceNulls​(java.lang.String nullValue,
                                                  java.lang.Object... values)
        Parameters:
        nullValue - nullValue
        values - values
        Returns:
        the result
        Since:
        2.0.16

      • indexOf

        public static java.lang.Integer indexOf​(java.lang.Object target,
                                        java.lang.String fragment)

      • isEmpty

        public static boolean isEmpty​(java.lang.String target)
        Parameters:
        target - target
        Returns:
        the result
        Since:
        2.1.0

      • isEmptyOrWhitespace

        public static boolean isEmptyOrWhitespace​(java.lang.String target)

      • join

        public static java.lang.String join​(java.lang.Object[] target,
                                    java.lang.String separator)

      • join

        public static java.lang.String join​(java.lang.Iterable<?> target,
                                    java.lang.String separator)

      • join

        public static java.lang.String join​(java.lang.Iterable<?> target,
                                    char separator)

      • split

        public static java.lang.String[] split​(java.lang.Object target,
                                       java.lang.String separator)

      • length

        public static java.lang.Integer length​(java.lang.Object target)

      • replace

        public static java.lang.String replace​(java.lang.Object target,
                                       java.lang.String before,
                                       java.lang.String after)

      • toUpperCase

        public static java.lang.String toUpperCase​(java.lang.Object target,
                                           java.util.Locale locale)

      • toLowerCase

        public static java.lang.String toLowerCase​(java.lang.Object target,
                                           java.util.Locale locale)

      • trim

        public static java.lang.String trim​(java.lang.Object target)

      • pack

        public static java.lang.String pack​(java.lang.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 java.lang.String capitalize​(java.lang.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 java.lang.String unCapitalize​(java.lang.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

      • findNextWord

        private static int findNextWord​(char[] buffer,
                                int idx,
                                char[] delimiterChars)

      • capitalizeWords

        public static java.lang.String capitalizeWords​(java.lang.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 java.lang.String capitalizeWords​(java.lang.Object target,
                                               java.lang.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 java.lang.String escapeXml​(java.lang.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 java.lang.String escapeJavaScript​(java.lang.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 java.lang.String escapeJava​(java.lang.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 java.lang.String unescapeJavaScript​(java.lang.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 java.lang.String unescapeJava​(java.lang.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 java.lang.String randomAlphanumeric​(int count)