Package com.appiancorp.exceptions
Class AppianError
java.lang.Object
com.appiancorp.exceptions.AppianError
- All Implemented Interfaces:
Serializable
- Direct Known Subclasses:
AppianResponseError
This class holds information about an error. The text held in this class is expected to be
localized.
- See Also:
-
Nested Class Summary
-
Field Summary
Modifier and TypeFieldDescriptionprotected AppianError
static final String
protected String
static final String
protected Object
static final String
protected String
static final String
static final String
static final String
protected String
static final String
protected String
static final QName
protected String
static final String
-
Constructor Summary
ModifierConstructorDescriptionprotected
AppianError
(String code, String title, String message, String details, AppianError cause) -
Method Summary
Modifier and TypeMethodDescriptionstatic <T extends Iterable<AppianError>>
TcollapseToNull
(T errors) If the given collection isnull
, or empty, or contains onlynull
items, returnsnull
.static com.google.common.base.Equivalence<AppianError>
Returns anEquivalence
that compares all fields ofAppianError
.getCause()
Returns the lower-level error that caused this error.getCode()
Returns the unique code identifying the error.getData()
Returns any further data required to successfully process the error.Returns detailed information about the error (for example, metadata such as ids/uuids).Returns the error message suitable for end users.Returns theerror message
concatenated with theerror code
.Returns the original error message and error code if the exception was wrapped.getTitle()
Returns the error title.toString()
-
Field Details
-
LOCAL_PART
- See Also:
-
QNAME
-
CODE
- See Also:
-
TITLE
- See Also:
-
MESSAGE
- See Also:
-
DETAILS
- See Also:
-
ERROR_ORIGINAL_MESSAGE_WITH_ERROR_CODE
- See Also:
-
CAUSE
- See Also:
-
DATA
- See Also:
-
code
-
title
-
message
-
details
-
cause
-
data
-
originalMessageWithErrorCode
-
-
Constructor Details
-
AppianError
protected AppianError() -
AppianError
-
-
Method Details
-
getCode
Returns the unique code identifying the error. -
getTitle
Returns the error title. -
getMessage
Returns the error message suitable for end users. -
getDetails
Returns detailed information about the error (for example, metadata such as ids/uuids). This information is meant for designers or administrators. -
getCause
Returns the lower-level error that caused this error. Returnsnull
if this error is the root error. -
getMessageWithCode
Returns theerror message
concatenated with theerror code
. -
getData
Returns any further data required to successfully process the error. -
getOriginalMessageWithErrorCode
Returns the original error message and error code if the exception was wrapped. -
toString
-
collapseToNull
If the given collection isnull
, or empty, or contains onlynull
items, returnsnull
. Otherwise, returns the original collection unchanged. -
equalDataCheck
Returns anEquivalence
that compares all fields ofAppianError
.
-