Package com.appiancorp.exceptions

Class AppianError

java.lang.Object

com.appiancorp.exceptions.AppianError

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

AppianResponseError

@GwtCompatible
public class AppianError
extends Object
implements Serializable

This class holds information about an error. The text held in this class is expected to be localized.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AppianError.Builder	A builder to create instances of AppianError.

Field Summary

Fields

Modifier and Type	Field	Description
protected AppianError	cause
static final String	CAUSE
protected String	code
static final String	CODE
protected Object	data
static final String	DATA
protected String	details
static final String	DETAILS
static final String	ERROR_ORIGINAL_MESSAGE_WITH_ERROR_CODE
static final String	LOCAL_PART
protected String	message
static final String	MESSAGE
protected String	originalMessageWithErrorCode
static final QName	QNAME
protected String	title
static final String	TITLE

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AppianError()
	AppianError(String code, String title, String message, String details, AppianError cause)

Method Summary

Modifier and Type	Method	Description
static <T extends Iterable<AppianError>> T	collapseToNull(T errors)	If the given collection is null, or empty, or contains only null items, returns null.
static com.google.common.base.Equivalence<AppianError>	equalDataCheck()	Returns an Equivalence that compares all fields of AppianError.
AppianError	getCause()	Returns the lower-level error that caused this error.
String	getCode()	Returns the unique code identifying the error.
Object	getData()	Returns any further data required to successfully process the error.
String	getDetails()	Returns detailed information about the error (for example, metadata such as ids/uuids).
String	getMessage()	Returns the error message suitable for end users.
String	getMessageWithCode()	Returns the error message concatenated with the error code.
String	getOriginalMessageWithErrorCode()	Returns the original error message and error code if the exception was wrapped.
String	getTitle()	Returns the error title.
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

LOCAL_PART

public static final String LOCAL_PART

See Also:

• Constant Field Values

QNAME

public static final QName QNAME

CODE

public static final String CODE

See Also:

• Constant Field Values

TITLE

public static final String TITLE

See Also:

• Constant Field Values

MESSAGE

public static final String MESSAGE

See Also:

• Constant Field Values

DETAILS

public static final String DETAILS

See Also:

• Constant Field Values

ERROR_ORIGINAL_MESSAGE_WITH_ERROR_CODE

public static final String ERROR_ORIGINAL_MESSAGE_WITH_ERROR_CODE

See Also:

• Constant Field Values

CAUSE

public static final String CAUSE

See Also:

• Constant Field Values

DATA

public static final String DATA

See Also:

• Constant Field Values

code

protected String code

title

protected String title

message

protected String message

details

protected String details

cause

protected AppianError cause

data

protected Object data

originalMessageWithErrorCode

protected String originalMessageWithErrorCode

Constructor Details

AppianError

protected AppianError()

AppianError

public AppianError(String code,
 String title,
 String message,
 String details,
 AppianError cause)

Method Details

getCode

public String getCode()

Returns the unique code identifying the error.

getTitle

public String getTitle()

Returns the error title.

getMessage

public String getMessage()

Returns the error message suitable for end users.

getDetails

public String getDetails()

Returns detailed information about the error (for example, metadata such as ids/uuids). This information is meant for designers or administrators.

getCause

public AppianError getCause()

Returns the lower-level error that caused this error. Returns null if this error is the root error.

getMessageWithCode

public String getMessageWithCode()

Returns the error message concatenated with the error code.

getData

public Object getData()

Returns any further data required to successfully process the error.

getOriginalMessageWithErrorCode

public String getOriginalMessageWithErrorCode()

Returns the original error message and error code if the exception was wrapped.

toString

public String toString()

Overrides:

toString in class Object

collapseToNull

public static <T extends Iterable<AppianError>> T collapseToNull(T errors)

If the given collection is null, or empty, or contains only null items, returns null. Otherwise, returns the original collection unchanged.

equalDataCheck

public static com.google.common.base.Equivalence<AppianError> equalDataCheck()

Returns an Equivalence that compares all fields of AppianError.