org.codehaus.groovy.grails.plugins.codecs

Class AbstractCharReplacementEncoder

java.lang.Object

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

All Implemented Interfaces:

CodecIdentifierProvider, Encoder, EncodesToWriter, StreamingEncoder

Direct Known Subclasses:

BasicJSONEncoder, BasicXMLEncoder, HTML4Encoder, JavaScriptEncoder

public abstract class AbstractCharReplacementEncoder
extends java.lang.Object
implements Encoder, StreamingEncoder, EncodesToWriter

Abstract base class for implementing encoders that do character replacements Implements the StreamingEncoder interface that enables efficient streaming encoding

Since:

2.3

Field Summary

Fields

Modifier and Type	Field and Description
protected CodecIdentifier	codecIdentifier

Constructor Summary

Constructors

Constructor and Description
AbstractCharReplacementEncoder(CodecIdentifier codecIdentifier)

Method Summary

Modifier and Type	Method and Description
protected java.lang.String	convertToString(java.lang.Object o)
EncodesToWriter	createChainingEncodesToWriter(java.util.List<StreamingEncoder> encoders, boolean applyAdditionalFirst)
protected java.lang.Object	doCharReplacementEncoding(java.lang.Object o)
java.lang.Object	encode(java.lang.Object o) Encode given input object
void	encodeToStream(Encoder thisInstance, java.lang.CharSequence str, int off, int len, EncodedAppender appender, EncodingState encodingState) Encode and append portion of source CharSequence to the appender.
void	encodeToWriter(char[] buf, int off, int len, java.io.Writer writer, EncodingState encodingState)
void	encodeToWriter(java.lang.CharSequence str, int off, int len, java.io.Writer writer, EncodingState encodingState)
protected abstract java.lang.String	escapeCharacter(char ch, char previousChar) Escape the character, return null if no replacement has to be made
protected java.lang.Object	escapeCharSequence(java.lang.CharSequence str)
CodecIdentifier	getCodecIdentifier() Gets the codec identifier information.
boolean	isApplyToSafelyEncoded()
boolean	isSafe() Checks if this encoder is XSS "safe".
void	markEncoded(java.lang.CharSequence string) Mark this instance as encoded with this encoder in the current EncodingStateRegistry

Methods inherited from class java.lang.Object

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

Field Detail

codecIdentifier

protected CodecIdentifier codecIdentifier

Constructor Detail

AbstractCharReplacementEncoder

public AbstractCharReplacementEncoder(CodecIdentifier codecIdentifier)

Method Detail

escapeCharacter

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

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

Parameters:

ch - the character to escape

previousChar - the previous char

Returns:

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

encode

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

Description copied from interface: Encoder

Encode given input object

Specified by:

encode in interface Encoder

Parameters:

o - the input object

Returns:

the encoded object

doCharReplacementEncoding

protected final java.lang.Object doCharReplacementEncoding(java.lang.Object o)

convertToString

protected java.lang.String convertToString(java.lang.Object o)

escapeCharSequence

protected java.lang.Object escapeCharSequence(java.lang.CharSequence str)

encodeToWriter

public void encodeToWriter(java.lang.CharSequence str,
                           int off,
                           int len,
                           java.io.Writer writer,
                           EncodingState encodingState)
                    throws java.io.IOException

Specified by:

encodeToWriter in interface EncodesToWriter

Throws:

java.io.IOException

encodeToWriter

public void encodeToWriter(char[] buf,
                           int off,
                           int len,
                           java.io.Writer writer,
                           EncodingState encodingState)
                    throws java.io.IOException

Specified by:

encodeToWriter in interface EncodesToWriter

Throws:

java.io.IOException

createChainingEncodesToWriter

public EncodesToWriter createChainingEncodesToWriter(java.util.List<StreamingEncoder> encoders,
                                                     boolean applyAdditionalFirst)

Specified by:

createChainingEncodesToWriter in interface EncodesToWriter

encodeToStream

public void encodeToStream(Encoder thisInstance,
                           java.lang.CharSequence str,
                           int off,
                           int len,
                           EncodedAppender appender,
                           EncodingState encodingState)
                    throws java.io.IOException

Description copied from interface: StreamingEncoder

Encode and append portion of source CharSequence to the appender.

Specified by:

encodeToStream in interface StreamingEncoder

str - The source CharSequence

off - Offset from which to start encoding characters

len - Number of characters to encode

appender - the appender to write to

encodingState - the current encoding state

Throws:

java.io.IOException - Signals that an I/O exception has occurred.

markEncoded

public void markEncoded(java.lang.CharSequence string)

Description copied from interface: Encoder

Mark this instance as encoded with this encoder in the current EncodingStateRegistry

Specified by:

markEncoded in interface Encoder

Parameters:

string - a CharSequence to mark as encoded

isSafe

public boolean isSafe()

Description copied from interface: Encoder

Checks if this encoder is XSS "safe". This means that after appling this encoder, the characters have been escaped and are XSS safe to be included in HTML documents.

Specified by:

isSafe in interface Encoder

Returns:

true, if is safe

isApplyToSafelyEncoded

public boolean isApplyToSafelyEncoded()

Specified by:

isApplyToSafelyEncoded in interface Encoder

Returns:

true if this this codec should be applied to a buffer part that is already encoded with a safe encoder

getCodecIdentifier

public CodecIdentifier getCodecIdentifier()

Description copied from interface: CodecIdentifierProvider

Gets the codec identifier information.

Specified by:

getCodecIdentifier in interface CodecIdentifierProvider

Returns:

the codec identifier information