Package io.objectbox

Class Transaction

java.lang.Object

io.objectbox.Transaction

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

@Internal
@NotThreadSafe
public class Transaction
extends java.lang.Object
implements java.io.Closeable

Field Summary

Fields

Modifier and Type	Field	Description
private boolean	closed	volatile because finalizer thread may interfere with "one thread, one TX" rule
private java.lang.Throwable	creationThrowable
private int	initialCommitCount
private boolean	readOnly
private BoxStore	store
(package private) static boolean	TRACK_CREATION_STACK	May be set by tests
private long	transaction

Constructor Summary

Constructors

Constructor	Description
Transaction(BoxStore store, long transaction, int initialCommitCount)

Method Summary

Modifier and Type	Method	Description
void	abort()
(package private) void	checkOpen()
void	close()
void	commit()
void	commitAndClose()
<T> Cursor<T>	createCursor(java.lang.Class<T> entityClass)
KeyValueCursor	createKeyValueCursor()
protected void	finalize()	Explicitly call close() instead to avoid expensive finalization.
BoxStore	getStore()
(package private) long	internalHandle()
boolean	isActive()
boolean	isClosed()
boolean	isObsolete()	Indicates if data returned from this transaction may be obsolete (another write TX was committed after this transaction was started).
boolean	isReadOnly()
boolean	isRecycled()
(package private) void	nativeAbort(long transaction)
(package private) int[]	nativeCommit(long transaction)
(package private) long	nativeCreateCursor(long transaction, java.lang.String entityName, java.lang.Class<?> entityClass)
(package private) long	nativeCreateKeyValueCursor(long transaction)
(package private) void	nativeDestroy(long transaction)
(package private) boolean	nativeIsActive(long transaction)
(package private) boolean	nativeIsOwnerThread(long transaction)
(package private) boolean	nativeIsReadOnly(long transaction)
(package private) boolean	nativeIsRecycled(long transaction)
(package private) void	nativeRecycle(long transaction)
(package private) void	nativeRenew(long transaction)
(package private) void	nativeReset(long transaction)
void	recycle()	For read transactions, this releases important native resources that hold on versions of potential old data.
void	renew()	Renews a previously recycled transaction (see recycle()).
void	reset()	Will throw if Cursors are still active for this TX.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

TRACK_CREATION_STACK

@Internal
static boolean TRACK_CREATION_STACK

May be set by tests

transaction

private final long transaction

store

private final BoxStore store

readOnly

private final boolean readOnly

creationThrowable

private final java.lang.Throwable creationThrowable

initialCommitCount

private int initialCommitCount

closed

private volatile boolean closed

volatile because finalizer thread may interfere with "one thread, one TX" rule

Constructor Detail

Transaction

public Transaction(BoxStore store,
                   long transaction,
                   int initialCommitCount)

Method Detail

nativeDestroy

void nativeDestroy(long transaction)

nativeCommit

int[] nativeCommit(long transaction)

nativeAbort

void nativeAbort(long transaction)

nativeReset

void nativeReset(long transaction)

nativeRecycle

void nativeRecycle(long transaction)

nativeRenew

void nativeRenew(long transaction)

nativeCreateKeyValueCursor

long nativeCreateKeyValueCursor(long transaction)

nativeCreateCursor

long nativeCreateCursor(long transaction,
                        java.lang.String entityName,
                        java.lang.Class<?> entityClass)

nativeIsActive

boolean nativeIsActive(long transaction)

nativeIsOwnerThread

boolean nativeIsOwnerThread(long transaction)

nativeIsRecycled

boolean nativeIsRecycled(long transaction)

nativeIsReadOnly

boolean nativeIsReadOnly(long transaction)

finalize

protected void finalize()
                 throws java.lang.Throwable

Explicitly call close() instead to avoid expensive finalization.

Overrides:

finalize in class java.lang.Object

Throws:

java.lang.Throwable

checkOpen

void checkOpen()

close

public void close()

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in interface java.io.Closeable

commit

public void commit()

commitAndClose

public void commitAndClose()

abort

public void abort()

reset

@Experimental
public void reset()

Will throw if Cursors are still active for this TX. Efficient for read transactions.

recycle

public void recycle()

For read transactions, this releases important native resources that hold on versions of potential old data. To continue, use renew().

renew

public void renew()

Renews a previously recycled transaction (see recycle()). Efficient for read transactions.

createKeyValueCursor

public KeyValueCursor createKeyValueCursor()

createCursor

public <T> Cursor<T> createCursor(java.lang.Class<T> entityClass)

getStore

public BoxStore getStore()

isActive

public boolean isActive()

isRecycled

public boolean isRecycled()

isClosed

public boolean isClosed()

isReadOnly

public boolean isReadOnly()

isObsolete

public boolean isObsolete()

Indicates if data returned from this transaction may be obsolete (another write TX was committed after this transaction was started).

internalHandle

@Internal
long internalHandle()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object