public class Status
extends java.lang.Object
Modifier and Type | Field and Description |
---|---|
static Status |
OK
The status indicating that the operation went fine.
|
Modifier and Type | Method and Description |
---|---|
static Status |
createError() |
static Status |
createError(boolean retriable)
Create an error.
|
static Status |
createError(boolean retriable,
java.lang.String message) |
static Status |
createError(java.lang.String message) |
static Status |
createError(java.lang.String messageTemplate,
java.lang.Object... args) |
static Status |
createRetriableError() |
static Status |
createRetriableError(java.lang.String message) |
static Status |
createRetriableError(java.lang.String messageTemplate,
java.lang.Object... args) |
boolean |
equals(java.lang.Object obj) |
StatusFlag |
getFlag() |
int |
hashCode() |
boolean |
isError() |
boolean |
isNonRetriableError() |
boolean |
isOK() |
boolean |
isRetriableError() |
java.lang.String |
toString() |
java.lang.String |
tryGetErrorMessage() |
public static final Status OK
public static Status createError(boolean retriable)
retriable
- If true
, the error will be marked 'retriable'.public static Status createError(boolean retriable, java.lang.String message)
public static Status createError()
public static Status createError(java.lang.String message)
public static Status createError(java.lang.String messageTemplate, java.lang.Object... args)
public static Status createRetriableError()
public static Status createRetriableError(java.lang.String message)
public static Status createRetriableError(java.lang.String messageTemplate, java.lang.Object... args)
public StatusFlag getFlag()
public final boolean isOK()
true
if this status represents an OK status.public final boolean isError()
true
if this status represents an error.public final boolean isRetriableError()
true
if this status represents an error where it makes sense to retry
the operation.public final boolean isNonRetriableError()
true
if this status represents an error where it does not make sense to
retry the operation.public java.lang.String tryGetErrorMessage()
getFlag() != OK
(can be empty), or
null
otherwise.public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
public java.lang.String toString()
toString
in class java.lang.Object