Top Description Fields Constructors Methods
org.xnio.streams

public final Class WriterOutputStream

extends OutputStream
Class Inheritance
Static Imports
org.xnio._private.Messages.msg
An output stream which decodes bytes into a character writer.

Field Summary

Modifier and TypeField and Description
private final ByteBuffer
byteBuffer

private final char[]
chars

private volatile boolean
closed

private final CharsetDecoder
decoder

private final Writer
writer

Constructor Summary

AccessConstructor and Description
public
WriterOutputStream(final Writer
the writer to decode into
writer)

Construct a new instance.

public
WriterOutputStream(final Writer
the writer to decode into
writer, final CharsetDecoder
the charset decoder to use
decoder)

Construct a new instance.

public
WriterOutputStream(final Writer
the writer to decode into
writer, final CharsetDecoder
the charset decoder to use
decoder, int
the buffer size to use
bufferSize)

Construct a new instance.

public
WriterOutputStream(final Writer
the writer to decode into
writer, final Charset
the character set to use
charset)

Construct a new instance.

public
WriterOutputStream(final Writer
the writer to decode into
writer, final String
the character set name to use
charsetName)

Construct a new instance.

Method Summary

Modifier and TypeMethod and Description
public void
close()

Overrides java.io.OutputStream.close.

Implements java.io.Closeable.close.

Closes this output stream and releases any system resources associated with this stream.

private void
doFlush(final boolean eof)

public void
flush()

Overrides java.io.OutputStream.flush.

Implements java.io.Flushable.flush.

Flushes this output stream and forces any buffered output bytes to be written out.

private static CharsetDecoder
getDecoder(final Charset charset)

public String

Returns:

the string
toString()

Overrides java.lang.Object.toString.

Get the string representation of this object.

public void
write(final int
the byte.
b)

Implements abstract java.io.OutputStream.write.

Writes the specified byte to this output stream.

public void
write(final byte[]
the data.
b, int
the start offset in the data.
off, int
the number of bytes to write.
len)

Overrides java.io.OutputStream.write.

Writes len bytes from the specified byte array starting at offset off to this output stream.

Inherited from java.io.OutputStream:
nullOutputStreamwrite

Field Detail

byteBufferback to summary
private final ByteBuffer byteBuffer
charsback to summary
private final char[] chars
closedback to summary
private volatile boolean closed
decoderback to summary
private final CharsetDecoder decoder
writerback to summary
private final Writer writer

Constructor Detail

WriterOutputStreamback to summary
public WriterOutputStream(final Writer writer)

Construct a new instance.

Parameters
writer:Writer

the writer to decode into

WriterOutputStreamback to summary
public WriterOutputStream(final Writer writer, final CharsetDecoder decoder)

Construct a new instance.

Parameters
writer:Writer

the writer to decode into

decoder:CharsetDecoder

the charset decoder to use

WriterOutputStreamback to summary
public WriterOutputStream(final Writer writer, final CharsetDecoder decoder, int bufferSize)

Construct a new instance.

Parameters
writer:Writer

the writer to decode into

decoder:CharsetDecoder

the charset decoder to use

bufferSize:int

the buffer size to use

WriterOutputStreamback to summary
public WriterOutputStream(final Writer writer, final Charset charset)

Construct a new instance.

Parameters
writer:Writer

the writer to decode into

charset:Charset

the character set to use

WriterOutputStreamback to summary
public WriterOutputStream(final Writer writer, final String charsetName) throws UnsupportedEncodingException

Construct a new instance.

Parameters
writer:Writer

the writer to decode into

charsetName:String

the character set name to use

Exceptions
UnsupportedEncodingException:
if the character set name is unknown

Method Detail

closeback to summary
public void close() throws IOException

Overrides java.io.OutputStream.close.

Implements java.io.Closeable.close.

Doc from java.io.OutputStream.close.

Closes this output stream and releases any system resources associated with this stream. The general contract of close is that it closes the output stream. A closed stream cannot perform output operations and cannot be reopened.

Exceptions
IOException:
if an I/O error occurs.
doFlushback to summary
private void doFlush(final boolean eof) throws IOException
flushback to summary
public void flush() throws IOException

Overrides java.io.OutputStream.flush.

Implements java.io.Flushable.flush.

Doc from java.io.OutputStream.flush.

Flushes this output stream and forces any buffered output bytes to be written out. The general contract of flush is that calling it is an indication that, if any bytes previously written have been buffered by the implementation of the output stream, such bytes should immediately be written to their intended destination.

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.

Exceptions
IOException:
if an I/O error occurs.
getDecoderback to summary
private static CharsetDecoder getDecoder(final Charset charset)
toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Get the string representation of this object.

Returns:String

the string

writeback to summary
public void write(final int b) throws IOException

Implements abstract java.io.OutputStream.write.

Doc from java.io.OutputStream.write.

Writes the specified byte to this output stream. The general contract for write is that one byte is written to the output stream. The byte to be written is the eight low-order bits of the argument b. The 24 high-order bits of b are ignored.

Parameters
b:int

the byte.

Exceptions
IOException:
if an I/O error occurs. In particular, an IOException may be thrown if the output stream has been closed.
writeback to summary
public void write(final byte[] b, int off, int len) throws IOException

Overrides java.io.OutputStream.write.

Doc from java.io.OutputStream.write.

Writes len bytes from the specified byte array starting at offset off to this output stream. The general contract for write(b, off, len) is that some of the bytes in the array b are written to the output stream in order; element b[off] is the first byte written and b[off+len-1] is the last byte written by this operation.

If b is null, a NullPointerException is thrown.

If off is negative, or len is negative, or off+len is greater than the length of the array b, then an IndexOutOfBoundsException is thrown.

Parameters
b:byte[]

the data.

off:int

the start offset in the data.

len:int

the number of bytes to write.

Exceptions
IOException:
if an I/O error occurs. In particular, an IOException is thrown if the output stream is closed.