mk.gdx.firebase.distributions

Interface DatabaseDistribution

All Known Implementing Classes:

GdxFIRDatabase

public interface DatabaseDistribution

Provides access to Firebase database.

Before you do some operations on database you should chose on which parts of data you want to operate.

To do that you need to call inReference(String) before each of following methods:

• setValue(Object)
• setValue(Object, CompleteCallback)
• updateChildren(Map)
• updateChildren(Map, CompleteCallback)
• onDataChange(Class, DataChangeListener)
• readValue(Class, DataCallback)
• push()
• transaction(Class, TransactionCallback, CompleteCallback)

If you do not do this RuntimeException will be thrown.

Method Summary

Modifier and Type	Method and Description
DatabaseDistribution	inReference(java.lang.String databasePath) Sets database path you want to deal with in next action.
void	keepSynced(boolean synced) Keeps data fresh.
void	onConnect(ConnectedListener connectedListener) Listens for database connection events.
<T,R extends T> void	onDataChange(java.lang.Class<T> dataType, DataChangeListener<R> listener) Handles value changes for path given by inReference(String) and gives response by DataChangeListener.
DatabaseDistribution	push() Creates new object inside database and return this instance with reference to it set by DatabaseDistribution#inReference() Remember to set database reference earlier by calling the inReference(String) method.
<T,R extends T> void	readValue(java.lang.Class<T> dataType, DataCallback<R> callback) Reads value from path given by inReference(String) and gives response by DataCallback.
void	removeValue() Removes value in path given by inReference(String).
void	removeValue(CompleteCallback completeCallback) Removes value for path given by inReference(String) and gives response by DataChangeListener.
void	setPersistenceEnabled(boolean enabled) Keeps your data for offline usage.
void	setValue(java.lang.Object value) Sets value for path given by inReference(String).
void	setValue(java.lang.Object value, CompleteCallback completeCallback) Sets value for path given by inReference(String) and gives response by CompleteCallback.
<T,R extends T> void	transaction(java.lang.Class<T> dataType, TransactionCallback<R> transactionCallback, CompleteCallback completeCallback) Provides transaction for value describe by path given by inReference(String) and gives response by CompleteCallback Value that you want to change will be get in TransactionCallback.run(Object) - there you should modifying data and returns a new one.
void	updateChildren(java.util.Map<java.lang.String,java.lang.Object> data) Updates children's for path given by inReference(String).
void	updateChildren(java.util.Map<java.lang.String,java.lang.Object> data, CompleteCallback completeCallback) Updates children's for path given by inReference(String) and gives response by CompleteCallback.

Method Detail

onConnect

void onConnect(ConnectedListener connectedListener)

Listens for database connection events.

Catch moment when application is going to to be connected or disconnected to the database.

Parameters:

connectedListener - Listener that handles moments when connection status into database was change

inReference

DatabaseDistribution inReference(java.lang.String databasePath)

Sets database path you want to deal with in next action.

Parameters:

databasePath - Reference inside your database for ex. "/users"

Returns:

this instance with the path set

setValue

void setValue(java.lang.Object value)

Sets value for path given by inReference(String).

Parameters:

value - Any value which you want to store. Given object will be transformed to Firebase-like data type.

Throws:

java.lang.RuntimeException - if inReference(String) was not call before.

setValue

void setValue(java.lang.Object value,
              CompleteCallback completeCallback)

Sets value for path given by inReference(String) and gives response by CompleteCallback.

Parameters:

value - Any value which you want to store. Given object will be transformed to Firebase-like data type.

completeCallback - Callback that handles response

Throws:

java.lang.RuntimeException - if inReference(String) was not call before.

See Also:

CompleteCallback

readValue

<T,R extends T> void readValue(java.lang.Class<T> dataType,
                               DataCallback<R> callback)

Reads value from path given by inReference(String) and gives response by DataCallback.

Type Parameters:

T - Type of data you want to retrieve, associated with dataType for ex. List.class

R - More specific type of data you want to retrieve associated with callback - needed because of nested generic types for ex. List<User>

Parameters:

dataType - Class you want to retrieve

callback - Callback that handles response

Throws:

java.lang.RuntimeException - if inReference(String) was not call before.

See Also:

DataCallback

onDataChange

<T,R extends T> void onDataChange(java.lang.Class<T> dataType,
                                  DataChangeListener<R> listener)

Handles value changes for path given by inReference(String) and gives response by DataChangeListener.

Remember to set database reference earlier by calling the inReference(String) method.

Type Parameters:

T - Type of data you want to retrieve, associated with dataType for ex. List.class

R - More specific type of data you want to retrieve associated with listener - needed because of nested generic types for ex. List<User>

Parameters:

dataType - Class you want to retrieve

listener - Listener, may by null - if null all listeners for specified database reference will be removed.

Throws:

java.lang.RuntimeException - if inReference(String) was not call before.

See Also:

DataChangeListener

push

DatabaseDistribution push()

Creates new object inside database and return this instance with reference to it set by DatabaseDistribution#inReference()

Remember to set database reference earlier by calling the inReference(String) method.

Returns:

this

Throws:

java.lang.RuntimeException - if inReference(String) was not call before.

removeValue

void removeValue()

Removes value in path given by inReference(String).

Remember to set database reference earlier by calling the inReference(String) method.

Throws:

java.lang.RuntimeException - if inReference(String) was not call before.

removeValue

void removeValue(CompleteCallback completeCallback)

Removes value for path given by inReference(String) and gives response by DataChangeListener.

Remember to set database reference earlier by calling the inReference(String) method.

Parameters:

completeCallback - Complete callback

Throws:

java.lang.RuntimeException - if inReference(String) was not call before.

See Also:

CompleteCallback

updateChildren

void updateChildren(java.util.Map<java.lang.String,java.lang.Object> data)

Updates children's for path given by inReference(String).

Remember to set database reference earlier by calling the inReference(String) method.

Parameters:

data - New data

Throws:

java.lang.RuntimeException - if inReference(String) was not call before.

updateChildren

void updateChildren(java.util.Map<java.lang.String,java.lang.Object> data,
                    CompleteCallback completeCallback)

Updates children's for path given by inReference(String) and gives response by CompleteCallback.

Remember to set database reference earlier by calling the inReference(String) method.

Parameters:

data - New data

completeCallback - Callback when done

Throws:

java.lang.RuntimeException - if inReference(String) was not call before.

transaction

<T,R extends T> void transaction(java.lang.Class<T> dataType,
                                 TransactionCallback<R> transactionCallback,
                                 CompleteCallback completeCallback)

Provides transaction for value describe by path given by inReference(String) and gives response by CompleteCallback

Value that you want to change will be get in TransactionCallback.run(Object) - there you should

modifying data and returns a new one.

Remember to set database reference earlier by calling the inReference(String) method.

Parameters:

dataType - Type of data you want to get.

transactionCallback - Callback called when transaction is complete.

completeCallback - Can be null

Throws:

java.lang.RuntimeException - if inReference(String) was not call before call this method.

See Also:

CompleteCallback, TransactionCallback

setPersistenceEnabled

void setPersistenceEnabled(boolean enabled)

Keeps your data for offline usage.

You can read more here and here

Parameters:

enabled - e

keepSynced

void keepSynced(boolean synced)

Keeps data fresh.

You can read more here and here

Remember to set database reference earlier by calling the inReference(String) method.

Parameters:

synced - If true sync for specified database path will be enabled

Throws:

java.lang.RuntimeException - if inReference(String) was not call before call this method.