org.restonfire

Interface FirebaseRestReference

public interface FirebaseRestReference

A FirebaseRestReference represents a specific location within a Firebase namespace and allows for operations to be executed on this location using Firebase's REST API.

This interface is a mixture of Firebase's Java and Javascript API, using similar syntax as the Java (Android) API but returning a Promise to allow for a more functional implementation of asynchronous requests.

See Also:

JDeferred Library

Method Summary

Methods

Modifier and Type	Method and Description
FirebaseRestReference	child(java.lang.String path) Returns the reference for the given child location of this FirebaseRestReference.
FirebaseRestReference	getParent() Returns the reference for the parent location of this FirebaseRestReference.
java.lang.String	getReferenceUrl() Returns the fully qualified URL for this FirebaseRestReference instance.
FirebaseRestReference	getRoot() Returns the reference for the root of this Firebase namespace.
<T> org.jdeferred.Promise<T,FirebaseRuntimeException,java.lang.Void>	getValue(java.lang.Class<T> clazz) Retrieves the value for this reference URL from Firebase. The promise returned will be rejected with the following two exceptions: org.restonfire.exceptions.FirebaseAccessException - A FirebaseRuntimeException in the case that access to the data for this reference was denied.
org.jdeferred.Promise<FirebaseRestReference,FirebaseRuntimeException,java.lang.Void>	push() Creates a new child property under the current location.
org.jdeferred.Promise<java.lang.Void,FirebaseRuntimeException,java.lang.Void>	removeValue() Removes the value for this reference URL from Firebase.
<T> org.jdeferred.Promise<T,FirebaseRuntimeException,java.lang.Void>	setValue(T value) Sets the value in Firebase for this reference URL.
<T> org.jdeferred.Promise	updateValue(T value) Updates the value in Firebase for this reference URL.

Method Detail

getReferenceUrl

java.lang.String getReferenceUrl()

Returns the fully qualified URL for this FirebaseRestReference instance.

Returns:

The absolute URL of the current reference as a String.

getValue

<T> org.jdeferred.Promise<T,FirebaseRuntimeException,java.lang.Void> getValue(java.lang.Class<T> clazz)

Retrieves the value for this reference URL from Firebase.

The promise returned will be rejected with the following two exceptions:

• org.restonfire.exceptions.FirebaseAccessException - A FirebaseRuntimeException in the case that access to the data for this reference was denied.
• org.restonfire.exceptions.FirebaseRestException - A FirebaseRuntimeException in the case that an unexpected status code was returned or the deserialization of the response into the type parameter fails.

Type Parameters:

T - The type of the result object.

Parameters:

clazz - The Class type for the POJO to be created for the data returned by the request.

Returns:

A promise which will be resolved with the POJO generated from the response if the request was successful.

setValue

<T> org.jdeferred.Promise<T,FirebaseRuntimeException,java.lang.Void> setValue(T value)

Sets the value in Firebase for this reference URL. This will overwrite all data that is currently stored under that location. Providing a null value is the equivalent of removing the data at this location.

The promise returned will be rejected with the following two exceptions:

• org.restonfire.exceptions.FirebaseAccessException - A FirebaseRuntimeException in the case that access to the data for this reference was denied.
• org.restonfire.exceptions.FirebaseRestException - A FirebaseRuntimeException in the case that an unexpected status code was returned or the deserialization of the response into the type parameter fails.

Type Parameters:

T - The type of the parameter object.

Parameters:

value - The value to be written to Firebase.

Returns:

A promise which will resolve with the object passed in as the value if the request was successful.

updateValue

<T> org.jdeferred.Promise updateValue(T value)

Updates the value in Firebase for this reference URL. Only the properties (child nodes) that are included in this value object will be overwritten. Any other properties not included in the value will remain the same.

The promise returned will be rejected with the following two exceptions:

• org.restonfire.exceptions.FirebaseAccessException - A FirebaseRuntimeException in the case that access to the data for this reference was denied.
• org.restonfire.exceptions.FirebaseRestException - A FirebaseRuntimeException in the case that an unexpected status code was returned or the deserialization of the response into the type parameter fails.

Type Parameters:

T - The type of the parameter object.

Parameters:

value - The value to be written to Firebase.

Returns:

A promise which will resolve with the object passed in as the value if the request was successful.

removeValue

org.jdeferred.Promise<java.lang.Void,FirebaseRuntimeException,java.lang.Void> removeValue()

Removes the value for this reference URL from Firebase. This is the requivalent to setting the value to null.

The promise returned will be rejected with the following two exceptions:

• org.restonfire.exceptions.FirebaseAccessException - A FirebaseRuntimeException in the case that access to the data for this reference was denied.
• org.restonfire.exceptions.FirebaseRestException - A FirebaseRuntimeException in the case that an unexpected status code was returned.

Returns:

A promise which will be resolved with a null value if the request was successful.

push

org.jdeferred.Promise<FirebaseRestReference,FirebaseRuntimeException,java.lang.Void> push()

Creates a new child property under the current location. Firebase will give the child node a unique identifier returned by this .

The promise returned will be rejected with the following two exceptions:

• org.restonfire.exceptions.FirebaseAccessException - A FirebaseRuntimeException in the case that access to the data for this reference was denied.
• org.restonfire.exceptions.FirebaseRestException - A FirebaseRuntimeException in the case that an unexpected status code was returned.

Returns:

The reference to the newly created child in Firebase.

See Also:

Firebase Android Documentation

getRoot

FirebaseRestReference getRoot()

Returns the reference for the root of this Firebase namespace.

Returns:

The FirebaseRestReference representing the root of this Firebase namespace.

getParent

FirebaseRestReference getParent()

Returns the reference for the parent location of this FirebaseRestReference.

Returns:

The FirebaseRestReference representing the parent location of this FirebaseRestReference.

child

FirebaseRestReference child(java.lang.String path)

Returns the reference for the given child location of this FirebaseRestReference.

Parameters:

path - The child's name or path to the child relative to this reference.

Returns:

The FirebaseRestReference representing the child location.