blob: b332960a1f8c933ffffd0e9d58d89080e6785743 (
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
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
|
/*
* 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.Locale;
import java.util.Optional;
import com.vaadin.ui.Component;
import com.vaadin.ui.UI;
/**
* Value context for {@code Converter}s. Contains relevant information for
* converting values.
*
* @author Vaadin Ltd.
* @since 8.0
*/
public class ValueContext implements Serializable {
private final Component component;
private final HasValue<?> hasValue;
private final Locale locale;
/**
* Constructor for {@code ValueContext} without a {@code Locale}.
*/
public ValueContext() {
component = null;
hasValue = null;
locale = findLocale();
}
/**
* Constructor for {@code ValueContext} without a {@code Component}.
*
* @param locale
* The locale used with conversion. Can be null.
*/
public ValueContext(Locale locale) {
component = null;
this.locale = locale;
hasValue = null;
}
/**
* Constructor for {@code ValueContext}.
*
* @param component
* The component related to current value. Can be null. If the
* component implements {@link HasValue}, it will be returned by
* {@link #getHasValue()} as well.
*/
@SuppressWarnings("unchecked")
public ValueContext(Component component) {
this.component = component;
if (component instanceof HasValue) {
hasValue = (HasValue<?>) component;
} else {
hasValue = null;
}
locale = findLocale();
}
/**
* Constructor for {@code ValueContext}.
*
* @param component
* The component related to current value. Can be null.
* @param hasValue
* The value source related to current value. Can be null.
* @since 8.1
*/
public ValueContext(Component component, HasValue<?> hasValue) {
this.component = component;
this.hasValue = hasValue;
locale = findLocale();
}
/**
* Constructor for {@code ValueContext}.
*
* @param component
* The component can be {@code null}.
* @param locale
* The locale used with conversion. Can be {@code null}.
* @param hasValue
* The value source related to current value. Can be
* {@code null}.
* @since 8.1
*/
public ValueContext(Component component, HasValue<?> hasValue,
Locale locale) {
this.component = component;
this.hasValue = hasValue;
this.locale = locale;
}
private Locale findLocale() {
Locale l = null;
if (component != null) {
l = component.getLocale();
}
if (l == null && UI.getCurrent() != null) {
l = UI.getCurrent().getLocale();
}
if (l == null) {
l = Locale.getDefault();
}
return l;
}
/**
* Returns an {@code Optional} for the {@code Component} related to value
* conversion.
*
* @return the optional of component
*/
public Optional<Component> getComponent() {
return Optional.ofNullable(component);
}
/**
* Returns an {@code Optional} for the {@code Locale} used in the value
* conversion.
*
* @return the optional of locale
*/
public Optional<Locale> getLocale() {
return Optional.ofNullable(locale);
}
/**
* Returns an {@code Optional} for the {@code HasValue} used in the value
* conversion. In certain complicated cases, ex. cross-field validation,
* HasValue might be not available.
*
* @return the optional of {@code HasValue}
* @since 8.1
*/
public Optional<HasValue<?>> getHasValue() {
return Optional.ofNullable(hasValue);
}
}
|
