org.spf4j.base

Interface ExecutionContext

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

BasicExecutionContext

@CleanupObligation
 @ParametersAreNonnullByDefault
public interface ExecutionContext
extends AutoCloseable

Author:

Zoltan Farkas

Method Summary

Modifier and Type	Method and Description
void	close()
<K,V> V	compute(K key, BiFunction<K,V,V> compute) Compute context associated data.
Object	get(Object key) Method to get context associated data.
default <T> T	get(Object key, Class<T> clasz) Method to get context associated data.
long	getDeadlineNanos()
default long	getMillisToDeadline()
String	getName()
ExecutionContext	getParent()
default int	getSecondsToDeadline()
long	getStartTimeNanos()
default long	getTimeRelativeToDeadline(TimeUnit unit)
default long	getTimeToDeadline(TimeUnit unit)
default long	getUncheckedTimeToDeadline(TimeUnit unit)
<T> T	put(Object key, T data) Method to put context associated data.
default <T> T	putToRoot(Object key, T data) Method to put context associated data to the root context.

Method Detail

close

@DischargesObligation
void close()

Specified by:

close in interface AutoCloseable

getName

@Nonnull
String getName()

getStartTimeNanos

long getStartTimeNanos()

getDeadlineNanos

long getDeadlineNanos()

getParent

@Nullable
ExecutionContext getParent()

getTimeToDeadline

@Nonnegative
default long getTimeToDeadline(TimeUnit unit)
                                     throws TimeoutException

Throws:

TimeoutException

getUncheckedTimeToDeadline

@Nonnegative
default long getUncheckedTimeToDeadline(TimeUnit unit)

getTimeRelativeToDeadline

@Signed
default long getTimeRelativeToDeadline(TimeUnit unit)

getMillisToDeadline

@Nonnegative
default long getMillisToDeadline()
                                       throws TimeoutException

Throws:

TimeoutException

getSecondsToDeadline

@Nonnegative
default int getSecondsToDeadline()
                                       throws TimeoutException

Throws:

TimeoutException

get

@Nullable
 @Beta
default <T> T get(Object key,
                                   Class<T> clasz)

Method to get context associated data. if current context does not have baggage, the parent context is queried.

Type Parameters:

T - type of baggage.

Parameters:

key - key of baggage.

clasz - class of baggage value.

Returns:

the baggage

get

@Nullable
 @Beta
Object get(Object key)

Method to get context associated data. if current context does not have baggage, the parent context is queried.

Type Parameters:

T - type of data.

Parameters:

key - key of data.

Returns:

the data

put

@Nullable
 @Beta
<T> T put(Object key,
                           T data)

Method to put context associated data.

Type Parameters:

T - type of data.

Parameters:

key - the key of data.

data - the data.

Returns:

existing data if there.

putToRoot

@Nullable
 @Beta
default <T> T putToRoot(Object key,
                                         T data)

Method to put context associated data to the root context.

Type Parameters:

T - type of data.

Parameters:

key - the key of data.

data - the data.

Returns:

existing data if there.

compute

@Beta
 @Nullable
<K,V> V compute(K key,
                                 BiFunction<K,V,V> compute)

Compute context associated data.

Type Parameters:

K -

V -

Parameters:

key -

compute -

Returns: