org.codehaus.groovy.grails.plugins.codecs

Class AbstractCharReplacementEncoder

java.lang.Object

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

All Implemented Interfaces:

org.codehaus.groovy.grails.support.encoding.CodecIdentifierProvider, org.codehaus.groovy.grails.support.encoding.Encoder, org.codehaus.groovy.grails.support.encoding.StreamingEncoder, org.codehaus.groovy.grails.support.encoding.StreamingStatelessEncoder

Direct Known Subclasses:

HTML4Encoder, JavaScriptEncoder, XMLEncoder

public abstract class AbstractCharReplacementEncoder
extends java.lang.Object
implements org.codehaus.groovy.grails.support.encoding.Encoder, org.codehaus.groovy.grails.support.encoding.StreamingEncoder, org.codehaus.groovy.grails.support.encoding.StreamingStatelessEncoder

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 org.codehaus.groovy.grails.support.encoding.CodecIdentifier	codecIdentifier

Constructor Summary

Constructors

Constructor and Description
AbstractCharReplacementEncoder(org.codehaus.groovy.grails.support.encoding.CodecIdentifier codecIdentifier)

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.Object	encode(java.lang.Object o)
void	encodeToStream(org.codehaus.groovy.grails.support.encoding.Encoder thisInstance, java.lang.CharSequence str, int off, int len, org.codehaus.groovy.grails.support.encoding.EncodedAppender appender, org.codehaus.groovy.grails.support.encoding.EncodingState encodingState)
void	encodeToWriter(java.lang.CharSequence str, java.io.Writer writer)
protected abstract java.lang.String	escapeCharacter(char ch, char previousChar) Escape the character, return null if no replacement has to be made
org.codehaus.groovy.grails.support.encoding.CodecIdentifier	getCodecIdentifier()
boolean	isApplyToSafelyEncoded()
boolean	isSafe()
void	markEncoded(java.lang.CharSequence string)

Methods inherited from class java.lang.Object

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

Field Detail

codecIdentifier

protected org.codehaus.groovy.grails.support.encoding.CodecIdentifier codecIdentifier

Constructor Detail

AbstractCharReplacementEncoder

public AbstractCharReplacementEncoder(org.codehaus.groovy.grails.support.encoding.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)

Specified by:

encode in interface org.codehaus.groovy.grails.support.encoding.Encoder

encodeToWriter

public void encodeToWriter(java.lang.CharSequence str,
                  java.io.Writer writer)
                    throws java.io.IOException

Specified by:

encodeToWriter in interface org.codehaus.groovy.grails.support.encoding.StreamingStatelessEncoder

Throws:

java.io.IOException

encodeToStream

public void encodeToStream(org.codehaus.groovy.grails.support.encoding.Encoder thisInstance,
                  java.lang.CharSequence str,
                  int off,
                  int len,
                  org.codehaus.groovy.grails.support.encoding.EncodedAppender appender,
                  org.codehaus.groovy.grails.support.encoding.EncodingState encodingState)
                    throws java.io.IOException

Specified by:

encodeToStream in interface org.codehaus.groovy.grails.support.encoding.StreamingEncoder

Throws:

java.io.IOException

markEncoded

public void markEncoded(java.lang.CharSequence string)

Specified by:

markEncoded in interface org.codehaus.groovy.grails.support.encoding.Encoder

isSafe

public boolean isSafe()

Specified by:

isSafe in interface org.codehaus.groovy.grails.support.encoding.Encoder

isApplyToSafelyEncoded

public boolean isApplyToSafelyEncoded()

Specified by:

isApplyToSafelyEncoded in interface org.codehaus.groovy.grails.support.encoding.Encoder

getCodecIdentifier

public org.codehaus.groovy.grails.support.encoding.CodecIdentifier getCodecIdentifier()

Specified by:

getCodecIdentifier in interface org.codehaus.groovy.grails.support.encoding.CodecIdentifierProvider