Package io.opentelemetry.sdk.common

Class CompletableResultCode

java.lang.Object

io.opentelemetry.sdk.common.CompletableResultCode

public final class CompletableResultCode
extends Object

This class models JDK 8's CompletableFuture to afford migration should Open Telemetry's SDK select JDK 8 or greater as a baseline, and also to offer familiarity to developers.

The implementation of Export operations are often asynchronous in nature, hence the need to convey a result at a later time. CompletableResultCode facilitates this.

Constructor Summary

Constructors

Constructor	Description
CompletableResultCode()

Method Summary

Modifier and Type	Method	Description
CompletableResultCode	fail()	Complete this CompletableResultCode unsuccessfully if it is not already completed, setting the failure throwable to null.
CompletableResultCode	failExceptionally(Throwable throwable)	Completes this CompletableResultCode unsuccessfully if it is not already completed, setting the failure throwable to throwable.
Throwable	getFailureThrowable()	Returns Throwable if this CompletableResultCode was failed exceptionally.
boolean	isDone()	Returns whether this CompletableResultCode has completed.
boolean	isSuccess()	Obtain the current state of completion.
CompletableResultCode	join(long timeout, TimeUnit unit)	Waits up to the specified amount of time for this CompletableResultCode to complete.
static CompletableResultCode	ofAll(Collection<CompletableResultCode> codes)	Returns a CompletableResultCode that completes after all the provided CompletableResultCodes complete.
static CompletableResultCode	ofExceptionalFailure(Throwable throwable)	Returns a CompletableResultCode that has been failed exceptionally.
static CompletableResultCode	ofFailure()	Returns a CompletableResultCode that has been completed unsuccessfully.
static CompletableResultCode	ofSuccess()	Returns a CompletableResultCode that has been completed successfully.
CompletableResultCode	succeed()	Complete this CompletableResultCode successfully if it is not already completed.
CompletableResultCode	whenComplete(Runnable action)	Perform an action on completion.

Methods inherited from class java.lang.Object

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

Constructor Details

CompletableResultCode

public CompletableResultCode()

Method Details

ofSuccess

public static CompletableResultCode ofSuccess()

Returns a CompletableResultCode that has been completed successfully.

ofFailure

public static CompletableResultCode ofFailure()

Returns a CompletableResultCode that has been completed unsuccessfully.

ofExceptionalFailure

public static CompletableResultCode ofExceptionalFailure(Throwable throwable)

Returns a CompletableResultCode that has been failed exceptionally.

Since:

1.41.0

ofAll

public static CompletableResultCode ofAll(Collection<CompletableResultCode> codes)

Returns a CompletableResultCode that completes after all the provided CompletableResultCodes complete. If any of the results fail, the result will be failed. If any failed exceptionally, the result will be failed exceptionally with the first Throwable from codes.

succeed

public CompletableResultCode succeed()

Complete this CompletableResultCode successfully if it is not already completed.

fail

public CompletableResultCode fail()

Complete this CompletableResultCode unsuccessfully if it is not already completed, setting the failure throwable to null.

failExceptionally

public CompletableResultCode failExceptionally(@Nullable
 Throwable throwable)

Completes this CompletableResultCode unsuccessfully if it is not already completed, setting the failure throwable to throwable.

Parameters:

throwable - the Throwable that caused the failure, or null

Since:

1.41.0

isSuccess

public boolean isSuccess()

Obtain the current state of completion. Generally call once completion is achieved via the whenComplete(Runnable) method.

Returns:

the current state of completion

getFailureThrowable

@Nullable
public Throwable getFailureThrowable()

Returns Throwable if this CompletableResultCode was failed exceptionally. Generally call once completion is achieved via the whenComplete(Runnable) method.

Returns:

the throwable if failed exceptionally, or null if: failed without exception, succeeded, failExceptionally(Throwable) with a null throwable, or not complete.

Since:

1.41.0

whenComplete

public CompletableResultCode whenComplete(Runnable action)

Perform an action on completion. Actions are guaranteed to be called only once.

Parameters:

action - the action to perform

Returns:

this completable result so that it may be further composed

isDone

public boolean isDone()

Returns whether this CompletableResultCode has completed.

join

public CompletableResultCode join(long timeout,
 TimeUnit unit)

Waits up to the specified amount of time for this CompletableResultCode to complete. Even after this method returns, the result may not be complete yet - you should always check isSuccess() or isDone() after calling this method to determine the result.

Returns:

this CompletableResultCode