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
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
|
/*
* Copyright 2000-2018 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.data;
import java.io.Serializable;
import java.util.Objects;
import java.util.Optional;
import com.vaadin.shared.ui.ErrorLevel;
/**
* Represents the result of a validation. A result may be either successful or
* contain an error message in case of a failure.
* <p>
* ValidationResult instances are created using the factory methods
* {@link #ok()} and {@link #error(String)}, denoting success and failure
* respectively.
*
* @author Vaadin Ltd
* @since 8.0
*
*/
public interface ValidationResult extends Serializable {
class SimpleValidationResult implements ValidationResult {
private final String error;
private final ErrorLevel errorLevel;
SimpleValidationResult(String error, ErrorLevel errorLevel) {
if (error != null && errorLevel == null) {
throw new IllegalStateException("ValidationResult has an "
+ "error message, but no ErrorLevel is provided.");
}
this.error = error;
this.errorLevel = errorLevel;
}
@Override
public String getErrorMessage() {
if (!getErrorLevel().isPresent()) {
throw new IllegalStateException("The result is not an error. "
+ "It cannot contain error message");
} else {
return error != null ? error : "";
}
}
public Optional<ErrorLevel> getErrorLevel() {
return Optional.ofNullable(errorLevel);
}
}
/**
* Returns the result message.
* <p>
* Throws an {@link IllegalStateException} if the result represents success.
*
* @return the error message
* @throws IllegalStateException
* if the result represents success
*/
String getErrorMessage();
/**
* Returns optional error level for this validation result. Error level is
* not present for successful validation results.
* <p>
* <strong>Note:</strong> By default {@link ErrorLevel#INFO} and
* {@link ErrorLevel#WARNING} are not considered to be blocking the
* validation and conversion chain.
*
* @see #isError()
*
* @return optional error level; error level is present for validation
* results that have not passed validation
*
* @since 8.2
*/
Optional<ErrorLevel> getErrorLevel();
/**
* Checks if the result denotes an error.
* <p>
* <strong>Note:</strong> By default {@link ErrorLevel#INFO} and
* {@link ErrorLevel#WARNING} are not considered to be errors.
*
* @return <code>true</code> if the result denotes an error,
* <code>false</code> otherwise
*/
default boolean isError() {
ErrorLevel errorLevel = getErrorLevel().orElse(null);
return errorLevel != null && errorLevel != ErrorLevel.INFO
&& errorLevel != ErrorLevel.WARNING;
}
/**
* Returns a successful result.
*
* @return the successful result
*/
public static ValidationResult ok() {
return new SimpleValidationResult(null, null);
}
/**
* Creates the validation result which represent an error with the given
* {@code errorMessage}.
*
* @param errorMessage
* error message, not {@code null}
* @return validation result which represent an error with the given
* {@code errorMessage}
* @throws NullPointerException
* if {@code errorMessage} is null
*/
public static ValidationResult error(String errorMessage) {
Objects.requireNonNull(errorMessage);
return create(errorMessage, ErrorLevel.ERROR);
}
/**
* Creates the validation result with the given {@code errorMessage} and
* {@code errorLevel}. Results with {@link ErrorLevel} of {@code INFO} or
* {@code WARNING} are not errors by default.
*
* @see #ok()
* @see #error(String)
*
* @param errorMessage
* error message, not {@code null}
* @param errorLevel
* error level, not {@code null}
* @return validation result with the given {@code errorMessage} and
* {@code errorLevel}
* @throws NullPointerException
* if {@code errorMessage} or {@code errorLevel} is {@code null}
*
* @since 8.2
*/
public static ValidationResult create(String errorMessage,
ErrorLevel errorLevel) {
Objects.requireNonNull(errorMessage);
Objects.requireNonNull(errorLevel);
return new SimpleValidationResult(errorMessage, errorLevel);
}
}
|
