Package org.eclipse.jetty.io

Class WriteThroughWriter

java.lang.Object

java.io.Writer

org.eclipse.jetty.io.WriteThroughWriter

All Implemented Interfaces:

Closeable, Flushable, Appendable, AutoCloseable

public abstract class WriteThroughWriter
extends Writer

An alternate to OutputStreamWriter that supports several optimized implementation for well known Charsets, specifically StandardCharsets.UTF_8 and StandardCharsets.ISO_8859_1.

The implementations of this class will never buffer characters or bytes beyond a call to the write(char[], int, int) method, thus written characters will always be passed as bytes to the passed OutputStream

.

Field Summary

Fields inherited from class java.io.Writer

lock

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	WriteThroughWriter(OutputStream out)
protected	WriteThroughWriter(OutputStream out, int maxWriteSize)	Construct an OutputStreamWriter

Method Summary

Modifier and Type	Method	Description
abstract WriteThroughWriter	append(CharSequence sequence)
void	close()
void	flush()
int	getMaxWriteSize()
static WriteThroughWriter	newWriter(OutputStream outputStream, String charset)	Obtain a new Writer that converts characters written to bytes written to an OutputStream.
static WriteThroughWriter	newWriter(OutputStream outputStream, Charset charset)	Obtain a new Writer that converts characters written to bytes written to an OutputStream.
void	write(char[] chars, int offset, int length)
void	write(String string, int offset, int length)

Methods inherited from class java.io.Writer

append, append, nullWriter, write, write, write

Methods inherited from class java.lang.Object

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

Constructor Details

WriteThroughWriter

protected WriteThroughWriter(OutputStream out)

WriteThroughWriter

protected WriteThroughWriter(OutputStream out,
 int maxWriteSize)

Construct an OutputStreamWriter

Parameters:

out - The OutputStream to write the converted bytes to.

maxWriteSize - The maximum size in characters of a single conversion

Method Details

newWriter

public static WriteThroughWriter newWriter(OutputStream outputStream,
 String charset)
                                    throws IOException

Obtain a new Writer that converts characters written to bytes written to an OutputStream.

Parameters:

outputStream - The OutputStream to write to/

charset - The Charset name.

Returns:

A Writer that will

Throws:

IOException - If there is a problem creating the Writer.

newWriter

public static WriteThroughWriter newWriter(OutputStream outputStream,
 Charset charset)
                                    throws IOException

Obtain a new Writer that converts characters written to bytes written to an OutputStream.

Parameters:

outputStream - The OutputStream to write to/

charset - The Charset.

Returns:

A Writer that will

Throws:

IOException - If there is a problem creating the Writer.

getMaxWriteSize

public int getMaxWriteSize()

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

flush

public void flush()
           throws IOException

Specified by:

flush in interface Flushable

Specified by:

flush in class Writer

Throws:

IOException

append

public abstract WriteThroughWriter append(CharSequence sequence)
                                   throws IOException

Specified by:

append in interface Appendable

Overrides:

append in class Writer

Throws:

IOException

write

public void write(String string,
 int offset,
 int length)
           throws IOException

Overrides:

write in class Writer

Throws:

IOException

write

public void write(char[] chars,
 int offset,
 int length)
           throws IOException

Specified by:

write in class Writer

Throws:

IOException