org.codehaus.groovy.grails.plugins.codecs

Class XMLEncoder

java.lang.Object

org.codehaus.groovy.grails.plugins.codecs.AbstractCharReplacementEncoder

org.codehaus.groovy.grails.plugins.codecs.XMLEncoder

All Implemented Interfaces:

org.codehaus.groovy.grails.support.encoding.CodecIdentifierProvider, org.codehaus.groovy.grails.support.encoding.Encoder, org.codehaus.groovy.grails.support.encoding.StreamingEncoder, org.codehaus.groovy.grails.support.encoding.StreamingStatelessEncoder

Direct Known Subclasses:

HTMLEncoder

public class XMLEncoder
extends AbstractCharReplacementEncoder

Encoder implementation that escapes some characters for inclusion in XML documents Currently ', ", <, > and & characters are replaced with XML entities. Additionally backslash (/), non-breaking space, backtick (`) and @ are also replaced for visibility/additional security.

Since:

2.3

Field Summary

Fields

Modifier and Type	Field and Description
static org.codehaus.groovy.grails.support.encoding.CodecIdentifier	XML_CODEC_IDENTIFIER

Fields inherited from class org.codehaus.groovy.grails.plugins.codecs.AbstractCharReplacementEncoder

codecIdentifier

Constructor Summary

Constructors

Modifier	Constructor and Description
	XMLEncoder()
protected	XMLEncoder(org.codehaus.groovy.grails.support.encoding.CodecIdentifier codecIdentifier)

Method Summary

Methods

Modifier and Type	Method and Description
protected java.lang.String	escapeCharacter(char ch, char previousChar) Escape the character, return null if no replacement has to be made

Methods inherited from class org.codehaus.groovy.grails.plugins.codecs.AbstractCharReplacementEncoder

encode, encodeToStream, encodeToWriter, getCodecIdentifier, isApplyToSafelyEncoded, isSafe, markEncoded

Methods inherited from class java.lang.Object

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

Field Detail

XML_CODEC_IDENTIFIER

public static final org.codehaus.groovy.grails.support.encoding.CodecIdentifier XML_CODEC_IDENTIFIER

Constructor Detail

XMLEncoder

public XMLEncoder()

XMLEncoder

protected XMLEncoder(org.codehaus.groovy.grails.support.encoding.CodecIdentifier codecIdentifier)

Method Detail

escapeCharacter

protected java.lang.String escapeCharacter(char ch,
                               char previousChar)

Description copied from class: AbstractCharReplacementEncoder

Escape the character, return null if no replacement has to be made

Specified by:

escapeCharacter in class AbstractCharReplacementEncoder

Parameters:

ch - the character to escape

previousChar - the previous char

Returns:

the replacement string, null if no replacement has to be made