org.codehaus.groovy.grails.plugins.codecs

Class BasicXMLEncoder

java.lang.Object

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

org.codehaus.groovy.grails.plugins.codecs.BasicXMLEncoder

All Implemented Interfaces:

CodecIdentifierProvider, Encoder, EncodesToWriter, StreamingEncoder

Direct Known Subclasses:

HTMLEncoder

public class BasicXMLEncoder
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 CodecIdentifier	XML_CODEC_IDENTIFIER

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

codecIdentifier

Constructor Summary

Constructors

Modifier	Constructor and Description
	BasicXMLEncoder()
protected	BasicXMLEncoder(CodecIdentifier codecIdentifier)

Method Summary

Modifier and Type	Method and Description
protected java.lang.Object	doEncode(java.lang.Object o)
java.lang.Object	encode(java.lang.Object o) Encode given input object
protected java.lang.Object	encodeAsXmlObject(java.lang.Object o)
protected java.lang.String	escapeCharacter(char ch, char previousChar) Escape the character, return null if no replacement has to be made
protected static java.lang.String	xmlEscapeCharacter(char ch)

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

convertToString, createChainingEncodesToWriter, doCharReplacementEncoding, encodeToStream, encodeToWriter, encodeToWriter, escapeCharSequence, 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 CodecIdentifier XML_CODEC_IDENTIFIER

Constructor Detail

BasicXMLEncoder

public BasicXMLEncoder()

BasicXMLEncoder

protected BasicXMLEncoder(CodecIdentifier codecIdentifier)

Method Detail

xmlEscapeCharacter

protected static final java.lang.String xmlEscapeCharacter(char ch)

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

encode

public final java.lang.Object encode(java.lang.Object o)

Description copied from interface: Encoder

Encode given input object

Specified by:

encode in interface Encoder

Overrides:

encode in class AbstractCharReplacementEncoder

Parameters:

o - the input object

Returns:

the encoded object

doEncode

protected java.lang.Object doEncode(java.lang.Object o)

encodeAsXmlObject

protected java.lang.Object encodeAsXmlObject(java.lang.Object o)