org.glassfish.grizzly.http.server.io
Class NIOWriter

java.lang.Object
  java.io.Writer
      org.glassfish.grizzly.http.server.io.NIOWriter

All Implemented Interfaces:

java.io.Closeable, java.io.Flushable, java.lang.Appendable, NIOOutputSink

public class NIOWriter
extends java.io.Writer
implements NIOOutputSink

Stream implementation for writing character content to an HTTP user-agent.

Since:

2.0

Field Summary

Fields inherited from class java.io.Writer

lock

Constructor Summary

NIOWriter(OutputBuffer outputBuffer)

Method Summary

boolean	canWrite(int length)
void	close()
void	flush()
boolean	notifyCanWrite(WriteHandler handler, int length) Instructs the NIOOutputSink to invoke the provided WriteHandler when it is possible to write length characters.
void	write(char[] cbuf)
void	write(char[] cbuf, int off, int len)
void	write(int c)
void	write(java.lang.String str)
void	write(java.lang.String str, int off, int len)

Methods inherited from class java.io.Writer

append, append, append

Methods inherited from class java.lang.Object

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

Constructor Detail

NIOWriter

public NIOWriter(OutputBuffer outputBuffer)

Method Detail

write

public void write(int c)
           throws java.io.IOException

Overrides:

write in class java.io.Writer

Throws:

java.io.IOException

write

public void write(char[] cbuf)
           throws java.io.IOException

Overrides:

write in class java.io.Writer

Throws:

java.io.IOException

write

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

Specified by:

write in class java.io.Writer

Throws:

java.io.IOException

write

public void write(java.lang.String str)
           throws java.io.IOException

Overrides:

write in class java.io.Writer

Throws:

java.io.IOException

write

public void write(java.lang.String str,
                  int off,
                  int len)
           throws java.io.IOException

Overrides:

write in class java.io.Writer

Throws:

java.io.IOException

flush

public void flush()
           throws java.io.IOException

Specified by:

flush in interface java.io.Flushable

Specified by:

flush in class java.io.Writer

Throws:

java.io.IOException

close

public void close()
           throws java.io.IOException

Specified by:

close in interface java.io.Closeable

Specified by:

close in class java.io.Writer

Throws:

java.io.IOException

canWrite

public boolean canWrite(int length)

Specified by:

canWrite in interface NIOOutputSink

Parameters:

length - specifies the number of characters that require writing

Returns:

true if a write to this NIOOutputSink will succeed, otherwise returns false.

notifyCanWrite

public boolean notifyCanWrite(WriteHandler handler,
                              int length)

Instructs the NIOOutputSink to invoke the provided WriteHandler when it is possible to write length characters.

Specified by:

notifyCanWrite in interface NIOOutputSink

Parameters:

handler - the WriteHandler that should be notified when it's possible to write length characters.

length - the number of characters that require writing.

Returns:

true if the specified handler has been accepted and will be notified as it becomes possible to write, otherwise returns false which means data is currently available to write without blocking or that there is no limit as to how much data can be pending to be written.