Package org.grails.encoder

Interface Encoder

All Superinterfaces:

CodecIdentifierProvider

All Known Subinterfaces:

StreamingEncoder

All Known Implementing Classes:

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

public interface Encoder
extends CodecIdentifierProvider

Interface for encoding methods.

Since:

2.3

Method Summary

Modifier and Type	Method	Description
Object	encode(Object o)	Encode given input object
boolean	isApplyToSafelyEncoded()
boolean	isSafe()	Checks if this encoder is XSS "safe".
void	markEncoded(CharSequence string)	Mark this instance as encoded with this encoder in the current EncodingStateRegistry

Methods inherited from interface org.grails.encoder.CodecIdentifierProvider

getCodecIdentifier

Method Details

encode

Object encode(Object o)

Encode given input object

Parameters:

o - the input object

Returns:

the encoded object

isSafe

boolean isSafe()

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.

Returns:

true, if is safe

isApplyToSafelyEncoded

boolean isApplyToSafelyEncoded()

Returns:

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

markEncoded

void markEncoded(CharSequence string)

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

Parameters:

string - a CharSequence to mark as encoded