Package com.atlan.exception

Class ExceptionMessageDefinition

java.lang.Object

com.atlan.exception.ExceptionMessageDefinition

public class ExceptionMessageDefinition
extends Object

Class to capture the details of individual error messages.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ExceptionMessageDefinition.ExceptionMessageDefinitionBuilder

Method Summary

Modifier and Type	Method	Description
static ExceptionMessageDefinition.ExceptionMessageDefinitionBuilder	builder()
String	getErrorId()	Unique, language-independent code for the error.
String	getErrorMessage(String... params)	Retrieve the formatted, parameterized error message.
int	getHttpErrorCode()	HTTP response code for the error.
String	getUserAction()	Recommended action for the user to take upon observing this error.

Methods inherited from class java.lang.Object

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

Method Details

getErrorMessage

public String getErrorMessage(String... params)

Retrieve the formatted, parameterized error message.

Parameters:

params - the values to inject into the formatting placeholders of the message

Returns:

the formatted error message

builder

public static ExceptionMessageDefinition.ExceptionMessageDefinitionBuilder builder()

getHttpErrorCode

public int getHttpErrorCode()

HTTP response code for the error.

getErrorId

public String getErrorId()

Unique, language-independent code for the error.

getUserAction

public String getUserAction()

Recommended action for the user to take upon observing this error.