com.appiancorp.suiteapi.common.exceptions

Class LocaleFormatter

java.lang.Object

com.appiancorp.suiteapi.common.exceptions.LocaleFormatter

All Implemented Interfaces:

AppianErrorCodeTitleFormatter, AppianErrorCodeFormatter

public class LocaleFormatter
extends java.lang.Object
implements AppianErrorCodeFormatter, AppianErrorCodeTitleFormatter

ErrorCodeFormatter based upon a Locale.

Constructor Summary

Constructors

Constructor and Description
LocaleFormatter(java.util.Locale locale)

Method Summary

Modifier and Type	Method and Description
java.lang.String	format(AppianErrorCode errorCode, java.lang.Object... arguments)
java.lang.String	formatTitle(AppianErrorCode errorCode, java.lang.Object... arguments) Returns the localized title, rendered with the included arguments if the error title supports them.
static java.lang.String	getText(java.lang.Class<?> clazz, java.util.Locale targetLocale, java.lang.String key, java.lang.Object[] params) Manually fetch error code text Useful in case that the locale is not available in context and error code is not automatically converted to correct locale text

Methods inherited from class java.lang.Object

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

Constructor Detail

LocaleFormatter

public LocaleFormatter(java.util.Locale locale)

Method Detail

format

public java.lang.String format(AppianErrorCode errorCode,
                               java.lang.Object... arguments)

Specified by:

format in interface AppianErrorCodeFormatter

formatTitle

public java.lang.String formatTitle(AppianErrorCode errorCode,
                                    java.lang.Object... arguments)

Returns the localized title, rendered with the included arguments if the error title supports them. If the title does not exist, the method returns "".

Specified by:

formatTitle in interface AppianErrorCodeTitleFormatter

Parameters:

errorCode - The code corresponding to the thrown exception

arguments - Additional parameters required to render the title

Returns:

The title, localized and rendered with the included arguments where applicable.

getText

public static java.lang.String getText(java.lang.Class<?> clazz,
                                       java.util.Locale targetLocale,
                                       java.lang.String key,
                                       java.lang.Object[] params)

Manually fetch error code text Useful in case that the locale is not available in context and error code is not automatically converted to correct locale text