blob: d458911ba1a2dc375d2791dcc3949021082c34b8 (
plain)
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
|
/*
* Copyright 2000-2016 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;
/**
* 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;
SimpleValidationResult(String error) {
this.error = error;
}
@Override
public String getErrorMessage() {
if (error == null) {
throw new IllegalStateException("The result is not an error. "
+ "It cannot contain error message");
} else {
return error;
}
}
@Override
public boolean isError() {
return error != null;
}
}
/**
* 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();
/**
* Checks if the result denotes an error.
*
* @return <code>true</code> if the result denotes an error,
* <code>false</code> otherwise
*/
boolean isError();
/**
* Returns a successful result.
*
* @return the successful result
*/
public static ValidationResult ok() {
return new SimpleValidationResult(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 new SimpleValidationResult(errorMessage);
}
}
|
