com.appiancorp.suiteapi.common.exceptions

Class AppianRuntimeException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

com.appiancorp.suiteapi.common.exceptions.AppianRuntimeException

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

AppianPrivilegeNotFoundException, DecryptionException, EncryptionException, InvalidRankNameException, InvalidTypeException, LocalizedAppianRuntimeException, NullUserRenameException, RetryableAppianRuntimeException, ToggledOffException

public class AppianRuntimeException
extends java.lang.RuntimeException

AppianRuntimeException is the base class of all application-level runtime exceptions thrown in the product. AppianRuntimeException takes care of properly formatting and internationalizing the exception messages by associating the exception with an error code. Subclasses should override the getErrorCode and getErrorCodeArguments methods to map the appropriate message to the exception. This class acts as a wrapper around an equivalent AppianException. Use toAppianException() to get the equivalent checked exception

See Also:

AppianException, Serialized Form

Constructor Summary

Constructors

Modifier	Constructor and Description
	AppianRuntimeException(AppianException delegate)
	AppianRuntimeException(ErrorCode errorCode, java.lang.Object... errorCodeArgs) Constructs a new exception with the specified error code.
protected	AppianRuntimeException(java.lang.Throwable cause, AppianException delegate)
	AppianRuntimeException(java.lang.Throwable cause, ErrorCode errorCode, java.lang.Object... errorCodeArgs) Constructs a new exception with the specified cause and error code.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.lang.Throwable	getCause()
ErrorCode	getErrorCode() See AppianException.getErrorCode()
java.lang.Object[]	getErrorCodeArguments() See AppianException.getErrorCodeArguments()
protected java.lang.Object[]	getErrorCodeArguments(java.util.Locale locale) See AppianException.getErrorCodeArguments(Locale)
java.lang.String[]	getErrorCodeArgumentsAsStringArray(java.util.Locale locale)
java.lang.String	getLocalizedMessage() See AppianException.getLocalizedMessage()
java.lang.String	getLocalizedMessage(java.util.Locale locale) See AppianException.getLocalizedMessage(Locale)
java.lang.String	getLocalizedMessageWithErrorCode(java.util.Locale locale) See AppianException.getLocalizedMessageWithErrorCode(Locale)
java.lang.String	getLocalizedTitle(java.util.Locale locale) See AppianException.getLocalizedTitle(Locale)
java.lang.String	getMessage() See AppianException.getMessage()
java.lang.StackTraceElement[]	getStackTrace()
int	hashCode()
java.lang.Throwable	initCause(java.lang.Throwable cause)
boolean	isDelegateInstanceOf(java.lang.Class<? extends AppianException> targetExceptionClass) Convenience method that returns whether the delegate AppianException is an instance of the given class.
void	printStackTrace()
void	printStackTrace(java.io.PrintStream s)
void	printStackTrace(java.io.PrintWriter s)
void	setStackTrace(java.lang.StackTraceElement[] stackTrace)
AppianException	toAppianException()
java.lang.String	toString() See AppianException.toString()

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getSuppressed

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

AppianRuntimeException

public AppianRuntimeException(ErrorCode errorCode,
                              java.lang.Object... errorCodeArgs)

Constructs a new exception with the specified error code.

Parameters:

errorCode - the error code

errorCodeArgs - the arguments to use for the error code message

AppianRuntimeException

public AppianRuntimeException(java.lang.Throwable cause,
                              ErrorCode errorCode,
                              java.lang.Object... errorCodeArgs)

Constructs a new exception with the specified cause and error code.

Parameters:

cause - the cause (which is saved for later retrieval by the getCause() method). (A null value is permitted, and indicates that the cause is nonexistent or unknown.)

errorCode - the error code

errorCodeArgs - the arguments to use for the error code message

AppianRuntimeException

protected AppianRuntimeException(java.lang.Throwable cause,
                                 AppianException delegate)

AppianRuntimeException

public AppianRuntimeException(AppianException delegate)

Method Detail

toAppianException

public AppianException toAppianException()

isDelegateInstanceOf

public boolean isDelegateInstanceOf(java.lang.Class<? extends AppianException> targetExceptionClass)

Convenience method that returns whether the delegate AppianException is an instance of the given class.

getErrorCode

public ErrorCode getErrorCode()

See AppianException.getErrorCode()

getErrorCodeArguments

public java.lang.Object[] getErrorCodeArguments()

See AppianException.getErrorCodeArguments()

getErrorCodeArguments

protected java.lang.Object[] getErrorCodeArguments(java.util.Locale locale)

See AppianException.getErrorCodeArguments(Locale)

getMessage

public java.lang.String getMessage()

See AppianException.getMessage()

Overrides:

getMessage in class java.lang.Throwable

getLocalizedMessage

public java.lang.String getLocalizedMessage()

See AppianException.getLocalizedMessage()

Overrides:

getLocalizedMessage in class java.lang.Throwable

getLocalizedMessage

public java.lang.String getLocalizedMessage(java.util.Locale locale)

See AppianException.getLocalizedMessage(Locale)

getLocalizedTitle

public java.lang.String getLocalizedTitle(java.util.Locale locale)

See AppianException.getLocalizedTitle(Locale)

getLocalizedMessageWithErrorCode

public java.lang.String getLocalizedMessageWithErrorCode(java.util.Locale locale)

See AppianException.getLocalizedMessageWithErrorCode(Locale)

toString

public java.lang.String toString()

See AppianException.toString()

Overrides:

toString in class java.lang.Throwable

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

getCause

public java.lang.Throwable getCause()

Overrides:

getCause in class java.lang.Throwable

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

initCause

public java.lang.Throwable initCause(java.lang.Throwable cause)

Overrides:

initCause in class java.lang.Throwable

printStackTrace

public void printStackTrace()

Overrides:

printStackTrace in class java.lang.Throwable

printStackTrace

public void printStackTrace(java.io.PrintStream s)

Overrides:

printStackTrace in class java.lang.Throwable

printStackTrace

public void printStackTrace(java.io.PrintWriter s)

Overrides:

printStackTrace in class java.lang.Throwable

getStackTrace

public java.lang.StackTraceElement[] getStackTrace()

Overrides:

getStackTrace in class java.lang.Throwable

setStackTrace

public void setStackTrace(java.lang.StackTraceElement[] stackTrace)

Overrides:

setStackTrace in class java.lang.Throwable

getErrorCodeArgumentsAsStringArray

public java.lang.String[] getErrorCodeArgumentsAsStringArray(java.util.Locale locale)