Package ch.tocco.nice2.persist.core.api.exec

Class Keys

java.lang.Object

ch.tocco.nice2.persist.core.api.exec.Keys

public final class Keys
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	Keys.Cancel

Field Summary

Fields

Modifier and Type	Field	Description
static final Mode.Key<Callable<Keys.Cancel>>	CANCELLATION	Provide a cancellation function that is used in tasks that are combined with loops.
static final Mode.Key<CollectMode>	COLLECTMODE	When executing looping tasks (such as `expandTask()` for example), specify whether the results should be collected.
static final Mode.Key<String>	L10N_CONTEXT
static final Mode.Key<Locale>	L10N_LOCALE
static final Mode.Key<Boolean>	NEW_CONTEXT	Create a new context for the task to be processed.
static final Mode.Key<Integer>	OUTDATED_MAX_RETRIES	Set max retries when OutdatedException occurs.
static final Mode.Key<Double>	RATE_LIMITATION	Limit rate for looping tasks.
static final Mode.Key<Boolean>	SETUP_EXECUTION_CONTEXT	In some (rare) situations the ExecutionContext is not setup.

Method Summary

Modifier and Type	Method	Description
static <E extends Exception> Mode.Key<ExceptionMapper<E>>	exceptionMapper(Class<E> type)

Methods inherited from class java.lang.Object

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

Field Details

SETUP_EXECUTION_CONTEXT

public static final Mode.Key<Boolean> SETUP_EXECUTION_CONTEXT

In some (rare) situations the ExecutionContext is not setup. The persist layer does not work without. This mode installs a new context and removes it after task execution.

L10N_CONTEXT

public static final Mode.Key<String> L10N_CONTEXT

L10N_LOCALE

public static final Mode.Key<Locale> L10N_LOCALE

COLLECTMODE

public static final Mode.Key<CollectMode> COLLECTMODE

When executing looping tasks (such as `expandTask()` for example), specify whether the results should be collected.

RATE_LIMITATION

public static final Mode.Key<Double> RATE_LIMITATION

Limit rate for looping tasks. The provided double number is equivalent to "permits per second".

CANCELLATION

public static final Mode.Key<Callable<Keys.Cancel>> CANCELLATION

Provide a cancellation function that is used in tasks that are combined with loops. The loop either throws an exception (Keys.Cancel.ERROR) or simply terminates (Keys.Cancel.STOP) depending on the result of the cancellation function. In case of Keys.Cancel.ERROR an CancellationException is thrown. The callable is expected to return a value and not throw. If it throws regardless, the exception is propagated.

OUTDATED_MAX_RETRIES

public static final Mode.Key<Integer> OUTDATED_MAX_RETRIES

Set max retries when OutdatedException occurs. Default is 0 retries.

NEW_CONTEXT

public static final Mode.Key<Boolean> NEW_CONTEXT

Create a new context for the task to be processed.

Method Details

exceptionMapper

public static <E extends Exception>
Mode.Key<ExceptionMapper<E>> exceptionMapper(Class<E> type)