Transaction.Handler

public interface Transaction.Handler

An object implementing this interface is used to run a transaction, and will be notified of the results of the transaction.

Summary

Public methods
`abstract @NonNullTransaction.Result`	`doTransaction(@NonNullMutableData currentData)` This method will be called, possibly multiple times, with the current data at this location.
`abstract void`	`onComplete( @NullableDatabaseError error, boolean committed, @NullableDataSnapshot currentData )` This method will be called once with the results of the transaction.

Public methods

doTransaction

abstract @NonNullTransaction.Result doTransaction(@NonNullMutableData currentData)

This method will be called, possibly multiple times, with the current data at this location. It is responsible for inspecting that data and returning a Result specifying either the desired new data at the location or that the transaction should be aborted. Since this method may be called repeatedly for the same transaction, be extremely careful of any side effects that may be triggered by this method. In addition, this method is called from within the Firebase Database library's run loop, so care is also required when accessing data that may be in use by other threads in your application. Best practices for this method are to rely only on the data that is passed in.

Parameters
`@NonNullMutableData currentData`	The current data at the location. Update this to the desired data at the location

Returns
`@NonNullTransaction.Result`	Either the new data, or an indication to abort the transaction

onComplete

abstract void onComplete(
    @NullableDatabaseError error,
    boolean committed,
    @NullableDataSnapshot currentData
)

This method will be called once with the results of the transaction.

Parameters
`@NullableDatabaseError error`	null if no errors occurred, otherwise it contains a description of the error
`boolean committed`	True if the transaction successfully completed, false if it was aborted or an error occurred
`@NullableDataSnapshot currentData`	The current data at the location or null if an error occurred