Interface ErrorMessage
- All Known Implementing Classes:
ErrorMessage.InvalidParameterError,ErrorMessage.SimpleError
public interface ErrorMessage
High level interface for errors.
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final classstatic class -
Method Summary
Modifier and TypeMethodDescriptionstatic ErrorMessageinvalidParameter(String parameterName, String message) Creates anErrorMessagefor an invalid request parameter value.static ErrorMessagewithMessage(String message) Creates a simpleErrorMessagewith a message.
-
Method Details
-
getMessage
String getMessage()- Returns:
- the message
-
withMessage
Creates a simpleErrorMessagewith a message.- Parameters:
message- to show to the user, or message key if using internationalization- Returns:
- error
- Since:
- 2.1.0
-
invalidParameter
Creates anErrorMessagefor an invalid request parameter value.- Parameters:
parameterName- the parameter namemessage- the message to show to the user, or message key if using internationalization- Returns:
- error
- Since:
- 6.0.0
-