Package com.tagtraum.beatunes.remotecontrol

Class ResponseWriter

java.lang.Object

java.io.Writer

java.io.FilterWriter

com.tagtraum.beatunes.remotecontrol.ResponseWriter

All Implemented Interfaces:

Closeable, Flushable, Appendable, AutoCloseable

public class ResponseWriter
extends FilterWriter

Writer that defaults to sending a JSON-formatted OK message, unless something else is written before flush(). It is recommended to write a message that contains at least the items request and status like this: {"request":"audioplayer.pause.play","status":"ok"}. The original request is accessible via Connection.getRequest().

Author:

Hendrik Schreiber

Field Summary

Fields inherited from class java.io.FilterWriter

out

Fields inherited from class java.io.Writer

lock

Constructor Summary

Constructors

Constructor	Description
ResponseWriter(String request, Writer out, int bufferSize)

Method Summary

Modifier and Type	Method	Description
void	flush()
int	getBufferSize()	Size of the buffer.
boolean	isCommitted()	Indicates whether content has already been written to the client (flushed).
boolean	isEmpty()	Indicates whether anything has been written with this writer.
void	write(char[] cbuf, int off, int len)
void	write(int c)
void	write(String str, int off, int len)

Methods inherited from class java.io.FilterWriter

close

Methods inherited from class java.io.Writer

append, append, append, nullWriter, write, write

Methods inherited from class java.lang.Object

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

Constructor Detail

ResponseWriter

public ResponseWriter(String request,
                      Writer out,
                      int bufferSize)

Method Detail

write

public void write(int c)
           throws IOException

Overrides:

write in class FilterWriter

Throws:

IOException

write

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

Overrides:

write in class FilterWriter

Throws:

IOException

write

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

Overrides:

write in class FilterWriter

Throws:

IOException

isCommitted

public boolean isCommitted()

Indicates whether content has already been written to the client (flushed).

Returns:

true or false

isEmpty

public boolean isEmpty()

Indicates whether anything has been written with this writer. This does not necessarily mean that the content has also been flushed.

Returns:

true or false

getBufferSize

public int getBufferSize()

Size of the buffer.

Returns:

buffer size

flush

public void flush()
           throws IOException

Specified by:

flush in interface Flushable

Overrides:

flush in class FilterWriter

Throws:

IOException