Package org.glassfish.grizzly.streams

Interface StreamWriter

All Superinterfaces:

AutoCloseable, Closeable, Stream

All Known Implementing Classes:

AbstractStreamWriter, DefaultStreamWriter, SSLStreamWriter, TransformerStreamWriter

public interface StreamWriter
extends Stream

Write the primitive Java types and arrays of primitives to some data sink. This may include internal buffering for efficiency reasons. Note, that StreamWriter implementation may not be thread-safe.

Author:

Ken Cavanaugh, Alexey Stashok

Method Summary

Modifier and Type	Method	Description
GrizzlyFuture<Integer>	close(CompletionHandler<Integer> completionHandler)	Close the StreamWriter and make sure all data was flushed.
<E> GrizzlyFuture<Stream>	encode(Transformer<E,Buffer> encoder, E object)
<E> GrizzlyFuture<Stream>	encode(Transformer<E,Buffer> encoder, E object, CompletionHandler<Stream> completionHandler)
GrizzlyFuture<Integer>	flush()	Make sure that all data that has been written is flushed from the stream to its destination.
GrizzlyFuture<Integer>	flush(CompletionHandler<Integer> completionHandler)	Make sure that all data that has been written is flushed from the stream to its destination.
Connection	getConnection()	Get the Connection this StreamWriter belongs to.
long	getTimeout(TimeUnit timeunit)	Get the timeout for StreamWriter I/O operations.
boolean	isClosed()	Returns true, if StreamReader has been closed, or false otherwise.
void	setTimeout(long timeout, TimeUnit timeunit)	Set the timeout for StreamWriter I/O operations.
void	writeBoolean(boolean data)	Write the boolean value to the StreamWriter.
void	writeBooleanArray(boolean[] data)	Write the array of boolean values to the StreamWriter.
void	writeBuffer(Buffer buffer)	Write the Buffer to the StreamWriter.
void	writeByte(byte data)	Write the byte value to the StreamWriter.
void	writeByteArray(byte[] data)	Write the array of byte values to the StreamWriter.
void	writeByteArray(byte[] data, int offset, int length)	Write the part of array of byte values to the StreamWriter, using specific offset and length values.
void	writeChar(char data)	Write the char value to the StreamWriter.
void	writeCharArray(char[] data)	Write the array of char values to the StreamWriter.
void	writeDouble(double data)	Write the double value to the StreamWriter.
void	writeDoubleArray(double[] data)	Write the array of double values to the StreamWriter.
void	writeFloat(float data)	Write the float value to the StreamWriter.
void	writeFloatArray(float[] data)	Write the array of float values to the StreamWriter.
void	writeInt(int data)	Write the int value to the StreamWriter.
void	writeIntArray(int[] data)	Write the array of int values to the StreamWriter.
void	writeLong(long data)	Write the long value to the StreamWriter.
void	writeLongArray(long[] data)	Write the array of long values to the StreamWriter.
void	writeShort(short data)	Write the short value to the StreamWriter.
void	writeShortArray(short[] data)	Write the array of short values to the StreamWriter.

Methods inherited from interface java.io.Closeable

close

Method Detail

isClosed

boolean isClosed()

Returns true, if StreamReader has been closed, or false otherwise.

Returns:

true, if StreamReader has been closed, or false otherwise.

flush

GrizzlyFuture<Integer> flush()
                      throws IOException

Make sure that all data that has been written is flushed from the stream to its destination.

Throws:

IOException

flush

GrizzlyFuture<Integer> flush(CompletionHandler<Integer> completionHandler)
                      throws IOException

Make sure that all data that has been written is flushed from the stream to its destination.

Throws:

IOException

close

GrizzlyFuture<Integer> close(CompletionHandler<Integer> completionHandler)
                      throws IOException

Close the StreamWriter and make sure all data was flushed.

Throws:

IOException

writeBoolean

void writeBoolean(boolean data)
           throws IOException

Write the boolean value to the StreamWriter.

Parameters:

data - boolean value.

Throws:

IOException

writeByte

void writeByte(byte data)
        throws IOException

Write the byte value to the StreamWriter.

Parameters:

data - byte value.

Throws:

IOException

writeChar

void writeChar(char data)
        throws IOException

Write the char value to the StreamWriter.

Parameters:

data - char value.

Throws:

IOException

writeShort

void writeShort(short data)
         throws IOException

Write the short value to the StreamWriter.

Parameters:

data - short value.

Throws:

IOException

writeInt

void writeInt(int data)
       throws IOException

Write the int value to the StreamWriter.

Parameters:

data - int value.

Throws:

IOException

writeLong

void writeLong(long data)
        throws IOException

Write the long value to the StreamWriter.

Parameters:

data - long value.

Throws:

IOException

writeFloat

void writeFloat(float data)
         throws IOException

Write the float value to the StreamWriter.

Parameters:

data - float value.

Throws:

IOException

writeDouble

void writeDouble(double data)
          throws IOException

Write the double value to the StreamWriter.

Parameters:

data - double value.

Throws:

IOException

writeBooleanArray

void writeBooleanArray(boolean[] data)
                throws IOException

Write the array of boolean values to the StreamWriter.

Parameters:

data - array of boolean values.

Throws:

IOException

writeByteArray

void writeByteArray(byte[] data)
             throws IOException

Write the array of byte values to the StreamWriter.

Parameters:

data - array of byte values.

Throws:

IOException

writeByteArray

void writeByteArray(byte[] data,
                    int offset,
                    int length)
             throws IOException

Write the part of array of byte values to the StreamWriter, using specific offset and length values.

Parameters:

data - array of byte values.

offset - array offset to start from.

length - number of bytes to write.

Throws:

IOException

writeCharArray

void writeCharArray(char[] data)
             throws IOException

Write the array of char values to the StreamWriter.

Parameters:

data - array of char values.

Throws:

IOException

writeShortArray

void writeShortArray(short[] data)
              throws IOException

Write the array of short values to the StreamWriter.

Parameters:

data - array of short values.

Throws:

IOException

writeIntArray

void writeIntArray(int[] data)
            throws IOException

Write the array of int values to the StreamWriter.

Parameters:

data - array of int values.

Throws:

IOException

writeLongArray

void writeLongArray(long[] data)
             throws IOException

Write the array of long values to the StreamWriter.

Parameters:

data - array of long values.

Throws:

IOException

writeFloatArray

void writeFloatArray(float[] data)
              throws IOException

Write the array of float values to the StreamWriter.

Parameters:

data - array of float values.

Throws:

IOException

writeDoubleArray

void writeDoubleArray(double[] data)
               throws IOException

Write the array of double values to the StreamWriter.

Parameters:

data - array of double values.

Throws:

IOException

writeBuffer

void writeBuffer(Buffer buffer)
          throws IOException

Write the Buffer to the StreamWriter.

Parameters:

buffer - Buffer.

Throws:

IOException

encode

<E> GrizzlyFuture<Stream> encode(Transformer<E,Buffer> encoder,
                                 E object)
                          throws IOException

Throws:

IOException

encode

<E> GrizzlyFuture<Stream> encode(Transformer<E,Buffer> encoder,
                                 E object,
                                 CompletionHandler<Stream> completionHandler)
                          throws IOException

Throws:

IOException

getConnection

Connection getConnection()

Get the Connection this StreamWriter belongs to.

Specified by:

getConnection in interface Stream

Returns:

the Connection this StreamWriter belongs to.

getTimeout

long getTimeout(TimeUnit timeunit)

Get the timeout for StreamWriter I/O operations.

Parameters:

timeunit - timeout unit TimeUnit.

Returns:

the timeout for StreamWriter I/O operations.

setTimeout

void setTimeout(long timeout,
                TimeUnit timeunit)

Set the timeout for StreamWriter I/O operations.

Parameters:

timeout - the timeout for StreamWriter I/O operations.

timeunit - timeout unit TimeUnit.