de.greenrobot.dao.async

Class AsyncSession

java.lang.Object

de.greenrobot.dao.async.AsyncSession

public class AsyncSession
extends java.lang.Object

Asynchronous interface to entity operations. All operations will enqueued a @link AsyncOperation and return immediately (fine to call on the UI/main thread). The queue will be processed in a (single) background thread. The processing order is the call order of the operations. It's possible to start multiple AsyncSessions that will execute concurrently.

See Also:

AbstractDaoSession.startAsyncSession()

Constructor Summary

Constructors

Constructor and Description
AsyncSession(AbstractDaoSession daoSession)

Method Summary

Methods

Modifier and Type	Method and Description
AsyncOperation	callInTx(java.util.concurrent.Callable<?> callable) Asynchronous version of AbstractDaoSession.callInTx(Callable).
AsyncOperation	callInTx(java.util.concurrent.Callable<?> callable, int flags) Asynchronous version of AbstractDaoSession.callInTx(Callable).
AsyncOperation	count(java.lang.Class<?> entityClass) Asynchronous version of AbstractDao.count().
AsyncOperation	count(java.lang.Class<?> entityClass, int flags) Asynchronous version of AbstractDao.count().
AsyncOperation	delete(java.lang.Object entity) Asynchronous version of AbstractDao.delete(Object).
AsyncOperation	delete(java.lang.Object entity, int flags) Asynchronous version of AbstractDao.delete(Object).
<E> AsyncOperation	deleteAll(java.lang.Class<E> entityClass) Asynchronous version of AbstractDao.deleteAll().
<E> AsyncOperation	deleteAll(java.lang.Class<E> entityClass, int flags) Asynchronous version of AbstractDao.deleteAll().
AsyncOperation	deleteByKey(java.lang.Object key) Asynchronous version of AbstractDao.deleteByKey(Object).
AsyncOperation	deleteByKey(java.lang.Object key, int flags) Asynchronous version of AbstractDao.deleteByKey(Object).
<E> AsyncOperation	deleteInTx(java.lang.Class<E> entityClass, E... entities) Asynchronous version of AbstractDao.deleteInTx(Object...).
<E> AsyncOperation	deleteInTx(java.lang.Class<E> entityClass, int flags, E... entities) Asynchronous version of AbstractDao.deleteInTx(Object...).
<E> AsyncOperation	deleteInTx(java.lang.Class<E> entityClass, java.lang.Iterable<E> entities) Asynchronous version of AbstractDao.deleteInTx(Iterable).
<E> AsyncOperation	deleteInTx(java.lang.Class<E> entityClass, java.lang.Iterable<E> entities, int flags) Asynchronous version of AbstractDao.deleteInTx(Iterable).
AsyncOperationListener	getListener()
AsyncOperationListener	getListenerMainThread()
int	getMaxOperationCountToMerge()
int	getSessionFlags() AsyncOperation flags set for all operations (will be ORed with call flags).
int	getWaitForMergeMillis()
AsyncOperation	insert(java.lang.Object entity) Asynchronous version of AbstractDao.insert(Object).
AsyncOperation	insert(java.lang.Object entity, int flags) Asynchronous version of AbstractDao.insert(Object).
<E> AsyncOperation	insertInTx(java.lang.Class<E> entityClass, E... entities) Asynchronous version of AbstractDao.insertInTx(Object...).
<E> AsyncOperation	insertInTx(java.lang.Class<E> entityClass, int flags, E... entities) Asynchronous version of AbstractDao.insertInTx(Object...).
<E> AsyncOperation	insertInTx(java.lang.Class<E> entityClass, java.lang.Iterable<E> entities) Asynchronous version of AbstractDao.insertInTx(Iterable).
<E> AsyncOperation	insertInTx(java.lang.Class<E> entityClass, java.lang.Iterable<E> entities, int flags) Asynchronous version of AbstractDao.insertInTx(Iterable).
AsyncOperation	insertOrReplace(java.lang.Object entity) Asynchronous version of AbstractDao.insertOrReplace(Object).
AsyncOperation	insertOrReplace(java.lang.Object entity, int flags) Asynchronous version of AbstractDao.insertOrReplace(Object).
<E> AsyncOperation	insertOrReplaceInTx(java.lang.Class<E> entityClass, E... entities) Asynchronous version of AbstractDao.insertOrReplaceInTx(Object...).
<E> AsyncOperation	insertOrReplaceInTx(java.lang.Class<E> entityClass, int flags, E... entities) Asynchronous version of AbstractDao.insertOrReplaceInTx(Object...).
<E> AsyncOperation	insertOrReplaceInTx(java.lang.Class<E> entityClass, java.lang.Iterable<E> entities) Asynchronous version of AbstractDao.insertOrReplaceInTx(Iterable).
<E> AsyncOperation	insertOrReplaceInTx(java.lang.Class<E> entityClass, java.lang.Iterable<E> entities, int flags) Asynchronous version of AbstractDao.insertOrReplaceInTx(Iterable).
boolean	isCompleted()
AsyncOperation	load(java.lang.Class<?> entityClass, java.lang.Object key) Asynchronous version of AbstractDao.load(Object).
AsyncOperation	load(java.lang.Class<?> entityClass, java.lang.Object key, int flags) Asynchronous version of AbstractDao.load(Object).
AsyncOperation	loadAll(java.lang.Class<?> entityClass) Asynchronous version of AbstractDao.loadAll().
AsyncOperation	loadAll(java.lang.Class<?> entityClass, int flags) Asynchronous version of AbstractDao.loadAll().
AsyncOperation	queryList(Query<?> query) Asynchronous version of Query.list().
AsyncOperation	queryList(Query<?> query, int flags) Asynchronous version of Query.list().
AsyncOperation	queryUnique(Query<?> query) Asynchronous version of Query.unique().
AsyncOperation	queryUnique(Query<?> query, int flags) Asynchronous version of Query.unique().
AsyncOperation	refresh(java.lang.Object entity) Asynchronous version of AbstractDao.refresh(Object).
AsyncOperation	refresh(java.lang.Object entity, int flags) Asynchronous version of AbstractDao.refresh(Object).
AsyncOperation	runInTx(java.lang.Runnable runnable) Asynchronous version of AbstractDaoSession.runInTx(Runnable).
AsyncOperation	runInTx(java.lang.Runnable runnable, int flags) Asynchronous version of AbstractDaoSession.runInTx(Runnable).
void	setListener(AsyncOperationListener listener)
void	setListenerMainThread(AsyncOperationListener listenerMainThread)
void	setMaxOperationCountToMerge(int maxOperationCountToMerge)
void	setSessionFlags(int sessionFlags) AsyncOperation flags set for all operations (will be ORed with call flags).
void	setWaitForMergeMillis(int waitForMergeMillis)
AsyncOperation	update(java.lang.Object entity) Asynchronous version of AbstractDao.update(Object).
AsyncOperation	update(java.lang.Object entity, int flags) Asynchronous version of AbstractDao.update(Object).
<E> AsyncOperation	updateInTx(java.lang.Class<E> entityClass, E... entities) Asynchronous version of AbstractDao.updateInTx(Object...).
<E> AsyncOperation	updateInTx(java.lang.Class<E> entityClass, int flags, E... entities) Asynchronous version of AbstractDao.updateInTx(Object...).
<E> AsyncOperation	updateInTx(java.lang.Class<E> entityClass, java.lang.Iterable<E> entities) Asynchronous version of AbstractDao.updateInTx(Iterable).
<E> AsyncOperation	updateInTx(java.lang.Class<E> entityClass, java.lang.Iterable<E> entities, int flags) Asynchronous version of AbstractDao.updateInTx(Iterable).
void	waitForCompletion() Waits until all enqueued operations are complete.
boolean	waitForCompletion(int maxMillis) Waits until all enqueued operations are complete, but at most the given amount of milliseconds.

Methods inherited from class java.lang.Object

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

Constructor Detail

AsyncSession

public AsyncSession(AbstractDaoSession daoSession)

Method Detail

getMaxOperationCountToMerge

public int getMaxOperationCountToMerge()

setMaxOperationCountToMerge

public void setMaxOperationCountToMerge(int maxOperationCountToMerge)

getWaitForMergeMillis

public int getWaitForMergeMillis()

setWaitForMergeMillis

public void setWaitForMergeMillis(int waitForMergeMillis)

getListener

public AsyncOperationListener getListener()

setListener

public void setListener(AsyncOperationListener listener)

getListenerMainThread

public AsyncOperationListener getListenerMainThread()

setListenerMainThread

public void setListenerMainThread(AsyncOperationListener listenerMainThread)

isCompleted

public boolean isCompleted()

waitForCompletion

public void waitForCompletion()

Waits until all enqueued operations are complete. If the thread gets interrupted, any InterruptedException will be rethrown as a DaoException.

waitForCompletion

public boolean waitForCompletion(int maxMillis)

Waits until all enqueued operations are complete, but at most the given amount of milliseconds. If the thread gets interrupted, any InterruptedException will be rethrown as a DaoException.

Returns:

true if operations completed in the given time frame.

insert

public AsyncOperation insert(java.lang.Object entity)

Asynchronous version of AbstractDao.insert(Object).

insert

public AsyncOperation insert(java.lang.Object entity,
                    int flags)

Asynchronous version of AbstractDao.insert(Object).

insertInTx

public <E> AsyncOperation insertInTx(java.lang.Class<E> entityClass,
                            E... entities)

Asynchronous version of AbstractDao.insertInTx(Object...).

insertInTx

public <E> AsyncOperation insertInTx(java.lang.Class<E> entityClass,
                            int flags,
                            E... entities)

Asynchronous version of AbstractDao.insertInTx(Object...).

insertInTx

public <E> AsyncOperation insertInTx(java.lang.Class<E> entityClass,
                            java.lang.Iterable<E> entities)

Asynchronous version of AbstractDao.insertInTx(Iterable).

insertInTx

public <E> AsyncOperation insertInTx(java.lang.Class<E> entityClass,
                            java.lang.Iterable<E> entities,
                            int flags)

Asynchronous version of AbstractDao.insertInTx(Iterable).

insertOrReplace

public AsyncOperation insertOrReplace(java.lang.Object entity)

Asynchronous version of AbstractDao.insertOrReplace(Object).

insertOrReplace

public AsyncOperation insertOrReplace(java.lang.Object entity,
                             int flags)

Asynchronous version of AbstractDao.insertOrReplace(Object).

insertOrReplaceInTx

public <E> AsyncOperation insertOrReplaceInTx(java.lang.Class<E> entityClass,
                                     E... entities)

Asynchronous version of AbstractDao.insertOrReplaceInTx(Object...).

insertOrReplaceInTx

public <E> AsyncOperation insertOrReplaceInTx(java.lang.Class<E> entityClass,
                                     int flags,
                                     E... entities)

Asynchronous version of AbstractDao.insertOrReplaceInTx(Object...).

insertOrReplaceInTx

public <E> AsyncOperation insertOrReplaceInTx(java.lang.Class<E> entityClass,
                                     java.lang.Iterable<E> entities)

Asynchronous version of AbstractDao.insertOrReplaceInTx(Iterable).

insertOrReplaceInTx

public <E> AsyncOperation insertOrReplaceInTx(java.lang.Class<E> entityClass,
                                     java.lang.Iterable<E> entities,
                                     int flags)

Asynchronous version of AbstractDao.insertOrReplaceInTx(Iterable).

update

public AsyncOperation update(java.lang.Object entity)

Asynchronous version of AbstractDao.update(Object).

update

public AsyncOperation update(java.lang.Object entity,
                    int flags)

Asynchronous version of AbstractDao.update(Object).

updateInTx

public <E> AsyncOperation updateInTx(java.lang.Class<E> entityClass,
                            E... entities)

Asynchronous version of AbstractDao.updateInTx(Object...).

updateInTx

public <E> AsyncOperation updateInTx(java.lang.Class<E> entityClass,
                            int flags,
                            E... entities)

Asynchronous version of AbstractDao.updateInTx(Object...).

updateInTx

public <E> AsyncOperation updateInTx(java.lang.Class<E> entityClass,
                            java.lang.Iterable<E> entities)

Asynchronous version of AbstractDao.updateInTx(Iterable).

updateInTx

public <E> AsyncOperation updateInTx(java.lang.Class<E> entityClass,
                            java.lang.Iterable<E> entities,
                            int flags)

Asynchronous version of AbstractDao.updateInTx(Iterable).

delete

public AsyncOperation delete(java.lang.Object entity)

Asynchronous version of AbstractDao.delete(Object).

delete

public AsyncOperation delete(java.lang.Object entity,
                    int flags)

Asynchronous version of AbstractDao.delete(Object).

deleteByKey

public AsyncOperation deleteByKey(java.lang.Object key)

Asynchronous version of AbstractDao.deleteByKey(Object).

deleteByKey

public AsyncOperation deleteByKey(java.lang.Object key,
                         int flags)

Asynchronous version of AbstractDao.deleteByKey(Object).

deleteInTx

public <E> AsyncOperation deleteInTx(java.lang.Class<E> entityClass,
                            E... entities)

Asynchronous version of AbstractDao.deleteInTx(Object...).

deleteInTx

public <E> AsyncOperation deleteInTx(java.lang.Class<E> entityClass,
                            int flags,
                            E... entities)

Asynchronous version of AbstractDao.deleteInTx(Object...).

deleteInTx

public <E> AsyncOperation deleteInTx(java.lang.Class<E> entityClass,
                            java.lang.Iterable<E> entities)

Asynchronous version of AbstractDao.deleteInTx(Iterable).

deleteInTx

public <E> AsyncOperation deleteInTx(java.lang.Class<E> entityClass,
                            java.lang.Iterable<E> entities,
                            int flags)

Asynchronous version of AbstractDao.deleteInTx(Iterable).

deleteAll

public <E> AsyncOperation deleteAll(java.lang.Class<E> entityClass)

Asynchronous version of AbstractDao.deleteAll().

deleteAll

public <E> AsyncOperation deleteAll(java.lang.Class<E> entityClass,
                           int flags)

Asynchronous version of AbstractDao.deleteAll().

runInTx

public AsyncOperation runInTx(java.lang.Runnable runnable)

Asynchronous version of AbstractDaoSession.runInTx(Runnable).

runInTx

public AsyncOperation runInTx(java.lang.Runnable runnable,
                     int flags)

Asynchronous version of AbstractDaoSession.runInTx(Runnable).

callInTx

public AsyncOperation callInTx(java.util.concurrent.Callable<?> callable)

Asynchronous version of AbstractDaoSession.callInTx(Callable).

callInTx

public AsyncOperation callInTx(java.util.concurrent.Callable<?> callable,
                      int flags)

Asynchronous version of AbstractDaoSession.callInTx(Callable).

queryList

public AsyncOperation queryList(Query<?> query)

Asynchronous version of Query.list().

queryList

public AsyncOperation queryList(Query<?> query,
                       int flags)

Asynchronous version of Query.list().

queryUnique

public AsyncOperation queryUnique(Query<?> query)

Asynchronous version of Query.unique().

queryUnique

public AsyncOperation queryUnique(Query<?> query,
                         int flags)

Asynchronous version of Query.unique().

load

public AsyncOperation load(java.lang.Class<?> entityClass,
                  java.lang.Object key)

Asynchronous version of AbstractDao.load(Object).

load

public AsyncOperation load(java.lang.Class<?> entityClass,
                  java.lang.Object key,
                  int flags)

Asynchronous version of AbstractDao.load(Object).

loadAll

public AsyncOperation loadAll(java.lang.Class<?> entityClass)

Asynchronous version of AbstractDao.loadAll().

loadAll

public AsyncOperation loadAll(java.lang.Class<?> entityClass,
                     int flags)

Asynchronous version of AbstractDao.loadAll().

count

public AsyncOperation count(java.lang.Class<?> entityClass)

Asynchronous version of AbstractDao.count().

count

public AsyncOperation count(java.lang.Class<?> entityClass,
                   int flags)

Asynchronous version of AbstractDao.count().

refresh

public AsyncOperation refresh(java.lang.Object entity)

Asynchronous version of AbstractDao.refresh(Object).

refresh

public AsyncOperation refresh(java.lang.Object entity,
                     int flags)

Asynchronous version of AbstractDao.refresh(Object).

getSessionFlags

public int getSessionFlags()

AsyncOperation flags set for all operations (will be ORed with call flags).

setSessionFlags

public void setSessionFlags(int sessionFlags)

AsyncOperation flags set for all operations (will be ORed with call flags).