net.officefloor.plugin.stream.impl

Class ServerOutputStreamImpl

java.lang.Object

java.io.OutputStream

net.officefloor.plugin.stream.ServerOutputStream

net.officefloor.plugin.stream.impl.ServerOutputStreamImpl

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable

Direct Known Subclasses:

ServletServerOutputStream

public class ServerOutputStreamImpl
extends ServerOutputStream

ServerOutputStream implementation.

Author:

Daniel Sagenschneider

Constructor Summary

Constructors

Constructor and Description
ServerOutputStreamImpl(WriteBufferReceiver receiver, int sendBufferSize) Initiate.
ServerOutputStreamImpl(WriteBufferReceiver receiver, int sendBufferSize, Serializable stateMomento) Initiate.

Method Summary

Modifier and Type	Method and Description
void	clear() Clears the content.
void	close()
Serializable	exportState(Writer writer) Exports a momento for the current state of this ServerOutputStream.
void	flush()
void	write(ByteBuffer cachedBuffer) Writes a cached ByteBuffer.
void	write(int b)

Methods inherited from class java.io.OutputStream

write, write

Methods inherited from class java.lang.Object

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

Constructor Detail

ServerOutputStreamImpl

public ServerOutputStreamImpl(WriteBufferReceiver receiver,
                              int sendBufferSize)

Initiate.

Parameters:

receiver - WriteBufferReceiver.

sendBufferSize - Send buffer size.

ServerOutputStreamImpl

public ServerOutputStreamImpl(WriteBufferReceiver receiver,
                              int sendBufferSize,
                              Serializable stateMomento)

Initiate.

Parameters:

receiver - WriteBufferReceiver.

sendBufferSize - Send buffer size.

stateMomento - Momento containing the state for this ServerOutputStream.

Method Detail

exportState

public Serializable exportState(Writer writer)
                         throws DataWrittenException,
                                IOException

Exports a momento for the current state of this ServerOutputStream.

Parameters:

writer - Optional Writer to flush its contents before obtaining the state for the momento.

Returns:

Momento for the current state of this ServerOutputStream.

Throws:

DataWrittenException - Should data have already been written to the client.

IOException - If fails to flush data of Writer.

clear

public void clear()
           throws IOException

Clears the content.

Throws:

IOException - If content already provided to WriteBufferReceiver.

write

public void write(ByteBuffer cachedBuffer)
           throws IOException

Description copied from class: ServerOutputStream

Writes a cached ByteBuffer.

This is to enable efficient I/O of writing cached content.

Specified by:

write in class ServerOutputStream

Parameters:

cachedBuffer - Cached ByteBuffer that should never change its content.

Throws:

IOException - If fails to write the ByteBuffer.

write

public void write(int b)
           throws IOException

Specified by:

write in class ServerOutputStream

Throws:

IOException

flush

public void flush()
           throws IOException

Specified by:

flush in interface Flushable

Specified by:

flush in class ServerOutputStream

Throws:

IOException

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Specified by:

close in class ServerOutputStream

Throws:

IOException