Package 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:

Serializable

Direct Known Subclasses:

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

public class AppianRuntimeException
extends 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	Description
	AppianRuntimeException(AppianException delegate)
	AppianRuntimeException(ErrorCode errorCode, Object... errorCodeArgs)	Constructs a new exception with the specified error code.
protected	AppianRuntimeException(Throwable cause, AppianException delegate)
	AppianRuntimeException(Throwable cause, ErrorCode errorCode, Object... errorCodeArgs)	Constructs a new exception with the specified cause and error code.

Method Summary

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

AppianRuntimeException

public AppianRuntimeException(ErrorCode errorCode,
 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(Throwable cause,
 ErrorCode errorCode,
 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(Throwable cause,
 AppianException delegate)

AppianRuntimeException

public AppianRuntimeException(AppianException delegate)

Method Details

toAppianException

public AppianException toAppianException()

isDelegateInstanceOf

public boolean isDelegateInstanceOf(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 Object[] getErrorCodeArguments()

See AppianException.getErrorCodeArguments()

getErrorCodeArguments

protected Object[] getErrorCodeArguments(Locale locale)

See AppianException.getErrorCodeArguments(Locale)

getMessage

public String getMessage()

See AppianException.getMessage()

Overrides:

getMessage in class Throwable

getLocalizedMessage

public String getLocalizedMessage()

See AppianException.getLocalizedMessage()

Overrides:

getLocalizedMessage in class Throwable

getLocalizedMessage

public String getLocalizedMessage(Locale locale)

See AppianException.getLocalizedMessage(Locale)

getLocalizedTitle

public String getLocalizedTitle(Locale locale)

See AppianException.getLocalizedTitle(Locale)

getLocalizedMessageWithErrorCode

public String getLocalizedMessageWithErrorCode(Locale locale)

See AppianException.getLocalizedMessageWithErrorCode(Locale)

toString

public String toString()

See AppianException.toString()

Overrides:

toString in class Throwable

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

getCause

public Throwable getCause()

Overrides:

getCause in class Throwable

hashCode

public int hashCode()

Overrides:

hashCode in class Object

initCause

public Throwable initCause(Throwable cause)

Overrides:

initCause in class Throwable

printStackTrace

public void printStackTrace()

Overrides:

printStackTrace in class Throwable

printStackTrace

public void printStackTrace(PrintStream s)

Overrides:

printStackTrace in class Throwable

printStackTrace

public void printStackTrace(PrintWriter s)

Overrides:

printStackTrace in class Throwable

getStackTrace

public StackTraceElement[] getStackTrace()

Overrides:

getStackTrace in class Throwable

setStackTrace

public void setStackTrace(StackTraceElement[] stackTrace)

Overrides:

setStackTrace in class Throwable

getErrorCodeArgumentsAsStringArray

public String[] getErrorCodeArgumentsAsStringArray(Locale locale)