com.appiancorp.exceptions

Class AppianErrorBuilder

java.lang.Object

com.appiancorp.exceptions.AppianErrorBuilder

public class AppianErrorBuilder
extends java.lang.Object

Builds localized AppianError objects using Appian error codes.

Constructor Summary

Constructors

Constructor and Description
AppianErrorBuilder(AppianErrorCodeFormatter formatter, ErrorCode code, java.lang.Object... args)
AppianErrorBuilder(ErrorCode code, java.lang.String message)
AppianErrorBuilder(ErrorCode code, java.lang.String message, java.lang.String title)
AppianErrorBuilder(java.util.Locale targetLocale, ErrorCode code, java.lang.Object... args)

Method Summary

Modifier and Type	Method and Description
AppianError	build()
static com.google.common.base.Function<java.lang.Throwable,AppianError>	fromThrowable(java.util.Locale targetLocale) Returns a function to create AppianErrors from exceptions.
static AppianError	fromThrowable(java.util.Locale targetLocale, java.lang.Throwable t) Creates an AppianError from the given exception, by applying the function generated by fromThrowable(Locale).
static AppianError	fromThrowable(java.util.Locale targetLocale, java.lang.Throwable t, ErrorCode defaultError) Creates an AppianError from the given exception, by applying the function generated by fromThrowable(Locale).
AppianErrorBuilder	setCause(AppianErrorBuilder causeBuilder)
AppianErrorBuilder	setDetails(java.lang.String details)
AppianErrorBuilder	setTitle(java.lang.String title)

Methods inherited from class java.lang.Object

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

Constructor Detail

AppianErrorBuilder

public AppianErrorBuilder(java.util.Locale targetLocale,
                          ErrorCode code,
                          java.lang.Object... args)

AppianErrorBuilder

public AppianErrorBuilder(AppianErrorCodeFormatter formatter,
                          ErrorCode code,
                          java.lang.Object... args)

AppianErrorBuilder

public AppianErrorBuilder(ErrorCode code,
                          java.lang.String message)

AppianErrorBuilder

public AppianErrorBuilder(ErrorCode code,
                          java.lang.String message,
                          java.lang.String title)

Method Detail

setTitle

public AppianErrorBuilder setTitle(java.lang.String title)

setDetails

public AppianErrorBuilder setDetails(java.lang.String details)

setCause

public AppianErrorBuilder setCause(AppianErrorBuilder causeBuilder)

build

public AppianError build()

fromThrowable

public static final AppianError fromThrowable(java.util.Locale targetLocale,
                                              java.lang.Throwable t,
                                              ErrorCode defaultError)

Creates an AppianError from the given exception, by applying the function generated by fromThrowable(Locale). Uses the supplied default error code for any exceptions that are do not supply their own codes (AppianException or AppianRuntimeException)

fromThrowable

public static final AppianError fromThrowable(java.util.Locale targetLocale,
                                              java.lang.Throwable t)

Creates an AppianError from the given exception, by applying the function generated by fromThrowable(Locale).

fromThrowable

public static final com.google.common.base.Function<java.lang.Throwable,AppianError> fromThrowable(java.util.Locale targetLocale)

Returns a function to create AppianErrors from exceptions. This function will traverse the cause exceptions of any given exception. For non-Appian exceptions, the error code ErrorCode.GENERIC_RUNTIME_ERROR is used, and the exception class name and message are placed in the details of the error bean. For Appian exceptions (any AppianException or AppianRuntimeException), the localized message is retrieved using the given locale.