org.codehaus.groovy.grails.support.encoding

Class ChainedEncoder

java.lang.Object

org.codehaus.groovy.grails.support.encoding.ChainedEncoder

All Implemented Interfaces:

CodecIdentifierProvider, Encoder, StreamingEncoder

public class ChainedEncoder
extends java.lang.Object
implements Encoder, StreamingEncoder

Constructor Summary

Constructors

Constructor and Description
ChainedEncoder(java.util.List<StreamingEncoder> encoders, boolean safe)
ChainedEncoder(StreamingEncoder[] encoders, boolean safe)

Method Summary

Modifier and Type	Method and Description
protected EncodedAppender	chainEncodersAndCachePerThread(EncodedAppender appender)
protected CombinedCodecIdentifier	createCodecIdentifier(StreamingEncoder[] encoders)
static StreamingEncoder	createFor(java.util.List<StreamingEncoder> encoders)
static StreamingEncoder	createFor(java.util.List<StreamingEncoder> encoders, java.lang.Boolean safe)
static StreamingEncoder	createFor(StreamingEncoder[] encoders)
protected EncodedAppender	doChainEncoders(EncodedAppender appender)
java.lang.Object	encode(java.lang.Object o) Encode given input object
void	encodeToStream(Encoder thisInstance, java.lang.CharSequence source, int offset, int len, EncodedAppender appender, EncodingState encodingState) Encode and append portion of source CharSequence to the appender.
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

Constructor Detail

ChainedEncoder

public ChainedEncoder(java.util.List<StreamingEncoder> encoders,
                      boolean safe)

ChainedEncoder

public ChainedEncoder(StreamingEncoder[] encoders,
                      boolean safe)

Method Detail

createFor

public static StreamingEncoder createFor(StreamingEncoder[] encoders)

createFor

public static StreamingEncoder createFor(java.util.List<StreamingEncoder> encoders)

createFor

public static StreamingEncoder createFor(java.util.List<StreamingEncoder> encoders,
                                         java.lang.Boolean safe)

createCodecIdentifier

protected CombinedCodecIdentifier createCodecIdentifier(StreamingEncoder[] encoders)

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

encodeToStream

public void encodeToStream(Encoder thisInstance,
                           java.lang.CharSequence source,
                           int offset,
                           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

source - The source CharSequence

offset - 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.

chainEncodersAndCachePerThread

protected EncodedAppender chainEncodersAndCachePerThread(EncodedAppender appender)

doChainEncoders

protected EncodedAppender doChainEncoders(EncodedAppender appender)

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

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

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