Modifier and Type	Class and Description
private static class	WriteThroughWriter.EncodingWriter An implementation of `WriteThroughWriter` that internally uses `java.io.OutputStreamWriter`.
private static class	WriteThroughWriter.Iso88591Writer An implementation of `WriteThroughWriter` for optimal ISO-8859-1 conversion.
private static class	WriteThroughWriter.Utf8Writer An implementation of `WriteThroughWriter` for an optimal UTF-8 conversion.

Modifier and Type	Field and Description
pack-priv final ByteArrayOutputStream2	_bytes
private final int	_maxWriteSize
pack-priv final OutputStream	_out
pack-priv static final int	DEFAULT_MAX_WRITE_SIZE

Access	Constructor and Description
protected	WriteThroughWriter(OutputStream out)
protected	WriteThroughWriter(OutputStream The `OutputStream` to write the converted bytes to. out, int The maximum size in characters of a single conversion maxWriteSize) Construct an `java.io.OutputStreamWriter`

Method Summary

Modifier and Type	Method and Description
public abstract WriteThroughWriter	append(CharSequence The character sequence to append. If `csq` is `null`, then the four characters `"null"` are appended to this writer. sequence) Redeclares java.lang.Appendable.append. Overrides java.io.Writer.append. Appends the specified character sequence to this writer.
public void	close() Implements abstract java.io.Writer.close. Implements java.io.Closeable.close. Closes the stream, flushing it first.
public void	flush() Implements abstract java.io.Writer.flush. Implements java.io.Flushable.flush. Flushes the stream.
public int	getMaxWriteSize()
public static WriteThroughWriter	Returns: A Writer that will newWriter(OutputStream The `OutputStream` to write to/ outputStream, String The `Charset` name. charset) Obtain a new `Writer` that converts characters written to bytes written to an `OutputStream`.
public static WriteThroughWriter	Returns: A Writer that will newWriter(OutputStream The `OutputStream` to write to/ outputStream, Charset The `Charset`. charset) Obtain a new `Writer` that converts characters written to bytes written to an `OutputStream`.
pack-priv static CharSequence	Returns: A new `CharSequence` containing the subsequence, backed by the passed `String` or the original `String` if it is the same. subSequence(String The `String` to take a subsequence of. string, int The offset in characters into the string to start the subsequence offset, int The length in characters of the substring length) Get a zero copy subsequence of a `String`.
pack-priv static CharSequence	Returns: A new `CharSequence` containing the subsequence. subSequence(char[] The characters to take a subsequence of. These character are not copied and the array should not be modified for the life of the returned CharSequence. chars, int The offset in characters into the string to start the subsequence offset, int The length in characters of the substring length) Get a zero copy subsequence of a `char` array.
public void	write(String A String string, int Offset from which to start writing characters offset, int Number of characters to write length) Overrides java.io.Writer.write. Writes a portion of a string.
public void	write(char[] Array of characters chars, int Offset from which to start writing characters offset, int Number of characters to write length) Implements abstract java.io.Writer.write. Writes a portion of an array of characters.

Inherited from java.io.Writer:: append append nullWriter write write write

Field Detail

_bytes	back to summary
pack-priv final ByteArrayOutputStream2 _bytes

_maxWriteSize	back to summary
private final int _maxWriteSize

_out	back to summary
pack-priv final OutputStream _out

DEFAULT_MAX_WRITE_SIZE	back to summary
pack-priv static final int DEFAULT_MAX_WRITE_SIZE

Constructor Detail

WriteThroughWriter	back to summary
protected WriteThroughWriter(OutputStream out)

WriteThroughWriter back to summary

WriteThroughWriter	back to summary
protected WriteThroughWriter(OutputStream out, int maxWriteSize) Construct an `java.io.OutputStreamWriter` Parameters out:OutputStream The `OutputStream` to write the converted bytes to. maxWriteSize:int The maximum size in characters of a single conversion

protected WriteThroughWriter(OutputStream out, int maxWriteSize)

Construct an java.io.OutputStreamWriter

Parameters

out:OutputStream: The OutputStream to write the converted bytes to.
maxWriteSize:int: The maximum size in characters of a single conversion

Method Detail

append back to summary

append	back to summary
public abstract WriteThroughWriter append(CharSequence sequence) throws IOException Redeclares java.lang.Appendable.append. Overrides java.io.Writer.append. Doc from java.io.Writer.append. Appends the specified character sequence to this writer. An invocation of this method of the form `out.append(csq)` behaves in exactly the same way as the invocation `out.write(csq.toString())` out.write(csq.toString()) Depending on the specification of `toString` for the character sequence `csq`, the entire sequence may not be appended. For instance, invoking the `toString` method of a character buffer will return a subsequence whose content depends upon the buffer's position and limit. Parameters sequence:CharSequence The character sequence to append. If `csq` is `null`, then the four characters `"null"` are appended to this writer. Returns:WriteThroughWriter This writer Annotations @Override Exceptions IOException: If an I/O error occurs

public abstract WriteThroughWriter append(CharSequence sequence) throws IOException

Redeclares java.lang.Appendable.append.

Overrides java.io.Writer.append.

Doc from java.io.Writer.append.

Appends the specified character sequence to this writer.

An invocation of this method of the form out.append(csq) behaves in exactly the same way as the invocation

out.write(csq.toString())

Depending on the specification of toString for the character sequence csq, the entire sequence may not be appended. For instance, invoking the toString method of a character buffer will return a subsequence whose content depends upon the buffer's position and limit.

Parameters

sequence:CharSequence: The character sequence to append. If csq is null, then the four characters "null" are appended to this writer.

Returns:WriteThroughWriter

This writer

Annotations

@Override

Exceptions

IOException:: If an I/O error occurs

close	back to summary
public void close() throws IOException Implements abstract java.io.Writer.close. Implements java.io.Closeable.close. Doc from java.io.Writer.close. Closes the stream, flushing it first. Once the stream has been closed, further write() or flush() invocations will cause an IOException to be thrown. Closing a previously closed stream has no effect. Annotations @Override Exceptions IOException: If an I/O error occurs

back to summary

public void close() throws IOException

Implements abstract java.io.Writer.close.

Implements java.io.Closeable.close.

Doc from java.io.Writer.close.

Closes the stream, flushing it first. Once the stream has been closed, further write() or flush() invocations will cause an IOException to be thrown. Closing a previously closed stream has no effect.

Annotations

@Override

Exceptions

IOException:: If an I/O error occurs

flush	back to summary
public void flush() throws IOException Implements abstract java.io.Writer.flush. Implements java.io.Flushable.flush. Doc from java.io.Writer.flush. Flushes the stream. If the stream has saved any characters from the various write() methods in a buffer, write them immediately to their intended destination. Then, if that destination is another character or byte stream, flush it. Thus one flush() invocation will flush all the buffers in a chain of Writers and OutputStreams. If the intended destination of this stream is an abstraction provided by the underlying operating system, for example a file, then flushing the stream guarantees only that bytes previously written to the stream are passed to the operating system for writing; it does not guarantee that they are actually written to a physical device such as a disk drive. Annotations @Override Exceptions IOException: If an I/O error occurs

flush

back to summary

public void flush() throws IOException

Implements abstract java.io.Writer.flush.

Implements java.io.Flushable.flush.

Doc from java.io.Writer.flush.

Flushes the stream. If the stream has saved any characters from the various write() methods in a buffer, write them immediately to their intended destination. Then, if that destination is another character or byte stream, flush it. Thus one flush() invocation will flush all the buffers in a chain of Writers and OutputStreams.

If the intended destination of this stream is an abstraction provided by the underlying operating system, for example a file, then flushing the stream guarantees only that bytes previously written to the stream are passed to the operating system for writing; it does not guarantee that they are actually written to a physical device such as a disk drive.

Annotations

@Override

Exceptions

IOException:: If an I/O error occurs

getMaxWriteSize	back to summary
public int getMaxWriteSize()

newWriter back to summary

newWriter	back to summary
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:OutputStream The `OutputStream` to write to/ charset:String The `Charset` name. Returns:WriteThroughWriter A Writer that will Exceptions IOException: If there is a problem creating the `Writer`.

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:OutputStream: The OutputStream to write to/
charset:String: The Charset name.

Returns:WriteThroughWriter

A Writer that will

Exceptions

IOException:: If there is a problem creating the Writer.

newWriter back to summary

newWriter	back to summary
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:OutputStream The `OutputStream` to write to/ charset:Charset The `Charset`. Returns:WriteThroughWriter A Writer that will Exceptions IOException: If there is a problem creating the `Writer`.

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:OutputStream: The OutputStream to write to/
charset:Charset: The Charset.

Returns:WriteThroughWriter

A Writer that will

Exceptions

IOException:: If there is a problem creating the Writer.

subSequence back to summary

subSequence	back to summary
pack-priv static CharSequence subSequence(String string, int offset, int length) Get a zero copy subsequence of a `String`. Use of this is method can result in unforeseen GC consequences and can bypass JVM optimizations available in `String#subSequence(int, int)`. It should only be used in cases where there is a known benefit: large sub sequence of a larger string with no retained references to the sub sequence beyond the life time of the string. Parameters string:String The `String` to take a subsequence of. offset:int The offset in characters into the string to start the subsequence length:int The length in characters of the substring Returns:CharSequence A new `CharSequence` containing the subsequence, backed by the passed `String` or the original `String` if it is the same.

pack-priv static CharSequence subSequence(String string, int offset, int length)

Get a zero copy subsequence of a String.

Use of this is method can result in unforeseen GC consequences and can bypass JVM optimizations available in String#subSequence(int, int). It should only be used in cases where there is a known benefit: large sub sequence of a larger string with no retained references to the sub sequence beyond the life time of the string.

Parameters

string:String: The String to take a subsequence of.
offset:int: The offset in characters into the string to start the subsequence
length:int: The length in characters of the substring

Returns:CharSequence

A new CharSequence containing the subsequence, backed by the passed String or the original String if it is the same.

subSequence back to summary

subSequence	back to summary
pack-priv static CharSequence subSequence(char[] chars, int offset, int length) Get a zero copy subsequence of a `char` array. Parameters chars:char[] The characters to take a subsequence of. These character are not copied and the array should not be modified for the life of the returned CharSequence. offset:int The offset in characters into the string to start the subsequence length:int The length in characters of the substring Returns:CharSequence A new `CharSequence` containing the subsequence.

pack-priv static CharSequence subSequence(char[] chars, int offset, int length)

Get a zero copy subsequence of a char array.

Parameters

chars:char[]: The characters to take a subsequence of. These character are not copied and the array should not be modified for the life of the returned CharSequence.
offset:int: The offset in characters into the string to start the subsequence
length:int: The length in characters of the substring

Returns:CharSequence

A new CharSequence containing the subsequence.

write	back to summary
public void write(String string, int offset, int length) throws IOException Overrides java.io.Writer.write. Doc from java.io.Writer.write. Writes a portion of a string. Parameters string:String A String offset:int Offset from which to start writing characters length:int Number of characters to write Annotations @Override Exceptions IOException: If an I/O error occurs

write

back to summary

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

Overrides java.io.Writer.write.

Doc from java.io.Writer.write.

Writes a portion of a string.

Parameters

string:String: A String
offset:int: Offset from which to start writing characters
length:int: Number of characters to write

Annotations

@Override

Exceptions

IOException:: If an I/O error occurs

write	back to summary
public void write(char[] chars, int offset, int length) throws IOException Implements abstract java.io.Writer.write. Doc from java.io.Writer.write. Writes a portion of an array of characters. Parameters chars:char[] Array of characters offset:int Offset from which to start writing characters length:int Number of characters to write Annotations @Override Exceptions IOException: If an I/O error occurs

write

back to summary

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

Implements abstract java.io.Writer.write.

Doc from java.io.Writer.write.

Writes a portion of an array of characters.

Parameters

chars:char[]: Array of characters
offset:int: Offset from which to start writing characters
length:int: Number of characters to write

Annotations

@Override

Exceptions

IOException:: If an I/O error occurs

org.eclipse.jetty.io back to summary

private Class WriteThroughWriter.EncodingWriter

Class Inheritance

extends WriteThroughWriter

java.lang.Object
java.io.Writer
org.eclipse.jetty.io.WriteThroughWriter
org.eclipse.jetty.io.WriteThroughWriter.EncodingWriter

An implementation of WriteThroughWriter that internally uses java.io.OutputStreamWriter.

Field Summary

Modifier and Type	Field and Description
pack-priv final Writer	_converter

Inherited from org.eclipse.jetty.io.WriteThroughWriter:: _bytes _out DEFAULT_MAX_WRITE_SIZE

Constructor Summary

Access	Constructor and Description
public	EncodingWriter(OutputStream out, String encoding)
public	EncodingWriter(OutputStream out, Charset charset)

Method Summary

Modifier and Type	Method and Description
public WriteThroughWriter	append(CharSequence The character sequence to append. If `csq` is `null`, then the four characters `"null"` are appended to this writer. charSequence) Implements abstract org.eclipse.jetty.io.WriteThroughWriter.append. Implements java.lang.Appendable.append. Appends the specified character sequence to this writer.

Inherited from org.eclipse.jetty.io.WriteThroughWriter:: close flush getMaxWriteSize newWriter newWriter subSequence subSequence write write

Field Detail

_converter	back to summary
pack-priv final Writer _converter

Constructor Detail

EncodingWriter	back to summary
public EncodingWriter(OutputStream out, String encoding) throws IOException

EncodingWriter	back to summary
public EncodingWriter(OutputStream out, Charset charset) throws IOException

Method Detail

append back to summary

append	back to summary
public WriteThroughWriter append(CharSequence charSequence) throws IOException Implements abstract org.eclipse.jetty.io.WriteThroughWriter.append. Implements java.lang.Appendable.append. Doc from java.io.Writer.append. Appends the specified character sequence to this writer. An invocation of this method of the form `out.append(csq)` behaves in exactly the same way as the invocation `out.write(csq.toString())` out.write(csq.toString()) Depending on the specification of `toString` for the character sequence `csq`, the entire sequence may not be appended. For instance, invoking the `toString` method of a character buffer will return a subsequence whose content depends upon the buffer's position and limit. Parameters charSequence:CharSequence The character sequence to append. If `csq` is `null`, then the four characters `"null"` are appended to this writer. Returns:WriteThroughWriter This writer Annotations @Override Exceptions IOException: If an I/O error occurs

public WriteThroughWriter append(CharSequence charSequence) throws IOException

Implements abstract org.eclipse.jetty.io.WriteThroughWriter.append.

Implements java.lang.Appendable.append.

Doc from java.io.Writer.append.

Appends the specified character sequence to this writer.

An invocation of this method of the form out.append(csq) behaves in exactly the same way as the invocation

out.write(csq.toString())

Parameters

charSequence:CharSequence: The character sequence to append. If csq is null, then the four characters "null" are appended to this writer.

Returns:WriteThroughWriter

This writer

Annotations

@Override

Exceptions

IOException:: If an I/O error occurs

org.eclipse.jetty.io back to summary

private Class WriteThroughWriter.Iso88591Writer

Class Inheritance

extends WriteThroughWriter

java.lang.Object
java.io.Writer
org.eclipse.jetty.io.WriteThroughWriter
org.eclipse.jetty.io.WriteThroughWriter.Iso88591Writer

An implementation of WriteThroughWriter for optimal ISO-8859-1 conversion. The ISO-8859-1 encoding is done by this class and no additional buffers or Writers are used.

Field Summary

Inherited from org.eclipse.jetty.io.WriteThroughWriter:: _bytes _out DEFAULT_MAX_WRITE_SIZE

Constructor Summary

Access	Constructor and Description
private	Iso88591Writer(OutputStream out)

Method Summary

Modifier and Type	Method and Description
public WriteThroughWriter	append(CharSequence The character sequence to append. If `csq` is `null`, then the four characters `"null"` are appended to this writer. charSequence) Implements abstract org.eclipse.jetty.io.WriteThroughWriter.append. Implements java.lang.Appendable.append. Appends the specified character sequence to this writer.

Inherited from org.eclipse.jetty.io.WriteThroughWriter:: close flush getMaxWriteSize newWriter newWriter subSequence subSequence write write

Constructor Detail

Iso88591Writer	back to summary
private Iso88591Writer(OutputStream out)

Method Detail

append back to summary

append	back to summary
public WriteThroughWriter append(CharSequence charSequence) throws IOException Implements abstract org.eclipse.jetty.io.WriteThroughWriter.append. Implements java.lang.Appendable.append. Doc from java.io.Writer.append. Appends the specified character sequence to this writer. An invocation of this method of the form `out.append(csq)` behaves in exactly the same way as the invocation `out.write(csq.toString())` out.write(csq.toString()) Depending on the specification of `toString` for the character sequence `csq`, the entire sequence may not be appended. For instance, invoking the `toString` method of a character buffer will return a subsequence whose content depends upon the buffer's position and limit. Parameters charSequence:CharSequence The character sequence to append. If `csq` is `null`, then the four characters `"null"` are appended to this writer. Returns:WriteThroughWriter This writer Annotations @Override Exceptions IOException: If an I/O error occurs

public WriteThroughWriter append(CharSequence charSequence) throws IOException

Implements abstract org.eclipse.jetty.io.WriteThroughWriter.append.

Implements java.lang.Appendable.append.

Doc from java.io.Writer.append.

Appends the specified character sequence to this writer.

An invocation of this method of the form out.append(csq) behaves in exactly the same way as the invocation

out.write(csq.toString())

Parameters

charSequence:CharSequence: The character sequence to append. If csq is null, then the four characters "null" are appended to this writer.

Returns:WriteThroughWriter

This writer

Annotations

@Override

Exceptions

IOException:: If an I/O error occurs

org.eclipse.jetty.io back to summary

private Class WriteThroughWriter.Utf8Writer

Class Inheritance

extends WriteThroughWriter

java.lang.Object
java.io.Writer
org.eclipse.jetty.io.WriteThroughWriter
org.eclipse.jetty.io.WriteThroughWriter.Utf8Writer

An implementation of WriteThroughWriter for an optimal UTF-8 conversion. The UTF-8 encoding is done by this class and no additional buffers or Writers are used. The UTF-8 code was inspired by ...

Field Summary

Modifier and Type	Field and Description
pack-priv int	_surrogate

Inherited from org.eclipse.jetty.io.WriteThroughWriter:: _bytes _out DEFAULT_MAX_WRITE_SIZE

Constructor Summary

Access	Constructor and Description
private	Utf8Writer(OutputStream out)

Method Summary

Modifier and Type	Method and Description
public WriteThroughWriter	append(CharSequence The character sequence to append. If `csq` is `null`, then the four characters `"null"` are appended to this writer. charSequence) Implements abstract org.eclipse.jetty.io.WriteThroughWriter.append. Implements java.lang.Appendable.append. Appends the specified character sequence to this writer.

Inherited from org.eclipse.jetty.io.WriteThroughWriter:: close flush getMaxWriteSize newWriter newWriter subSequence subSequence write write

Field Detail

_surrogate	back to summary
pack-priv int _surrogate

Constructor Detail

Utf8Writer	back to summary
private Utf8Writer(OutputStream out)

Method Detail

append back to summary

append	back to summary
public WriteThroughWriter append(CharSequence charSequence) throws IOException Implements abstract org.eclipse.jetty.io.WriteThroughWriter.append. Implements java.lang.Appendable.append. Doc from java.io.Writer.append. Appends the specified character sequence to this writer. An invocation of this method of the form `out.append(csq)` behaves in exactly the same way as the invocation `out.write(csq.toString())` out.write(csq.toString()) Depending on the specification of `toString` for the character sequence `csq`, the entire sequence may not be appended. For instance, invoking the `toString` method of a character buffer will return a subsequence whose content depends upon the buffer's position and limit. Parameters charSequence:CharSequence The character sequence to append. If `csq` is `null`, then the four characters `"null"` are appended to this writer. Returns:WriteThroughWriter This writer Annotations @Override Exceptions IOException: If an I/O error occurs

public WriteThroughWriter append(CharSequence charSequence) throws IOException

Implements abstract org.eclipse.jetty.io.WriteThroughWriter.append.

Implements java.lang.Appendable.append.

Doc from java.io.Writer.append.

Appends the specified character sequence to this writer.

An invocation of this method of the form out.append(csq) behaves in exactly the same way as the invocation

out.write(csq.toString())

Parameters

charSequence:CharSequence: The character sequence to append. If csq is null, then the four characters "null" are appended to this writer.

Returns:WriteThroughWriter

This writer

Annotations

@Override

Exceptions

IOException:: If an I/O error occurs

public abstract Class WriteThroughWriter

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class WriteThroughWriter.EncodingWriter

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class WriteThroughWriter.Iso88591Writer

Field Summary

Constructor Summary

Method Summary

Constructor Detail

Method Detail

private Class WriteThroughWriter.Utf8Writer

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail