Package com.atlan.exception
Class ExceptionMessageDefinition
- java.lang.Object
-
- com.atlan.exception.ExceptionMessageDefinition
-
public class ExceptionMessageDefinition extends java.lang.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
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static ExceptionMessageDefinition.ExceptionMessageDefinitionBuilder
builder()
java.lang.String
getErrorId()
Unique, language-independent code for the error.java.lang.String
getErrorMessage(java.lang.String... params)
Retrieve the formatted, parameterized error message.int
getHttpErrorCode()
HTTP response code for the error.java.lang.String
getUserAction()
Recommended action for the user to take upon observing this error.
-
-
-
Method Detail
-
getErrorMessage
public java.lang.String getErrorMessage(java.lang.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 java.lang.String getErrorId()
Unique, language-independent code for the error.
-
getUserAction
public java.lang.String getUserAction()
Recommended action for the user to take upon observing this error.
-
-