org.restonfire.responses

Class StreamingEvent

java.lang.Object

org.restonfire.responses.StreamingEvent

public class StreamingEvent
extends java.lang.Object

Simple Pojo for deseriazation of the Firebase streaming event using REST. The underlying event data can be retrieved in a serialized or deserialized form, using the Gson instance to convert the data string.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	StreamingEvent.EventType Enum describing the different event types to be returned by the Firebase streaming service.

Constructor Summary

Constructors

Constructor and Description
StreamingEvent(com.google.gson.Gson gson, StreamingEvent.EventType eventType, java.lang.String eventData)

Method Summary

Methods

Modifier and Type	Method and Description
StreamingEventData	getEventData() Returns the StreamingEventData without additional type context information.
<T> StreamingEventData<T>	getEventData(com.google.gson.reflect.TypeToken<StreamingEventData<T>> typeToken) Returns the StreamingEventData without additional type context information.
StreamingEvent.EventType	getEventType() Returns the StreamingEvent.EventType for the individual event.
java.lang.String	getSerialzedEventData() Returns the raw string of the data value as it was returned by the REST API.

Methods inherited from class java.lang.Object

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

Constructor Detail

StreamingEvent

public StreamingEvent(com.google.gson.Gson gson,
              StreamingEvent.EventType eventType,
              java.lang.String eventData)

Method Detail

getEventType

public StreamingEvent.EventType getEventType()

Returns the StreamingEvent.EventType for the individual event. Note that some types have been renamed to match the corresponding FirebaseRestReference interface better.

Returns:

enum value for the StreamingEvent.EventType

See Also:

REST Streaming Documentation for more information.

getSerialzedEventData

public java.lang.String getSerialzedEventData()

Returns the raw string of the data value as it was returned by the REST API.

Returns:

A JSON String representing the path and the value for this event.

getEventData

public StreamingEventData getEventData()

Returns the StreamingEventData without additional type context information. This means that Gson will make a best effort to deserialize the response. As a result, all complex types will be represented as Map<String, Object> and Integer values will be returned as Double.

Returns:

The StreamingEventData object containing the relative path and the value of the event.

See Also:

A more detailed explanation

getEventData

public <T> StreamingEventData<T> getEventData(com.google.gson.reflect.TypeToken<StreamingEventData<T>> typeToken)

Returns the StreamingEventData without additional type context information. This means that Gson will make a best effort to deserialize the response. As a result, all complex types will be represented as Map<String, Object> and Integer values will be returned as Double.

Type Parameters:

T - The type of the actual data node.

Parameters:

typeToken - The TypeToken representing the StreamingEventData type of the data property of the event response, including the type parameter.

Returns:

The StreamingEventData object containing the relative path and the value of the event.