com.atlassian.confluence.util
Class HtmlUtil

java.lang.Object
  extended by com.atlassian.confluence.util.HtmlUtil

public final class HtmlUtil
extends java.lang.Object


Field Summary
static com.google.common.base.Function<java.lang.String,java.lang.String> HTML_ENCODE_FUNCTION
          Function to apply htmlEncode(String).
 
Constructor Summary
HtmlUtil()
           
 
Method Summary
static java.lang.String completeUrlEncode(java.lang.String url)
          Encodes the given url for protocols which the CompleteURLEncoder supports.
static java.lang.String htmlEncode(java.lang.String text)
          Encodes the given text to be HTML safe using entity escapes.
static java.lang.String htmlEncodeAndReplaceSpaces(java.lang.String text)
          Encodes the given text to be HTML safe using entity escapes, and embedding non-breaking spaces in place of spaces.
static java.lang.String reencodeURL(java.lang.String originalUrl)
          Attempts to handle common encoding errors in hand-edited URLs, such as failing to URL encode quotes.
static boolean shouldUrlDecode(java.lang.String text)
          Checks if the given text should contains any percent encoded characters that should be decoded.
static java.lang.String urlDecode(java.lang.String url)
          Decodes URL percent encoded characters, using the character encoding as per GeneralUtil.getCharacterEncoding().
static java.lang.String urlDecode(java.lang.String url, java.lang.String encoding)
          Decodes URL percent encoded characters.
static java.lang.String urlEncode(java.lang.String text)
          Encodes HTTP form parameter/values, using the character encoding as per GeneralUtil.getCharacterEncoding().
static java.lang.String urlEncode(java.lang.String text, java.lang.String encoding)
          Encodes HTTP form parameter/values.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

HTML_ENCODE_FUNCTION

public static final com.google.common.base.Function<java.lang.String,java.lang.String> HTML_ENCODE_FUNCTION
Function to apply htmlEncode(String).

Constructor Detail

HtmlUtil

public HtmlUtil()
Method Detail

htmlEncode

public static java.lang.String htmlEncode(java.lang.String text)
Encodes the given text to be HTML safe using entity escapes.

Parameters:
text - the text to encode.
Returns:
the encoded text.

htmlEncodeAndReplaceSpaces

public static java.lang.String htmlEncodeAndReplaceSpaces(java.lang.String text)
Encodes the given text to be HTML safe using entity escapes, and embedding non-breaking spaces in place of spaces.

Parameters:
text - the text to encode.
Returns:
the encoded text.

completeUrlEncode

public static java.lang.String completeUrlEncode(java.lang.String url)
Encodes the given url for protocols which the CompleteURLEncoder supports. To only encode HTTP form parameter/values or fragments, use urlEncode(String) instead. Uses the character encoding as per GeneralUtil.getCharacterEncoding().

Parameters:
url - the entire URL to encode
Returns:
encoded url
Since:
5.3.3

urlEncode

public static java.lang.String urlEncode(java.lang.String text)
Encodes HTTP form parameter/values, using the character encoding as per GeneralUtil.getCharacterEncoding(). To encode entire URLs, use completeUrlEncode(java.lang.String) instead.

Parameters:
text - part of the url to encode
Returns:
encoded url
Since:
5.3.3

urlEncode

public static java.lang.String urlEncode(java.lang.String text,
                                         java.lang.String encoding)
Encodes HTTP form parameter/values. To encode entire URLs, use completeUrlEncode(java.lang.String) instead.

Parameters:
text - part of the url to encode
encoding - the character encoding to use
Returns:
encoded url
Since:
5.3.3

urlDecode

public static java.lang.String urlDecode(java.lang.String url)
Decodes URL percent encoded characters, using the character encoding as per GeneralUtil.getCharacterEncoding().

Parameters:
url - the URL to decode
Returns:
the decoded string

urlDecode

public static java.lang.String urlDecode(java.lang.String url,
                                         java.lang.String encoding)
                                  throws java.io.UnsupportedEncodingException
Decodes URL percent encoded characters.

Parameters:
url - the URL to decode
encoding - the character encoding to use while decoding
Returns:
the decoded string
Throws:
java.io.UnsupportedEncodingException

shouldUrlDecode

public static boolean shouldUrlDecode(java.lang.String text)
Checks if the given text should contains any percent encoded characters that should be decoded.

Parameters:
text - the text to check
Returns:
true, if the text should be decoded

reencodeURL

public static java.lang.String reencodeURL(java.lang.String originalUrl)
Attempts to handle common encoding errors in hand-edited URLs, such as failing to URL encode quotes.

Parameters:
originalUrl - the url to re-encode.
Returns:
the re-encoded URL, or the original value if it cannot be


Copyright © 2003-2014 Atlassian. All Rights Reserved.