Package net.officefloor.server.stream.impl

Class ProcessAwareServerWriter

java.lang.Object

java.io.Writer

net.officefloor.server.stream.ServerWriter

net.officefloor.server.stream.impl.ProcessAwareServerWriter

All Implemented Interfaces:

Closeable, Flushable, Appendable, AutoCloseable

public class ProcessAwareServerWriter
extends ServerWriter

ProcessState aware writing ServerWriter.

Author:

Daniel Sagenschneider

Field Summary

Fields inherited from class java.io.Writer

lock

Constructor Summary

Constructors

Constructor	Description
ProcessAwareServerWriter(ServerWriter unsafeServerWriter, ManagedObjectContext context)	Instantiate.

Method Summary

Modifier and Type	Method	Description
Writer	append(char c)
Writer	append(CharSequence csq)
Writer	append(CharSequence csq, int start, int end)
void	close()
void	flush()
void	write(byte[] encodedBytes)	Enables writing encoded bytes.
void	write(char[] cbuf)
void	write(char[] cbuf, int off, int len)
void	write(int c)
void	write(String str)
void	write(String str, int off, int len)
void	write(ByteBuffer encodedBytes)	Enables writing encoded bytes.
void	write(FileChannel file, long position, long count, FileCompleteCallback callback)	Writes part of the FileChannel contents.
void	write(FileChannel file, FileCompleteCallback callback)	Writes the entire FileChannel contents.

Methods inherited from class java.io.Writer

nullWriter

Methods inherited from class java.lang.Object

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

Constructor Details

ProcessAwareServerWriter

public ProcessAwareServerWriter(ServerWriter unsafeServerWriter,
 ManagedObjectContext context)

Instantiate.

Parameters:

unsafeServerWriter - Unsafe ServerWriter.

context - ManagedObjectContext.

Method Details

write

public void write(byte[] encodedBytes)
           throws IOException

Description copied from class: ServerWriter

Enables writing encoded bytes.

Caution should also be taken to ensure that previous written content is not waiting for further surrogate characters.

Specified by:

write in class ServerWriter

Parameters:

encodedBytes - Encoded bytes.

Throws:

IOException - If fails to write the bytes.

write

public void write(FileChannel file,
 long position,
 long count,
 FileCompleteCallback callback)
           throws IOException

Description copied from class: ServerWriter

Writes part of the FileChannel contents.

This is to enable efficient I/O (ie DMA) of writing FileChannel content.

To write the entire FileChannel contents, invoke write(file, 0, -1).

Note that the underlying implementation will need to support FileChannel efficiencies.

Caution should also be taken to ensure that previous written content is not waiting for further surrogate characters.

Specified by:

write in class ServerWriter

Parameters:

file - FileChannel.

position - Position within the FileChannel to start writing content. Must be non-negative number.

count - Count of bytes to write from the FileChannel. A negative value (typically -1) indicates to write the remaining FileChannel content from position.

callback - Optional FileCompleteCallback. May be null.

Throws:

IOException - If fails to write the FileChannel content.

write

public void write(FileChannel file,
 FileCompleteCallback callback)
           throws IOException

Description copied from class: ServerWriter

Writes the entire FileChannel contents.

This is a convenience method for write(file, 0, -1).

Caution should also be taken to ensure that previous written content is not waiting for further surrogate characters.

Specified by:

write in class ServerWriter

Parameters:

file - FileChannel.

callback - Optional FileCompleteCallback. May be null.

Throws:

IOException - If fails to write the FileChannel content.

write

public void write(ByteBuffer encodedBytes)
           throws IOException

Description copied from class: ServerWriter

Enables writing encoded bytes.

Caution should also be taken to ensure that previous written content is not waiting for further surrogate characters.

Specified by:

write in class ServerWriter

Parameters:

encodedBytes - ByteBuffer containing the encoded bytes.

Throws:

IOException - If fails to write the bytes.

write

public void write(int c)
           throws IOException

Overrides:

write in class Writer

Throws:

IOException

write

public void write(char[] cbuf)
           throws IOException

Overrides:

write in class Writer

Throws:

IOException

write

public void write(char[] cbuf,
 int off,
 int len)
           throws IOException

Specified by:

write in class Writer

Throws:

IOException

write

public void write(String str)
           throws IOException

Overrides:

write in class Writer

Throws:

IOException

write

public void write(String str,
 int off,
 int len)
           throws IOException

Overrides:

write in class Writer

Throws:

IOException

append

public Writer append(CharSequence csq)
              throws IOException

Specified by:

append in interface Appendable

Overrides:

append in class Writer

Throws:

IOException

append

public Writer append(CharSequence csq,
 int start,
 int end)
              throws IOException

Specified by:

append in interface Appendable

Overrides:

append in class Writer

Throws:

IOException

append

public Writer append(char c)
              throws IOException

Specified by:

append in interface Appendable

Overrides:

append 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

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