com.atlassian.vcache

Class VCacheUtils

java.lang.Object

com.atlassian.vcache.VCacheUtils

@ExperimentalApi
public class VCacheUtils
extends java.lang.Object

Provides a helper utilities.

Since:

1.0

Constructor Summary

Constructors

Constructor and Description
VCacheUtils()

Method Summary

Modifier and Type	Method and Description
static <T,R> R	fold(java.util.concurrent.CompletionStage<T> stage, java.util.function.BiFunction<T,java.lang.Throwable,R> fn) Syntactic sugar for writing stage.handle(fn).toCompletableFuture().unsafeJoin().
static <T,R> R	fold(java.util.concurrent.CompletionStage<T> stage, java.util.function.Function<T,R> success, java.util.function.Function<java.lang.Throwable,R> failure) Syntactic sugar for handling the result (either success or failure) from a CompletionStage.
static <V> V	join(java.util.concurrent.CompletionStage<V> stage) Deprecated. since 1.5.0 - use unsafeJoin(CompletionStage) instead (if you must).
static <V> V	unsafeJoin(java.util.concurrent.CompletionStage<V> stage) Syntactic sugar for writing stage.toCompletableFuture().unsafeJoin().

Methods inherited from class java.lang.Object

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

Constructor Detail

VCacheUtils

public VCacheUtils()

Method Detail

join

@Deprecated
public static <V> V join(java.util.concurrent.CompletionStage<V> stage)

Deprecated. since 1.5.0 - use unsafeJoin(CompletionStage) instead (if you must).

Syntactic sugar for writing stage.toCompletableFuture().unsafeJoin(). This method should not be used in production code, as it should be resilient to cache failures.

Type Parameters:

V - the value type

Parameters:

stage - the stage to call CompletableFuture.join() on

Returns:

the result of joining.

See Also:

CompletableFuture.join(), unsafeJoin(CompletionStage)

unsafeJoin

public static <V> V unsafeJoin(java.util.concurrent.CompletionStage<V> stage)

Syntactic sugar for writing stage.toCompletableFuture().unsafeJoin(). This method should not be used in production code, as it should be resilient to cache failures. This method will throw runtime exceptions if errors occur.

Type Parameters:

V - the value type

Parameters:

stage - the stage to call CompletableFuture.join() on

Returns:

the result of joining.

See Also:

CompletableFuture.join()

fold

public static <T,R> R fold(java.util.concurrent.CompletionStage<T> stage,
                           java.util.function.Function<T,R> success,
                           java.util.function.Function<java.lang.Throwable,R> failure)

Syntactic sugar for handling the result (either success or failure) from a CompletionStage.

Type Parameters:

T - the type returned by the stage

R - the type to be returned

Parameters:

stage - the stage to handle the results

success - called if the stage returned a successful result

failure - called if the stage failed

Returns:

if the stage is successful, then the result of calling success, otherwise the result of calling failure

fold

public static <T,R> R fold(java.util.concurrent.CompletionStage<T> stage,
                           java.util.function.BiFunction<T,java.lang.Throwable,R> fn)

Syntactic sugar for writing stage.handle(fn).toCompletableFuture().unsafeJoin().

Type Parameters:

T - the type returned by the stage

R - the type to be returned

Parameters:

stage - the stage to handle the results

fn - called to handle the result

Returns:

the result of calling fn on the stage outcome.