jodd.servlet
Class HtmlEncode

java.lang.Object
  jodd.servlet.HtmlEncode

Direct Known Subclasses:

E

public class HtmlEncode
extends java.lang.Object

Encodes text and URL strings in various ways resulting HTML-safe text. All methods are null safe.

Nested Class Summary

static class

HtmlEncode.UrlBuilder

Field Summary

protected static char[][]	BLOCK
protected static char[][]	TEXT
protected static char[][]	URL

Constructor Summary

HtmlEncode()

Method Summary

static HtmlEncode.UrlBuilder	baseUrl(java.lang.String url)
static HtmlEncode.UrlBuilder	baseUrl(java.lang.String url, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
static HtmlEncode.UrlBuilder	baseUrl(java.lang.String url, javax.servlet.jsp.PageContext pageContext)
static HtmlEncode.UrlBuilder	baseUrl(java.lang.String url, java.lang.String encoding)
static HtmlEncode.UrlBuilder	baseUrl(java.lang.String url, java.lang.String encoding, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
static HtmlEncode.UrlBuilder	baseUrl(java.lang.String url, java.lang.String encoding, javax.servlet.jsp.PageContext pageContext)
static java.lang.String	block(java.lang.Object object)
static java.lang.String	block(java.lang.String text) Encodes text into HTML-safe block preserving paragraphs.
static java.lang.String	strict(java.lang.Object object)
static java.lang.String	strict(java.lang.String text) Encodes text int HTML-safe block and preserves format using smart spaces.
static java.lang.String	text(java.lang.Object object)
static java.lang.String	text(java.lang.String text) Encodes a string to HTML-safe text.
static java.lang.String	url(java.lang.String url)
static java.lang.String	url(java.lang.String value, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
static java.lang.String	url(java.lang.String value, javax.servlet.jsp.PageContext pageContext)
static java.lang.String	url(java.lang.String url, java.lang.String encoding) Faster smart url encoding.
static java.lang.String	url(java.lang.String value, java.lang.String encoding, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
static java.lang.String	url(java.lang.String value, java.lang.String encoding, javax.servlet.jsp.PageContext pageContext)

Methods inherited from class java.lang.Object

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

Field Detail

TEXT

protected static final char[][] TEXT

BLOCK

protected static final char[][] BLOCK

URL

protected static final char[][] URL

Constructor Detail

HtmlEncode

public HtmlEncode()

Method Detail

text

public static java.lang.String text(java.lang.Object object)

text

public static java.lang.String text(java.lang.String text)

Encodes a string to HTML-safe text. The following characters are replaced:

• ' with ' (' doesn't work)
• " with "
• & with &
• < with &lt;
• > with &gt;

See Also:

block(String)

block

public static java.lang.String block(java.lang.Object object)

block

public static java.lang.String block(java.lang.String text)

Encodes text into HTML-safe block preserving paragraphs. Besides the default special characters the following are replaced, too:

• \n with <br>
• \r with <br>

Method accepts any of CR, LF, or CR+LF as a line terminator.

strict

public static java.lang.String strict(java.lang.Object object)

strict

public static java.lang.String strict(java.lang.String text)

Encodes text int HTML-safe block and preserves format using smart spaces. Additionally to block(String), the following characters are replaced:

• \n with <br>
• \r with <br>

This method preserves the format as much as possible, using the combination of not-breakable and common spaces.

url

public static java.lang.String url(java.lang.String value,
                                   javax.servlet.jsp.PageContext pageContext)

url

public static java.lang.String url(java.lang.String value,
                                   java.lang.String encoding,
                                   javax.servlet.jsp.PageContext pageContext)

url

public static java.lang.String url(java.lang.String value,
                                   javax.servlet.http.HttpServletRequest request,
                                   javax.servlet.http.HttpServletResponse response)

url

public static java.lang.String url(java.lang.String value,
                                   java.lang.String encoding,
                                   javax.servlet.http.HttpServletRequest request,
                                   javax.servlet.http.HttpServletResponse response)

url

public static java.lang.String url(java.lang.String url)

url

public static java.lang.String url(java.lang.String url,
                                   java.lang.String encoding)

Faster smart url encoding. Url is parsed after the '?' sign. Both parameter name and values are parsed. This method is not 100% correct: it can't make a difference between '&' char in parameter value and '&' used as a delimiter.

baseUrl

public static HtmlEncode.UrlBuilder baseUrl(java.lang.String url)

baseUrl

public static HtmlEncode.UrlBuilder baseUrl(java.lang.String url,
                                            java.lang.String encoding)

baseUrl

public static HtmlEncode.UrlBuilder baseUrl(java.lang.String url,
                                            javax.servlet.jsp.PageContext pageContext)

baseUrl

public static HtmlEncode.UrlBuilder baseUrl(java.lang.String url,
                                            java.lang.String encoding,
                                            javax.servlet.jsp.PageContext pageContext)

baseUrl

public static HtmlEncode.UrlBuilder baseUrl(java.lang.String url,
                                            javax.servlet.http.HttpServletRequest request,
                                            javax.servlet.http.HttpServletResponse response)

baseUrl

public static HtmlEncode.UrlBuilder baseUrl(java.lang.String url,
                                            java.lang.String encoding,
                                            javax.servlet.http.HttpServletRequest request,
                                            javax.servlet.http.HttpServletResponse response)