Package org.grails.encoder

Interface StreamingEncoder

All Superinterfaces:

CodecIdentifierProvider, Encoder

All Known Implementing Classes:

AbstractCharReplacementEncoder, BasicJSONEncoder, BasicXMLEncoder, ChainedEncoder, HTML4Encoder, HTMLEncoder, JavaScriptEncoder, NoneEncoder, RawCodec

public interface StreamingEncoder
extends Encoder

Streaming encoder interface that makes it possible to encode a portion of a CharSequence and append it directly to the EncodedAppender instance. This solution makes it possible to just check if the input is ok and only replace the characters in the input that have to be escaped.

Since:

2.3

Method Summary

Modifier and Type	Method	Description
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.

Methods inherited from interface org.grails.encoder.CodecIdentifierProvider

getCodecIdentifier

Methods inherited from interface org.grails.encoder.Encoder

encode, isApplyToSafelyEncoded, isSafe, markEncoded

Method Detail

encodeToStream

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

Encode and append portion of source CharSequence to the appender.

Parameters:

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.