public abstract class BrowserResponseWriter extends Object
RequestHandler
objects to write data to the client.
Class is written in such a way to promote the ease of writing JSON data to the client browser.
Constructor and Description |
---|
BrowserResponseWriter() |
Modifier and Type | Method and Description |
---|---|
void |
beginArray()
Start an array in an array or at the root level
|
abstract void |
beginArray(String name)
Begin writing an array.
|
void |
beginObject()
Start an object in an array or at the root level
|
abstract void |
beginObject(String name)
Begin writing an object.
|
abstract void |
endArray()
End writing an array.
|
abstract void |
endObject()
Ends an object started with
beginObject(java.lang.String) |
void |
writeCollection(Collection value)
Writes a value to the response object in an array
|
abstract void |
writeCollection(String name, Collection value)
Writes a property to the response object
|
abstract void |
writeProperty(String name, boolean value)
Writes a property to the response object
|
abstract void |
writeProperty(String name, byte value)
Writes a property to the response object
|
abstract void |
writeProperty(String name, char value)
Writes a property to the response object
|
abstract void |
writeProperty(String name, CharSequence value)
Writes a property to the response object
|
abstract void |
writeProperty(String name, double value)
Writes a property to the response object
|
abstract void |
writeProperty(String name, float value)
Writes a property to the response object
|
abstract void |
writeProperty(String name, int value)
Writes a property to the response object
|
abstract void |
writeProperty(String name, long value)
Writes a property to the response object
|
abstract void |
writeProperty(String name, Map<?,?> value)
Writes a property to the response object
|
abstract void |
writeProperty(String name, Object value)
Writes a property to the response object
|
abstract void |
writeProperty(String name, Set<?> value)
Writes a property to the response object
|
abstract void |
writeProperty(String name, short value)
Writes a property to the response object
|
void |
writeValue(boolean value)
Writes a value to the response object in an array
|
void |
writeValue(byte value)
Writes a value to the response object in an array
|
void |
writeValue(char value)
Writes a value to the response object in an array
|
void |
writeValue(CharSequence value)
Writes a value to the response object in an array
|
void |
writeValue(double value)
Writes a value to the response object in an array
|
void |
writeValue(float value)
Writes a value to the response object in an array
|
void |
writeValue(long value)
Writes a value to the response object in an array
|
void |
writeValue(Map<?,?> value)
Writes a value to the response object in an array
|
void |
writeValue(Object value)
Writes a value to the response object in an array
|
void |
writeValue(Set<?> value)
Writes a value to the response object in an array
|
void |
writeValue(short value)
Writes a value to the response object in an array
|
void |
writeValue(String value)
Writes a value to the response object in an array
|
public abstract void beginObject(String name) throws IOException
This is a convenience method to avoid the handler from having to build a map of all the data and writing it at once, this method allows the construction of sub-objects in a streamed fashion.
name
- the name of the property or null if writing to an array to startIOException
- if writing failedendObject()
public void beginObject() throws IOException
IOException
- if writing failedpublic abstract void endObject() throws IOException
beginObject(java.lang.String)
IOException
- if writing failedpublic abstract void beginArray(String name) throws IOException
name
- the name of the array in the parent objectIOException
- if writing failedpublic void beginArray() throws IOException
IOException
- if writing failedpublic abstract void endArray() throws IOException
IOException
- if writing failedpublic abstract void writeProperty(String name, Object value) throws IOException
name
- the name of the property or null if writing to an arrayvalue
- the value of the propertyIOException
- if writing failedpublic void writeValue(Object value) throws IOException
value
- the value of the propertyIOException
- if writing failedpublic abstract void writeProperty(String name, boolean value) throws IOException
name
- the name of the property or null if writing to an arrayvalue
- the value of the propertyIOException
- if writing failedpublic void writeValue(boolean value) throws IOException
value
- the value of the propertyIOException
- if writing failedpublic abstract void writeProperty(String name, byte value) throws IOException
name
- the name of the property or null if writing to an arrayvalue
- the value of the propertyIOException
- if writing failedpublic void writeValue(byte value) throws IOException
value
- the value of the propertyIOException
- if writing failedpublic abstract void writeProperty(String name, char value) throws IOException
name
- the name of the property or null if writing to an arrayvalue
- the value of the propertyIOException
- if writing failedpublic void writeValue(char value) throws IOException
value
- the value of the propertyIOException
- if writing failedpublic abstract void writeProperty(String name, double value) throws IOException
name
- the name of the property or null if writing to an arrayvalue
- the value of the propertyIOException
- if writing failedpublic void writeValue(double value) throws IOException
value
- the value of the propertyIOException
- if writing failedpublic abstract void writeProperty(String name, float value) throws IOException
name
- the name of the property or null if writing to an arrayvalue
- the value of the propertyIOException
- if writing failedpublic void writeValue(float value) throws IOException
value
- the value of the propertyIOException
- if writing failedpublic abstract void writeProperty(String name, long value) throws IOException
name
- the name of the property or null if writing to an arrayvalue
- the value of the propertyIOException
- if writing failedpublic void writeValue(long value) throws IOException
value
- the value of the propertyIOException
- if writing failedpublic abstract void writeProperty(String name, int value) throws IOException
name
- the name of the property or null if writing to an arrayvalue
- the value of the propertyIOException
- if writing failedpublic void writeValue(String value) throws IOException
value
- the value of the propertyIOException
- if writing failedpublic abstract void writeProperty(String name, short value) throws IOException
name
- the name of the property or null if writing to an arrayvalue
- the value of the propertyIOException
- if writing failedpublic void writeValue(short value) throws IOException
value
- the value of the propertyIOException
- if writing failedpublic abstract void writeProperty(String name, CharSequence value) throws IOException
name
- the name of the property or null if writing to an arrayvalue
- the value of the propertyIOException
- if writing failedpublic void writeValue(CharSequence value) throws IOException
value
- the value of the propertyIOException
- if writing failedpublic abstract void writeCollection(String name, Collection value) throws IOException
name
- the name of the property or null if writing to an arrayvalue
- the value of the propertyIOException
- if writing failedpublic void writeCollection(Collection value) throws IOException
value
- the value of the propertyIOException
- if writing failedpublic abstract void writeProperty(String name, Map<?,?> value) throws IOException
name
- the name of the property or null if writing to an arrayvalue
- the value of the propertyIOException
- if writing failedpublic void writeValue(Map<?,?> value) throws IOException
value
- the value of the propertyIOException
- if writing failedpublic abstract void writeProperty(String name, Set<?> value) throws IOException
name
- the name of the property or null if writing to an arrayvalue
- the value of the propertyIOException
- if writing failedpublic void writeValue(Set<?> value) throws IOException
value
- the value of the propertyIOException
- if writing failed