zipkin2

Class CheckResult

java.lang.Object

zipkin2.CheckResult

public final class CheckResult
extends Object

Answers the question: Are operations on this component likely to succeed?

Implementations should initialize the component if necessary. It should test a remote connection, or consult a trusted source to derive the result. They should use least resources possible to establish a meaningful result, and be safe to call many times, even concurrently.

See Also:

OK

Field Summary

Fields

Modifier and Type	Field and Description
static CheckResult	OK

Method Summary

Modifier and Type	Method and Description
Throwable	error() Present when not ok
static CheckResult	failed(Throwable error)
boolean	ok()
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

OK

public static final CheckResult OK

Method Detail

failed

public static CheckResult failed(Throwable error)

ok

public boolean ok()

error

@Nullable
public Throwable error()

Present when not ok

toString

public String toString()

Overrides:

toString in class Object