org.apache.ratis.util

Interface JavaUtils

public interface JavaUtils

General Java utility methods.

Field Summary

Fields

Modifier and Type	Field and Description
static ConcurrentMap<Class<?>,String>	CLASS_SIMPLE_NAMES
static CompletableFuture[]	EMPTY_COMPLETABLE_FUTURE_ARRAY
static org.slf4j.Logger	LOG
static Supplier<ThreadGroup>	ROOT_THREAD_GROUP

Method Summary

Modifier and Type	Method and Description
static <T> CompletableFuture<Void>	allOf(Collection<CompletableFuture<T>> futures)
static <V> BiConsumer<V,Throwable>	asBiConsumer(CompletableFuture<V> future)
static <THROWABLE extends Throwable> void	attempt(CheckedRunnable<THROWABLE> runnable, int numAttempts, TimeDuration sleepTime, String name, org.slf4j.Logger log) Attempt to run the given op multiple times.
static <RETURN,THROWABLE extends Throwable> RETURN	attempt(CheckedSupplier<RETURN,THROWABLE> supplier, int numAttempts, TimeDuration sleepTime, Supplier<?> name, org.slf4j.Logger log) Attempt to get a return value from the given supplier multiple times.
static <RETURN,THROWABLE extends Throwable> RETURN	attemptRepeatedly(CheckedSupplier<RETURN,THROWABLE> supplier, int numAttempts, TimeDuration sleepTime, String name, org.slf4j.Logger log) Attempt to get a return value from the given supplier multiple times.
static void	attemptUntilTrue(BooleanSupplier condition, int numAttempts, TimeDuration sleepTime, String name, org.slf4j.Logger log) Attempt to wait the given condition to return true multiple times.
static <T> T	callAsUnchecked(Callable<T> callable) Invoke Callable.call() and, if there any, wrap the checked exception by RuntimeException.
static <OUTPUT,THROWABLE extends Throwable> OUTPUT	callAsUnchecked(CheckedSupplier<OUTPUT,THROWABLE> checkedSupplier, Function<THROWABLE,? extends RuntimeException> converter)
static <T> T	cast(Object obj)
static <T> T	cast(Object obj, Class<T> clazz) The same as Class.cast(Object) except that this method returns null (but not throw ClassCastException) if the given object is not an instance of the given class.
static <E> CompletableFuture<E>	completeExceptionally(Throwable t)
static String	date()
static void	dumpAllThreads(Consumer<String> println)
static StackTraceElement	getCallerStackTraceElement()
static String	getClassSimpleName(Class<?> clazz)
static StackTraceElement	getCurrentStackTraceElement()
static ThreadGroup	getRootThreadGroup()
static <T> MemoizedSupplier<T>	memoize(Supplier<T> initializer) Create a memoized supplier which gets a value by invoking the initializer once and then keeps returning the same value as its supplied results.
static <T extends Throwable> void	runAsUnchecked(CheckedRunnable<T> runnable)
static <THROWABLE extends Throwable> void	runAsUnchecked(CheckedRunnable<THROWABLE> runnable, Function<THROWABLE,? extends RuntimeException> converter)
static Timer	runRepeatedly(Runnable runnable, long delay, long period, TimeUnit unit)
static <OUTPUT,THROWABLE extends Throwable> OUTPUT	supplyAndWrapAsCompletionException(CheckedSupplier<OUTPUT,THROWABLE> supplier)
static Throwable	unwrapCompletionException(Throwable t)

Field Detail

LOG

static final org.slf4j.Logger LOG

EMPTY_COMPLETABLE_FUTURE_ARRAY

static final CompletableFuture[] EMPTY_COMPLETABLE_FUTURE_ARRAY

CLASS_SIMPLE_NAMES

static final ConcurrentMap<Class<?>,String> CLASS_SIMPLE_NAMES

ROOT_THREAD_GROUP

static final Supplier<ThreadGroup> ROOT_THREAD_GROUP

Method Detail

getClassSimpleName

static String getClassSimpleName(Class<?> clazz)

date

static String date()

cast

static <T> T cast(Object obj,
                  Class<T> clazz)

The same as Class.cast(Object) except that this method returns null (but not throw ClassCastException) if the given object is not an instance of the given class.

cast

static <T> T cast(Object obj)

getCallerStackTraceElement

static StackTraceElement getCallerStackTraceElement()

getCurrentStackTraceElement

static StackTraceElement getCurrentStackTraceElement()

runAsUnchecked

static <T extends Throwable> void runAsUnchecked(CheckedRunnable<T> runnable)

runAsUnchecked

static <THROWABLE extends Throwable> void runAsUnchecked(CheckedRunnable<THROWABLE> runnable,
                                                         Function<THROWABLE,? extends RuntimeException> converter)

callAsUnchecked

static <T> T callAsUnchecked(Callable<T> callable)

Invoke Callable.call() and, if there any, wrap the checked exception by RuntimeException.

callAsUnchecked

static <OUTPUT,THROWABLE extends Throwable> OUTPUT callAsUnchecked(CheckedSupplier<OUTPUT,THROWABLE> checkedSupplier,
                                                                   Function<THROWABLE,? extends RuntimeException> converter)

memoize

static <T> MemoizedSupplier<T> memoize(Supplier<T> initializer)

Create a memoized supplier which gets a value by invoking the initializer once and then keeps returning the same value as its supplied results.

Type Parameters:

T - The supplier result type.

Parameters:

initializer - to supply at most one non-null value.

Returns:

a memoized supplier which is thread-safe.

getRootThreadGroup

static ThreadGroup getRootThreadGroup()

attemptRepeatedly

static <RETURN,THROWABLE extends Throwable> RETURN attemptRepeatedly(CheckedSupplier<RETURN,THROWABLE> supplier,
                                                                     int numAttempts,
                                                                     TimeDuration sleepTime,
                                                                     String name,
                                                                     org.slf4j.Logger log)
                                                              throws THROWABLE extends Throwable,
                                                                     InterruptedException

Attempt to get a return value from the given supplier multiple times.

Throws:

THROWABLE extends Throwable

InterruptedException

attempt

static <RETURN,THROWABLE extends Throwable> RETURN attempt(CheckedSupplier<RETURN,THROWABLE> supplier,
                                                           int numAttempts,
                                                           TimeDuration sleepTime,
                                                           Supplier<?> name,
                                                           org.slf4j.Logger log)
                                                    throws THROWABLE extends Throwable,
                                                           InterruptedException

Attempt to get a return value from the given supplier multiple times.

Throws:

THROWABLE extends Throwable

InterruptedException

attempt

static <THROWABLE extends Throwable> void attempt(CheckedRunnable<THROWABLE> runnable,
                                                  int numAttempts,
                                                  TimeDuration sleepTime,
                                                  String name,
                                                  org.slf4j.Logger log)
                                           throws THROWABLE extends Throwable,
                                                  InterruptedException

Attempt to run the given op multiple times.

Throws:

THROWABLE extends Throwable

InterruptedException

attemptUntilTrue

static void attemptUntilTrue(BooleanSupplier condition,
                             int numAttempts,
                             TimeDuration sleepTime,
                             String name,
                             org.slf4j.Logger log)
                      throws InterruptedException

Attempt to wait the given condition to return true multiple times.

Throws:

InterruptedException

runRepeatedly

static Timer runRepeatedly(Runnable runnable,
                           long delay,
                           long period,
                           TimeUnit unit)

dumpAllThreads

static void dumpAllThreads(Consumer<String> println)

completeExceptionally

static <E> CompletableFuture<E> completeExceptionally(Throwable t)

unwrapCompletionException

static Throwable unwrapCompletionException(Throwable t)

allOf

static <T> CompletableFuture<Void> allOf(Collection<CompletableFuture<T>> futures)

asBiConsumer

static <V> BiConsumer<V,Throwable> asBiConsumer(CompletableFuture<V> future)

supplyAndWrapAsCompletionException

static <OUTPUT,THROWABLE extends Throwable> OUTPUT supplyAndWrapAsCompletionException(CheckedSupplier<OUTPUT,THROWABLE> supplier)