org.apache.taglibs.standard.util

Class EscapeXML

java.lang.Object

org.apache.taglibs.standard.util.EscapeXML

public class EscapeXML
extends java.lang.Object

Handles escaping of characters that could be interpreted as XML markup.

The specification for <c:out> defines the following character conversions to be applied:

Character	Character Entity Code
<	&lt;
>	&gt;
&	&amp;
'	&#039;
"	&#034;

Field Summary

Fields

Modifier and Type	Field and Description
private static java.lang.String[]	ESCAPES

Constructor Summary

Constructors

Constructor and Description
EscapeXML()

Method Summary

Modifier and Type	Method and Description
static void	emit(char[] buffer, int from, int count, javax.servlet.jsp.JspWriter out) Emit escaped content into the specified JSPWriter.
static void	emit(java.lang.Object src, boolean escapeXml, javax.servlet.jsp.JspWriter out) Emit the supplied object to the specified writer, escaping characters if needed.
static void	emit(java.io.Reader src, boolean escapeXml, javax.servlet.jsp.JspWriter out) Copy the content of a Reader into the specified JSPWriter escaping characters if needed.
static void	emit(java.lang.String src, boolean escapeXml, javax.servlet.jsp.JspWriter out) Emit the supplied String to the specified writer, escaping characters if needed.
static void	emit(java.lang.String src, javax.servlet.jsp.JspWriter out) Emit escaped content into the specified JSPWriter.
static java.lang.String	escape(java.lang.String src) Escape a string.
private static java.lang.String	getEscape(char c)

Methods inherited from class java.lang.Object

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

Field Detail

ESCAPES

private static final java.lang.String[] ESCAPES

Constructor Detail

EscapeXML

public EscapeXML()

Method Detail

getEscape

private static java.lang.String getEscape(char c)

escape

public static java.lang.String escape(java.lang.String src)

Escape a string.

Parameters:

src - the string to escape; must not be null

Returns:

the escaped string

emit

public static void emit(java.lang.Object src,
                        boolean escapeXml,
                        javax.servlet.jsp.JspWriter out)
                 throws java.io.IOException

Emit the supplied object to the specified writer, escaping characters if needed.

Parameters:

src - the object to write

escapeXml - if true, escape unsafe characters before writing

out - the JspWriter to emit to

Throws:

java.io.IOException - if there was a problem emitting the content

emit

public static void emit(java.lang.String src,
                        boolean escapeXml,
                        javax.servlet.jsp.JspWriter out)
                 throws java.io.IOException

Emit the supplied String to the specified writer, escaping characters if needed.

Parameters:

src - the String to write

escapeXml - if true, escape unsafe characters before writing

out - the JspWriter to emit to

Throws:

java.io.IOException - if there was a problem emitting the content

emit

public static void emit(java.lang.String src,
                        javax.servlet.jsp.JspWriter out)
                 throws java.io.IOException

Emit escaped content into the specified JSPWriter.

Parameters:

src - the string to escape; must not be null

out - the JspWriter to emit to

Throws:

java.io.IOException - if there was a problem emitting the content

emit

public static void emit(java.io.Reader src,
                        boolean escapeXml,
                        javax.servlet.jsp.JspWriter out)
                 throws java.io.IOException

Copy the content of a Reader into the specified JSPWriter escaping characters if needed.

Parameters:

src - the Reader to read from

escapeXml - if true, escape characters

out - the JspWriter to emit to

Throws:

java.io.IOException - if there was a problem emitting the content

emit

public static void emit(char[] buffer,
                        int from,
                        int count,
                        javax.servlet.jsp.JspWriter out)
                 throws java.io.IOException

Emit escaped content into the specified JSPWriter.

Parameters:

buffer - characters to escape

from - start position in the buffer

count - number of characters to emit

out - the JspWriter to emit to

Throws:

java.io.IOException - if there was a problem emitting the content