Skip navigation links

oracle.adf.view.rich.browserext
Class BrowserResponseWriter

java.lang.Object
oracle.adf.view.rich.browserext.BrowserResponseWriter

public abstract class BrowserResponseWriter

extends Object

Interface for 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 Summary

BrowserResponseWriter()

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Detail

BrowserResponseWriter

public BrowserResponseWriter()

Method Detail

beginObject

public abstract void beginObject(String name)
                          throws IOException

Begin writing an object.

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.

Parameters:

name - the name of the property or null if writing to an array to start

Throws:

IOException - if writing failed

See Also:

endObject()

beginObject

public void beginObject()
                 throws IOException

Start an object in an array or at the root level

Throws:

IOException - if writing failed

endObject

public abstract void endObject()
                        throws IOException

Ends an object started with beginObject(java.lang.String)

Throws:

IOException - if writing failed

beginArray

public abstract void beginArray(String name)
                         throws IOException

Begin writing an array.

Parameters:

name - the name of the array in the parent object

Throws:

IOException - if writing failed

beginArray

public void beginArray()
                throws IOException

Start an array in an array or at the root level

Throws:

IOException - if writing failed

endArray

public abstract void endArray()
                       throws IOException

End writing an array.

Throws:

IOException - if writing failed

writeProperty

public abstract void writeProperty(String name,
                                   Object value)
                            throws IOException

Writes a property to the response object

Parameters:

name - the name of the property or null if writing to an array

value - the value of the property

Throws:

IOException - if writing failed

writeValue

public void writeValue(Object value)
                throws IOException

Writes a value to the response object in an array

Parameters:

value - the value of the property

Throws:

IOException - if writing failed

writeProperty

public abstract void writeProperty(String name,
                                   boolean value)
                            throws IOException

Writes a property to the response object

Parameters:

name - the name of the property or null if writing to an array

value - the value of the property

Throws:

IOException - if writing failed

writeValue

public void writeValue(boolean value)
                throws IOException

Writes a value to the response object in an array

Parameters:

value - the value of the property

Throws:

IOException - if writing failed

writeProperty

public abstract void writeProperty(String name,
                                   byte value)
                            throws IOException

Writes a property to the response object

Parameters:

name - the name of the property or null if writing to an array

value - the value of the property

Throws:

IOException - if writing failed

writeValue

public void writeValue(byte value)
                throws IOException

Writes a value to the response object in an array

Parameters:

value - the value of the property

Throws:

IOException - if writing failed

writeProperty

public abstract void writeProperty(String name,
                                   char value)
                            throws IOException

Writes a property to the response object

Parameters:

name - the name of the property or null if writing to an array

value - the value of the property

Throws:

IOException - if writing failed

writeValue

public void writeValue(char value)
                throws IOException

Writes a value to the response object in an array

Parameters:

value - the value of the property

Throws:

IOException - if writing failed

writeProperty

public abstract void writeProperty(String name,
                                   double value)
                            throws IOException

Writes a property to the response object

Parameters:

name - the name of the property or null if writing to an array

value - the value of the property

Throws:

IOException - if writing failed

writeValue

public void writeValue(double value)
                throws IOException

Writes a value to the response object in an array

Parameters:

value - the value of the property

Throws:

IOException - if writing failed

writeProperty

public abstract void writeProperty(String name,
                                   float value)
                            throws IOException

Writes a property to the response object

Parameters:

name - the name of the property or null if writing to an array

value - the value of the property

Throws:

IOException - if writing failed

writeValue

public void writeValue(float value)
                throws IOException

Writes a value to the response object in an array

Parameters:

value - the value of the property

Throws:

IOException - if writing failed

writeProperty

public abstract void writeProperty(String name,
                                   long value)
                            throws IOException

Writes a property to the response object

Parameters:

name - the name of the property or null if writing to an array

value - the value of the property

Throws:

IOException - if writing failed

writeValue

public void writeValue(long value)
                throws IOException

Writes a value to the response object in an array

Parameters:

value - the value of the property

Throws:

IOException - if writing failed

writeProperty

public abstract void writeProperty(String name,
                                   int value)
                            throws IOException

Writes a property to the response object

Parameters:

name - the name of the property or null if writing to an array

value - the value of the property

Throws:

IOException - if writing failed

writeValue

public void writeValue(String value)
                throws IOException

Writes a value to the response object in an array

Parameters:

value - the value of the property

Throws:

IOException - if writing failed

writeProperty

public abstract void writeProperty(String name,
                                   short value)
                            throws IOException

Writes a property to the response object

Parameters:

name - the name of the property or null if writing to an array

value - the value of the property

Throws:

IOException - if writing failed

writeValue

public void writeValue(short value)
                throws IOException

Writes a value to the response object in an array

Parameters:

value - the value of the property

Throws:

IOException - if writing failed

writeProperty

public abstract void writeProperty(String name,
                                   CharSequence value)
                            throws IOException

Writes a property to the response object

Parameters:

name - the name of the property or null if writing to an array

value - the value of the property

Throws:

IOException - if writing failed

writeValue

public void writeValue(CharSequence value)
                throws IOException

Writes a value to the response object in an array

Parameters:

value - the value of the property

Throws:

IOException - if writing failed

writeCollection

public abstract void writeCollection(String name,
                                     Collection value)
                              throws IOException

Writes a property to the response object

Parameters:

name - the name of the property or null if writing to an array

value - the value of the property

Throws:

IOException - if writing failed

writeCollection

public void writeCollection(Collection value)
                     throws IOException

Writes a value to the response object in an array

Parameters:

value - the value of the property

Throws:

IOException - if writing failed

writeProperty

public abstract void writeProperty(String name,
                                   Map<?,?> value)
                            throws IOException

Writes a property to the response object

Parameters:

name - the name of the property or null if writing to an array

value - the value of the property

Throws:

IOException - if writing failed

writeValue

public void writeValue(Map<?,?> value)
                throws IOException

Writes a value to the response object in an array

Parameters:

value - the value of the property

Throws:

IOException - if writing failed

writeProperty

public abstract void writeProperty(String name,
                                   Set<?> value)
                            throws IOException

Writes a property to the response object

Parameters:

name - the name of the property or null if writing to an array

value - the value of the property

Throws:

IOException - if writing failed

writeValue

public void writeValue(Set<?> value)
                throws IOException

Writes a value to the response object in an array

Parameters:

value - the value of the property

Throws:

IOException - if writing failed

Skip navigation links