com.vaadin.server.ErrorMessage Maven / Gradle / Ivy
/*
* Vaadin Framework 7
*
* Copyright (C) 2000-2024 Vaadin Ltd
*
* This program is available under Vaadin Commercial License and Service Terms.
*
* See for the full
* license.
*/
package com.vaadin.server;
import java.io.Serializable;
/**
* Interface for rendering error messages to terminal. All the visible errors
* shown to user must implement this interface.
*
* @author Vaadin Ltd.
* @since 3.0
*/
public interface ErrorMessage extends Serializable {
public enum ErrorLevel {
/**
* Error code for informational messages.
*/
INFORMATION("info", 0),
/**
* Error code for warning messages.
*/
WARNING("warning", 1),
/**
* Error code for regular error messages.
*/
ERROR("error", 2),
/**
* Error code for critical error messages.
*/
CRITICAL("critical", 3),
/**
* Error code for system errors and bugs.
*/
SYSTEMERROR("system", 4);
String text;
int errorLevel;
private ErrorLevel(String text, int errorLevel) {
this.text = text;
this.errorLevel = errorLevel;
}
/**
* Textual representation for server-client communication of level
*
* @return String for error severity
*/
public String getText() {
return text;
}
/**
* Integer representation of error severity for comparison
*
* @return integer for error severity
*/
public int intValue() {
return errorLevel;
}
@Override
public String toString() {
return text;
}
/**
* Converts this to an error level that can be used on the client side.
*
* @return error level for the client side
* @since 7.7.11
*/
public com.vaadin.shared.ui.ErrorLevel convertToShared() {
switch (this) {
case INFORMATION:
return com.vaadin.shared.ui.ErrorLevel.INFO;
case WARNING:
return com.vaadin.shared.ui.ErrorLevel.WARNING;
case CRITICAL:
return com.vaadin.shared.ui.ErrorLevel.CRITICAL;
case SYSTEMERROR:
return com.vaadin.shared.ui.ErrorLevel.SYSTEM;
case ERROR:
default:
return com.vaadin.shared.ui.ErrorLevel.ERROR;
}
}
}
/**
* @deprecated As of 7.0, use {@link ErrorLevel#SYSTEMERROR} instead
*/
@Deprecated
public static final ErrorLevel SYSTEMERROR = ErrorLevel.SYSTEMERROR;
/**
* @deprecated As of 7.0, use {@link ErrorLevel#CRITICAL} instead
*/
@Deprecated
public static final ErrorLevel CRITICAL = ErrorLevel.CRITICAL;
/**
* @deprecated As of 7.0, use {@link ErrorLevel#ERROR} instead
*/
@Deprecated
public static final ErrorLevel ERROR = ErrorLevel.ERROR;
/**
* @deprecated As of 7.0, use {@link ErrorLevel#WARNING} instead
*/
@Deprecated
public static final ErrorLevel WARNING = ErrorLevel.WARNING;
/**
* @deprecated As of 7.0, use {@link ErrorLevel#INFORMATION} instead
*/
@Deprecated
public static final ErrorLevel INFORMATION = ErrorLevel.INFORMATION;
/**
* Gets the errors level.
*
* @return the level of error as an integer.
*/
public ErrorLevel getErrorLevel();
/**
* 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
*
* @return HTML formatted string for the error message
* @since 7.0
*/
public String getFormattedHtmlMessage();
}