jetbrains.exodus.entitystore

Interface QueryCancellingPolicy

public interface QueryCancellingPolicy

Use StoreTransaction.setQueryCancellingPolicy(QueryCancellingPolicy) to set an instance of QueryCancellingPolicy to be able to interrupt iteration over EntityIterable instances associated with the StoreTransaction. The most common use case is setting timeout for the StoreTransaction instance.

PersistentEntityStore implementation tries to to check QueryCancellingPolicy in a most smart way in order to affect execution performance as little as possible.

See Also:

StoreTransaction, StoreTransaction.setQueryCancellingPolicy(QueryCancellingPolicy), EntityIterable, EntityIterable.getTransaction()

Field Summary

Fields

Modifier and Type	Field and Description
static QueryCancellingPolicy	NONE

Method Summary

Modifier and Type	Method and Description
static void	cancelIfNecessary(@Nullable QueryCancellingPolicy policy)
void	doCancel() Cancels iteration over EntityIterable instances which were created in the StoreTransaction supplied with the QueryCancellingPolicy instance.
boolean	needToCancel()

Field Detail

NONE

static final QueryCancellingPolicy NONE

Method Detail

needToCancel

boolean needToCancel()

Returns:

true when it's time to cancel iteration over EntityIterable instances which were created in the StoreTransaction supplied with the QueryCancellingPolicy instance

doCancel

void doCancel()

Cancels iteration over EntityIterable instances which were created in the StoreTransaction supplied with the QueryCancellingPolicy instance. Usually it throws an exception which application code can handle.

cancelIfNecessary

static void cancelIfNecessary(@Nullable
                              @Nullable QueryCancellingPolicy policy)