org.codehaus.groovy.grails.plugins.codecs

Class JavaScriptEncoder

java.lang.Object

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

org.codehaus.groovy.grails.plugins.codecs.JavaScriptEncoder

All Implemented Interfaces:

CodecIdentifierProvider, Encoder, EncodesToWriter, StreamingEncoder

public class JavaScriptEncoder
extends AbstractCharReplacementEncoder

Used for making strings safe to be included in a SCRIPT tag besides normal Javascript escaping, possibly "unsafe" characters are escaped too so that it's safe to include an escaped string in a HTML SCRIPT tag.

Since:

2.3

Field Summary

Fields

Modifier and Type	Field and Description
static CodecIdentifier	JAVASCRIPT_CODEC_IDENTIFIER

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

codecIdentifier

Constructor Summary

Constructors

Constructor and Description
JavaScriptEncoder()

Method Summary

Modifier and Type	Method and Description
protected java.lang.String	escapeCharacter(char ch, char previousChar) Escape the character, return null if no replacement has to be made
boolean	isApplyToSafelyEncoded()

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

convertToString, createChainingEncodesToWriter, doCharReplacementEncoding, encode, encodeToStream, encodeToWriter, encodeToWriter, escapeCharSequence, getCodecIdentifier, isSafe, markEncoded

Methods inherited from class java.lang.Object

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

Field Detail

JAVASCRIPT_CODEC_IDENTIFIER

public static final CodecIdentifier JAVASCRIPT_CODEC_IDENTIFIER

Constructor Detail

JavaScriptEncoder

public JavaScriptEncoder()

Method Detail

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

isApplyToSafelyEncoded

public boolean isApplyToSafelyEncoded()

Specified by:

isApplyToSafelyEncoded in interface Encoder

Overrides:

isApplyToSafelyEncoded in class AbstractCharReplacementEncoder

Returns:

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