Package com.vaadin.server
Interface ErrorMessage
-
- All Superinterfaces:
Serializable
- All Known Implementing Classes:
AbstractErrorMessage,CompositeErrorMessage,SystemError,UserError
public interface ErrorMessage extends Serializable
Interface for rendering error messages to terminal. All the visible errors shown to user must implement this interface.- Since:
- 3.0
- Author:
- Vaadin Ltd.
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static classErrorMessage.ErrorLevel
-
Field Summary
Fields Modifier and Type Field Description static ErrorMessage.ErrorLevelCRITICALDeprecated.As of 7.0, useErrorMessage.ErrorLevel.CRITICALinsteadstatic ErrorMessage.ErrorLevelERRORDeprecated.As of 7.0, useErrorMessage.ErrorLevel.ERRORinsteadstatic ErrorMessage.ErrorLevelINFORMATIONDeprecated.As of 7.0, useErrorMessage.ErrorLevel.INFORMATIONinsteadstatic ErrorMessage.ErrorLevelSYSTEMERRORDeprecated.As of 7.0, useErrorMessage.ErrorLevel.SYSTEMERRORinsteadstatic ErrorMessage.ErrorLevelWARNINGDeprecated.As of 7.0, useErrorMessage.ErrorLevel.WARNINGinstead
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description ErrorMessage.ErrorLevelgetErrorLevel()Gets the errors level.StringgetFormattedHtmlMessage()Returns the HTML formatted message to show in as the error message on the client.
-
-
-
Field Detail
-
SYSTEMERROR
@Deprecated static final ErrorMessage.ErrorLevel SYSTEMERROR
Deprecated.As of 7.0, useErrorMessage.ErrorLevel.SYSTEMERRORinstead
-
CRITICAL
@Deprecated static final ErrorMessage.ErrorLevel CRITICAL
Deprecated.As of 7.0, useErrorMessage.ErrorLevel.CRITICALinstead
-
ERROR
@Deprecated static final ErrorMessage.ErrorLevel ERROR
Deprecated.As of 7.0, useErrorMessage.ErrorLevel.ERRORinstead
-
WARNING
@Deprecated static final ErrorMessage.ErrorLevel WARNING
Deprecated.As of 7.0, useErrorMessage.ErrorLevel.WARNINGinstead
-
INFORMATION
@Deprecated static final ErrorMessage.ErrorLevel INFORMATION
Deprecated.As of 7.0, useErrorMessage.ErrorLevel.INFORMATIONinstead
-
-
Method Detail
-
getErrorLevel
ErrorMessage.ErrorLevel getErrorLevel()
Gets the errors level.- Returns:
- the level of error as an integer.
-
getFormattedHtmlMessage
String getFormattedHtmlMessage()
Returns the HTML formatted message to show in as the error message on the client. This method should perform any necessary escaping to avoid XSS attacks. TODO this API may still change to use a separate data transfer object- Returns:
- HTML formatted string for the error message
- Since:
- 7.0
-
-