Package org.thymeleaf.expression

Class Uris

  • public final class Uris
extends

    Expression Object for performing URI/URL operations (esp.escaping/unescaping) inside Thymeleaf Standard Expressions.

    An object of this class is usually available in variable evaluation expressions with the name #uris.

    Since:
    2.1.4
    Author:
    Daniel Fernández

    • Constructor Summary

      Constructors 
      Constructor Description
      Uris()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
       text)
      Perform am URI fragment identifier escape operation on a String input using UTF-8 as encoding.
       text,  encoding)
      Perform am URI fragment identifier escape operation on a String input.
       text)
      Perform am URI path escape operation on a String input using UTF-8 as encoding.
       text,  encoding)
      Perform am URI path escape operation on a String input.
       text)
      Perform am URI path segment escape operation on a String input using UTF-8 as encoding.
       text,  encoding)
      Perform am URI path segment escape operation on a String input.
       text)
      Perform am URI query parameter (name or value) escape operation on a String input using UTF-8 as encoding.
       text,  encoding)
      Perform am URI query parameter (name or value) escape operation on a String input.
       text)
      Perform am URI fragment identifier unescape operation on a String input using UTF-8 as encoding.
       text,  encoding)
      Perform am URI fragment identifier unescape operation on a String input.
       text)
      Perform am URI path unescape operation on a String input using UTF-8 as encoding.
       text,  encoding)
      Perform am URI path unescape operation on a String input.
       text)
      Perform am URI path segment unescape operation on a String input using UTF-8 as encoding.
       text,  encoding)
      Perform am URI path segment unescape operation on a String input.
       text)
      Perform am URI query parameter (name or value) unescape operation on a String input using UTF-8 as encoding.
       text,  encoding)
      Perform am URI query parameter (name or value) unescape operation on a String input.

      • Methods inherited from class java.lang.

        , , , , , , , , , ,

    • Constructor Detail

      • Uris

        public Uris()

    • Method Detail

      • escapePath

        public  escapePath​( text)

        Perform am URI path escape operation on a String input using UTF-8 as encoding.

        This method simply calls the equivalent method in the UriEscape class from the library.

        The following are the only allowed chars in an URI path (will not be escaped):

        • A-Z a-z 0-9
        • - . _ ~
        • ! $ & ' ( ) * + , ; =
        • : @
        • /

        All other chars will be escaped by converting them to the sequence of bytes that represents them in the UTF-8 and then representing each byte in %HH syntax, being HH the hexadecimal representation of the byte.

        This method is thread-safe.

        Parameters:
        text - the String to be escaped.
        Returns:
        The escaped result String. As a memory-performance improvement, will return the exact same object as the text input argument if no escaping modifications were required (and no additional String objects will be created during processing). Will return null if text is null.

      • unescapePath

        public  unescapePath​( text)

        Perform am URI path unescape operation on a String input using UTF-8 as encoding.

        This method simply calls the equivalent method in the UriEscape class from the library.

        This method will unescape every percent-encoded (%HH) sequences present in input, even for those characters that do not need to be percent-encoded in this context (unreserved characters can be percent-encoded even if/when this is not required, though it is not generally considered a good practice).

        This method will use UTF-8 in order to determine the characters specified in the percent-encoded byte sequences.

        This method is thread-safe.

        Parameters:
        text - the String to be unescaped.
        Returns:
        The unescaped result String. As a memory-performance improvement, will return the exact same object as the text input argument if no unescaping modifications were required (and no additional String objects will be created during processing). Will return null if text is null.

      • escapePath

        public  escapePath​( text,
                          encoding)

        Perform am URI path escape operation on a String input.

        This method simply calls the equivalent method in the UriEscape class from the library.

        The following are the only allowed chars in an URI path (will not be escaped):

        • A-Z a-z 0-9
        • - . _ ~
        • ! $ & ' ( ) * + , ; =
        • : @
        • /

        All other chars will be escaped by converting them to the sequence of bytes that represents them in the specified encoding and then representing each byte in %HH syntax, being HH the hexadecimal representation of the byte.

        This method is thread-safe.

        Parameters:
        text - the String to be escaped.
        encoding - the encoding to be used for unescaping.
        Returns:
        The escaped result String. As a memory-performance improvement, will return the exact same object as the text input argument if no escaping modifications were required (and no additional String objects will be created during processing). Will return null if text is null.

      • unescapePath

        public  unescapePath​( text,
                            encoding)

        Perform am URI path unescape operation on a String input.

        This method simply calls the equivalent method in the UriEscape class from the library.

        This method will unescape every percent-encoded (%HH) sequences present in input, even for those characters that do not need to be percent-encoded in this context (unreserved characters can be percent-encoded even if/when this is not required, though it is not generally considered a good practice).

        This method will use the specified encoding in order to determine the characters specified in the percent-encoded byte sequences.

        This method is thread-safe.

        Parameters:
        text - the String to be unescaped.
        encoding - the encoding to be used for unescaping.
        Returns:
        The unescaped result String. As a memory-performance improvement, will return the exact same object as the text input argument if no unescaping modifications were required (and no additional String objects will be created during processing). Will return null if text is null.

      • escapePathSegment

        public  escapePathSegment​( text)

        Perform am URI path segment escape operation on a String input using UTF-8 as encoding.

        This method simply calls the equivalent method in the UriEscape class from the library.

        The following are the only allowed chars in an URI path segment (will not be escaped):

        • A-Z a-z 0-9
        • - . _ ~
        • ! $ & ' ( ) * + , ; =
        • : @

        All other chars will be escaped by converting them to the sequence of bytes that represents them in the UTF-8 and then representing each byte in %HH syntax, being HH the hexadecimal representation of the byte.

        This method is thread-safe.

        Parameters:
        text - the String to be escaped.
        Returns:
        The escaped result String. As a memory-performance improvement, will return the exact same object as the text input argument if no escaping modifications were required (and no additional String objects will be created during processing). Will return null if text is null.

      • unescapePathSegment

        public  unescapePathSegment​( text)

        Perform am URI path segment unescape operation on a String input using UTF-8 as encoding.

        This method simply calls the equivalent method in the UriEscape class from the library.

        This method will unescape every percent-encoded (%HH) sequences present in input, even for those characters that do not need to be percent-encoded in this context (unreserved characters can be percent-encoded even if/when this is not required, though it is not generally considered a good practice).

        This method will use UTF-8 in order to determine the characters specified in the percent-encoded byte sequences.

        This method is thread-safe.

        Parameters:
        text - the String to be unescaped.
        Returns:
        The unescaped result String. As a memory-performance improvement, will return the exact same object as the text input argument if no unescaping modifications were required (and no additional String objects will be created during processing). Will return null if text is null.

      • escapePathSegment

        public  escapePathSegment​( text,
                                 encoding)

        Perform am URI path segment escape operation on a String input.

        This method simply calls the equivalent method in the UriEscape class from the library.

        The following are the only allowed chars in an URI path segment (will not be escaped):

        • A-Z a-z 0-9
        • - . _ ~
        • ! $ & ' ( ) * + , ; =
        • : @

        All other chars will be escaped by converting them to the sequence of bytes that represents them in the specified encoding and then representing each byte in %HH syntax, being HH the hexadecimal representation of the byte.

        This method is thread-safe.

        Parameters:
        text - the String to be escaped.
        encoding - the encoding to be used for escaping.
        Returns:
        The escaped result String. As a memory-performance improvement, will return the exact same object as the text input argument if no escaping modifications were required (and no additional String objects will be created during processing). Will return null if text is null.

      • unescapePathSegment

        public  unescapePathSegment​( text,
                                   encoding)

        Perform am URI path segment unescape operation on a String input.

        This method simply calls the equivalent method in the UriEscape class from the library.

        This method will unescape every percent-encoded (%HH) sequences present in input, even for those characters that do not need to be percent-encoded in this context (unreserved characters can be percent-encoded even if/when this is not required, though it is not generally considered a good practice).

        This method will use specified encoding in order to determine the characters specified in the percent-encoded byte sequences.

        This method is thread-safe.

        Parameters:
        text - the String to be unescaped.
        encoding - the encoding to be used for unescaping.
        Returns:
        The unescaped result String. As a memory-performance improvement, will return the exact same object as the text input argument if no unescaping modifications were required (and no additional String objects will be created during processing). Will return null if text is null.

      • escapeFragmentId

        public  escapeFragmentId​( text)

        Perform am URI fragment identifier escape operation on a String input using UTF-8 as encoding.

        This method simply calls the equivalent method in the UriEscape class from the library.

        The following are the only allowed chars in an URI fragment identifier (will not be escaped):

        • A-Z a-z 0-9
        • - . _ ~
        • ! $ & ' ( ) * + , ; =
        • : @
        • / ?

        All other chars will be escaped by converting them to the sequence of bytes that represents them in the UTF-8 and then representing each byte in %HH syntax, being HH the hexadecimal representation of the byte.

        This method is thread-safe.

        Parameters:
        text - the String to be escaped.
        Returns:
        The escaped result String. As a memory-performance improvement, will return the exact same object as the text input argument if no escaping modifications were required (and no additional String objects will be created during processing). Will return null if text is null.

      • unescapeFragmentId

        public  unescapeFragmentId​( text)

        Perform am URI fragment identifier unescape operation on a String input using UTF-8 as encoding.

        This method simply calls the equivalent method in the UriEscape class from the library.

        This method will unescape every percent-encoded (%HH) sequences present in input, even for those characters that do not need to be percent-encoded in this context (unreserved characters can be percent-encoded even if/when this is not required, though it is not generally considered a good practice).

        This method will use UTF-8 in order to determine the characters specified in the percent-encoded byte sequences.

        This method is thread-safe.

        Parameters:
        text - the String to be unescaped.
        Returns:
        The unescaped result String. As a memory-performance improvement, will return the exact same object as the text input argument if no unescaping modifications were required (and no additional String objects will be created during processing). Will return null if text is null.

      • escapeFragmentId

        public  escapeFragmentId​( text,
                                encoding)

        Perform am URI fragment identifier escape operation on a String input.

        This method simply calls the equivalent method in the UriEscape class from the library.

        The following are the only allowed chars in an URI fragment identifier (will not be escaped):

        • A-Z a-z 0-9
        • - . _ ~
        • ! $ & ' ( ) * + , ; =
        • : @
        • / ?

        All other chars will be escaped by converting them to the sequence of bytes that represents them in the specified encoding and then representing each byte in %HH syntax, being HH the hexadecimal representation of the byte.

        This method is thread-safe.

        Parameters:
        text - the String to be escaped.
        encoding - the encoding to be used for escaping.
        Returns:
        The escaped result String. As a memory-performance improvement, will return the exact same object as the text input argument if no escaping modifications were required (and no additional String objects will be created during processing). Will return null if text is null.

      • unescapeFragmentId

        public  unescapeFragmentId​( text,
                                  encoding)

        Perform am URI fragment identifier unescape operation on a String input.

        This method simply calls the equivalent method in the UriEscape class from the library.

        This method will unescape every percent-encoded (%HH) sequences present in input, even for those characters that do not need to be percent-encoded in this context (unreserved characters can be percent-encoded even if/when this is not required, though it is not generally considered a good practice).

        This method will use specified encoding in order to determine the characters specified in the percent-encoded byte sequences.

        This method is thread-safe.

        Parameters:
        text - the String to be unescaped.
        encoding - the encoding to be used for unescaping.
        Returns:
        The unescaped result String. As a memory-performance improvement, will return the exact same object as the text input argument if no unescaping modifications were required (and no additional String objects will be created during processing). Will return null if text is null.

      • escapeQueryParam

        public  escapeQueryParam​( text)

        Perform am URI query parameter (name or value) escape operation on a String input using UTF-8 as encoding.

        This method simply calls the equivalent method in the UriEscape class from the library.

        The following are the only allowed chars in an URI query parameter (will not be escaped):

        • A-Z a-z 0-9
        • - . _ ~
        • ! $ ' ( ) * , ;
        • : @
        • / ?

        All other chars will be escaped by converting them to the sequence of bytes that represents them in the UTF-8 and then representing each byte in %HH syntax, being HH the hexadecimal representation of the byte.

        This method is thread-safe.

        Parameters:
        text - the String to be escaped.
        Returns:
        The escaped result String. As a memory-performance improvement, will return the exact same object as the text input argument if no escaping modifications were required (and no additional String objects will be created during processing). Will return null if text is null.

      • unescapeQueryParam

        public  unescapeQueryParam​( text)

        Perform am URI query parameter (name or value) unescape operation on a String input using UTF-8 as encoding.

        This method simply calls the equivalent method in the UriEscape class from the library.

        This method will unescape every percent-encoded (%HH) sequences present in input, even for those characters that do not need to be percent-encoded in this context (unreserved characters can be percent-encoded even if/when this is not required, though it is not generally considered a good practice).

        This method will use UTF-8 in order to determine the characters specified in the percent-encoded byte sequences.

        This method is thread-safe.

        Parameters:
        text - the String to be unescaped.
        Returns:
        The unescaped result String. As a memory-performance improvement, will return the exact same object as the text input argument if no unescaping modifications were required (and no additional String objects will be created during processing). Will return null if text is null.

      • escapeQueryParam

        public  escapeQueryParam​( text,
                                encoding)

        Perform am URI query parameter (name or value) escape operation on a String input.

        This method simply calls the equivalent method in the UriEscape class from the library.

        The following are the only allowed chars in an URI query parameter (will not be escaped):

        • A-Z a-z 0-9
        • - . _ ~
        • ! $ ' ( ) * , ;
        • : @
        • / ?

        All other chars will be escaped by converting them to the sequence of bytes that represents them in the specified encoding and then representing each byte in %HH syntax, being HH the hexadecimal representation of the byte.

        This method is thread-safe.

        Parameters:
        text - the String to be escaped.
        encoding - the encoding to be used for escaping.
        Returns:
        The escaped result String. As a memory-performance improvement, will return the exact same object as the text input argument if no escaping modifications were required (and no additional String objects will be created during processing). Will return null if text is null.

      • unescapeQueryParam

        public  unescapeQueryParam​( text,
                                  encoding)

        Perform am URI query parameter (name or value) unescape operation on a String input.

        This method simply calls the equivalent method in the UriEscape class from the library.

        This method will unescape every percent-encoded (%HH) sequences present in input, even for those characters that do not need to be percent-encoded in this context (unreserved characters can be percent-encoded even if/when this is not required, though it is not generally considered a good practice).

        This method will use specified encoding in order to determine the characters specified in the percent-encoded byte sequences.

        This method is thread-safe.

        Parameters:
        text - the String to be unescaped.
        encoding - the encoding to be used for unescaping.
        Returns:
        The unescaped result String. As a memory-performance improvement, will return the exact same object as the text input argument if no unescaping modifications were required (and no additional String objects will be created during processing). Will return null if text is null.