com.squareup.sqlbrite

Interface BriteDatabase.Transaction

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable

Enclosing class:

BriteDatabase

public static interface BriteDatabase.Transaction
extends java.io.Closeable

An in-progress database transaction.

Method Summary

Modifier and Type	Method and Description
void	close() Equivalent to calling end()
void	end() End a transaction.
void	markSuccessful() Marks the current transaction as successful.
boolean	yieldIfContendedSafely() Temporarily end the transaction to let other threads run.
boolean	yieldIfContendedSafely(long sleepAmount, java.util.concurrent.TimeUnit sleepUnit) Temporarily end the transaction to let other threads run.

Method Detail

end

void end()

End a transaction. See BriteDatabase.newTransaction() for notes about how to use this and when transactions are committed and rolled back.

See Also:

SQLiteDatabase.endTransaction()

markSuccessful

void markSuccessful()

Marks the current transaction as successful. Do not do any more database work between calling this and calling end(). Do as little non-database work as possible in that situation too. If any errors are encountered between this and end() the transaction will still be committed.

See Also:

SQLiteDatabase.setTransactionSuccessful()

yieldIfContendedSafely

boolean yieldIfContendedSafely()

Temporarily end the transaction to let other threads run. The transaction is assumed to be successful so far. Do not call markSuccessful() before calling this. When this returns a new transaction will have been created but not marked as successful. This assumes that there are no nested transactions (newTransaction has only been called once) and will throw an exception if that is not the case.

Returns:

true if the transaction was yielded

See Also:

SQLiteDatabase.yieldIfContendedSafely()

yieldIfContendedSafely

boolean yieldIfContendedSafely(long sleepAmount,
                               java.util.concurrent.TimeUnit sleepUnit)

Temporarily end the transaction to let other threads run. The transaction is assumed to be successful so far. Do not call markSuccessful() before calling this. When this returns a new transaction will have been created but not marked as successful. This assumes that there are no nested transactions (newTransaction has only been called once) and will throw an exception if that is not the case.

Parameters:

sleepAmount - if > 0, sleep this long before starting a new transaction if the lock was actually yielded. This will allow other background threads to make some more progress than they would if we started the transaction immediately.

Returns:

true if the transaction was yielded

See Also:

SQLiteDatabase.yieldIfContendedSafely(long)

close

void close()

Equivalent to calling end()

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in interface java.io.Closeable