1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
|
/*
* Copyright 2011 Vaadin Ltd.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
package com.vaadin.terminal;
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;
}
}
/**
* @deprecated from 7.0, use {@link ErrorLevel#SYSTEMERROR} instead
*/
@Deprecated
public static final ErrorLevel SYSTEMERROR = ErrorLevel.SYSTEMERROR;
/**
* @deprecated from 7.0, use {@link ErrorLevel#CRITICAL} instead
*/
@Deprecated
public static final ErrorLevel CRITICAL = ErrorLevel.CRITICAL;
/**
* @deprecated from 7.0, use {@link ErrorLevel#ERROR} instead
*/
@Deprecated
public static final ErrorLevel ERROR = ErrorLevel.ERROR;
/**
* @deprecated from 7.0, use {@link ErrorLevel#WARNING} instead
*/
@Deprecated
public static final ErrorLevel WARNING = ErrorLevel.WARNING;
/**
* @deprecated from 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();
}
|
