mk.gdx.firebase

Class GdxFIRDatabase

java.lang.Object

mk.gdx.firebase.PlatformDistributor<DatabaseDistribution>

mk.gdx.firebase.GdxFIRDatabase

All Implemented Interfaces:

DatabaseDistribution

public class GdxFIRDatabase
extends PlatformDistributor<DatabaseDistribution>
implements DatabaseDistribution

Gets access to Firebase Database API in multi-modules.

See Also:

DatabaseDistribution, PlatformDistributor

Field Summary

Fields inherited from class mk.gdx.firebase.PlatformDistributor

platformObject

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	GdxFIRDatabase() GdxFIRDatabase protected constructor.

Method Summary

Modifier and Type	Method and Description
protected java.lang.String	getAndroidClassName() Gives class name of object that will be create when application running on android platform.
protected java.lang.String	getIOSClassName() Gives class name of object that will be create when application running on ios platform.
DatabaseDistribution	inReference(java.lang.String databasePath) Sets database path you want to deal with in next action.
static GdxFIRDatabase	instance()
void	keepSynced(boolean synced) Keeps data fresh.
void	onConnect(ConnectedListener connectedListener) Listens for database connection events.
<T,E extends T> void	onDataChange(java.lang.Class<T> dataType, DataChangeListener<E> 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 DatabaseDistribution.inReference(String) method.
<T,E extends T> void	readValue(java.lang.Class<T> dataType, DataCallback<E> 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.

Methods inherited from class mk.gdx.firebase.PlatformDistributor

setMockObject

Methods inherited from class java.lang.Object

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

Constructor Detail

GdxFIRDatabase

protected GdxFIRDatabase()
                  throws PlatformDistributorException

GdxFIRDatabase protected constructor.

Instance of this class should be getting by instance()

PlatformDistributor.PlatformDistributor()

Throws:

PlatformDistributorException

Method Detail

instance

public static GdxFIRDatabase instance()

Returns:

Thread-safe singleton instance of this class.

onConnect

public void onConnect(ConnectedListener connectedListener)

Listens for database connection events.

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

Specified by:

onConnect in interface DatabaseDistribution

Parameters:

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

inReference

public DatabaseDistribution inReference(java.lang.String databasePath)

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

Specified by:

inReference in interface DatabaseDistribution

Parameters:

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

Returns:

this instance with the path set

setValue

public void setValue(java.lang.Object value)

Sets value for path given by inReference(String).

Specified by:

setValue in interface DatabaseDistribution

Parameters:

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

setValue

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

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

Specified by:

setValue in interface DatabaseDistribution

Parameters:

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

completeCallback - Callback that handles response

See Also:

CompleteCallback

readValue

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

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

Specified by:

readValue in interface DatabaseDistribution

Type Parameters:

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

E - 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

See Also:

DataCallback

onDataChange

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

Description copied from interface: DatabaseDistribution

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

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

Specified by:

onDataChange in interface DatabaseDistribution

Type Parameters:

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

E - 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.

See Also:

DataChangeListener

push

public 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 DatabaseDistribution.inReference(String) method.

Specified by:

push in interface DatabaseDistribution

Returns:

this

removeValue

public void removeValue()

Removes value in path given by inReference(String).

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

Specified by:

removeValue in interface DatabaseDistribution

removeValue

public 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 DatabaseDistribution.inReference(String) method.

Specified by:

removeValue in interface DatabaseDistribution

Parameters:

completeCallback - Complete callback

See Also:

CompleteCallback

updateChildren

public 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 DatabaseDistribution.inReference(String) method.

Specified by:

updateChildren in interface DatabaseDistribution

Parameters:

data - New data

updateChildren

public 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 DatabaseDistribution.inReference(String) method.

Specified by:

updateChildren in interface DatabaseDistribution

Parameters:

data - New data

completeCallback - Callback when done

transaction

public <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 DatabaseDistribution.inReference(String) method.

Specified by:

transaction in interface DatabaseDistribution

Parameters:

dataType - Type of data you want to get.

transactionCallback - Callback called when transaction is complete.

completeCallback - Can be null

See Also:

CompleteCallback, TransactionCallback

setPersistenceEnabled

public void setPersistenceEnabled(boolean enabled)

Keeps your data for offline usage.

You can read more here and here

Specified by:

setPersistenceEnabled in interface DatabaseDistribution

Parameters:

enabled - e

keepSynced

public void keepSynced(boolean synced)

Keeps data fresh.

You can read more here and here

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

Specified by:

keepSynced in interface DatabaseDistribution

Parameters:

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

getIOSClassName

protected java.lang.String getIOSClassName()

Gives class name of object that will be create when application running on ios platform.

Specified by:

getIOSClassName in class PlatformDistributor<DatabaseDistribution>

Returns:

Class name with package of the ios-moe module distribution object.

getAndroidClassName

protected java.lang.String getAndroidClassName()

Gives class name of object that will be create when application running on android platform.

Specified by:

getAndroidClassName in class PlatformDistributor<DatabaseDistribution>

Returns:

Class name with package of the android module distribution object.