Package org.grails.encoder

Class EncodedAppenderWriter

java.lang.Object

java.io.Writer

org.grails.encoder.EncodedAppenderWriter

All Implemented Interfaces:

Closeable, Flushable, Appendable, AutoCloseable, EncodedAppenderFactory, EncodedAppenderWriterFactory, EncoderAware

public class EncodedAppenderWriter
extends Writer
implements EncodedAppenderWriterFactory, EncodedAppenderFactory, EncoderAware

A java.io.Writer implementation that writes to a EncodedAppender with a certain encoder This class isn't thread-safe.

Since:

2.3

Field Summary

Fields

Modifier and Type	Field	Description
protected final EncodedAppender	encodedAppender
protected final Encoder	encoder
protected final EncodingStateRegistry	encodingStateRegistry

Fields inherited from class java.io.Writer

lock

Constructor Summary

Constructors

Constructor	Description
EncodedAppenderWriter(EncodedAppender encodedAppender, Encoder encoder, EncodingStateRegistry encodingStateRegistry)	Default constructor

Method Summary

Modifier and Type	Method	Description
Writer	append(char c)
Writer	append(CharSequence csq)
Writer	append(CharSequence csq, int start, int end)
void	close()
void	flush()
EncodedAppender	getEncodedAppender()	Gets the EncodedAppender that is connected to the instance of this implementation.
Encoder	getEncoder()	Gets the current encoder in use.
Writer	getWriterForEncoder(Encoder encoder, EncodingStateRegistry encodingStateRegistry)	Gets the EncodedAppenderWriter instance that is connected to this instance implementation with a certain encoder fixed.
void	write(char[] cbuf, int off, int len)
void	write(int c)
void	write(String str, int off, int len)

Methods inherited from class java.io.Writer

nullWriter, write, write

Methods inherited from class java.lang.Object

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

Field Details

encodedAppender

protected final EncodedAppender encodedAppender

encoder

protected final Encoder encoder

encodingStateRegistry

protected final EncodingStateRegistry encodingStateRegistry

Constructor Details

EncodedAppenderWriter

public EncodedAppenderWriter(EncodedAppender encodedAppender,
 Encoder encoder,
 EncodingStateRegistry encodingStateRegistry)

Default constructor

Parameters:

encodedAppender - the EncodedAppender destination

encoder - the encoder to use

encodingStateRegistry - the EncodingStateRegistry to use to lookup encoding state of CharSequence instances

Method Details

write

public void write(char[] cbuf,
 int off,
 int len)
           throws IOException

Specified by:

write in class Writer

Throws:

IOException

flush

public void flush()
           throws IOException

Specified by:

flush in interface Flushable

Specified by:

flush in class Writer

Throws:

IOException

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Specified by:

close in class Writer

Throws:

IOException

write

public void write(int c)
           throws IOException

Overrides:

write in class Writer

Throws:

IOException

write

public void write(String str,
 int off,
 int len)
           throws IOException

Overrides:

write in class Writer

Throws:

IOException

append

public Writer append(CharSequence csq)
              throws IOException

Specified by:

append in interface Appendable

Overrides:

append in class Writer

Throws:

IOException

append

public Writer append(CharSequence csq,
 int start,
 int end)
              throws IOException

Specified by:

append in interface Appendable

Overrides:

append in class Writer

Throws:

IOException

append

public Writer append(char c)
              throws IOException

Specified by:

append in interface Appendable

Overrides:

append in class Writer

Throws:

IOException

getEncodedAppender

public EncodedAppender getEncodedAppender()

Description copied from interface: EncodedAppenderFactory

Gets the EncodedAppender that is connected to the instance of this implementation.

Specified by:

getEncodedAppender in interface EncodedAppenderFactory

Returns:

the EncodedAppender

getEncoder

public Encoder getEncoder()

Description copied from interface: EncoderAware

Gets the current encoder in use.

Specified by:

getEncoder in interface EncoderAware

Returns:

the encoder

getWriterForEncoder

public Writer getWriterForEncoder(Encoder encoder,
 EncodingStateRegistry encodingStateRegistry)

Description copied from interface: EncodedAppenderWriterFactory

Gets the EncodedAppenderWriter instance that is connected to this instance implementation with a certain encoder fixed.

Specified by:

getWriterForEncoder in interface EncodedAppenderWriterFactory

Parameters:

encoder - the encoder to use

encodingStateRegistry - the current EncodingStateRegistry to use

Returns:

the java.io.Writer instance