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
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
|
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You 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 jakarta.el;
import java.lang.reflect.Method;
import java.util.Objects;
/**
* Defines property resolution behavior on instances of {@link Record}.
* <p>
* The resolver handles base objects of type {@link Record}. It accepts any non-{@code null} object as a property and
* coerces it to a String using {@link Object#toString()}. The property string is used to find an accessor method for a
* field with the same name.
* <p>
* This resolver is always read-only since {@link Record}s are always read-only.
* <p>
* {@code ELResolver}s are combined using {@link CompositeELResolver}s to define rich semantics for evaluating an
* expression. See the javadocs for {@link ELResolver} for details.
*
* @since EL 6.0
*/
public class RecordELResolver extends ELResolver {
/**
* If the base object is an instance of {@link Record}, returns the value of the given field of this {@link Record}.
* <p>
* If the base object is an instance of {@link Record}, the {@code propertyResolved} property of the provided
* {@link ELContext} must be set to {@code true} by this resolver before returning. If this property is not {@code
* true} after this method is called, the caller should ignore the return value.
*
* @param context The context of this evaluation.
* @param base The {@link Record} on which to get the property.
* @param property The property to get. Will be coerced to a String.
*
* @return If the {@code propertyResolved} property of the provided {@link ELContext} was set to {@code true} then
* the value of the given property. Otherwise, undefined.
*
* @throws NullPointerException if the provided {@link ELContext} is {@code null}.
* @throws PropertyNotFoundException if the {@code base} is an instance of {@link Record} and the specified property
* does not exist.
* @throws ELException if an exception was throws while performing the property resolution. The thrown
* exception must be included as the cause of this exception, if available.
*/
@Override
public Object getValue(ELContext context, Object base, Object property) {
Objects.requireNonNull(context);
if (base instanceof Record && property != null) {
context.setPropertyResolved(base, property);
String propertyName = property.toString();
Method method;
try {
method = base.getClass().getMethod(propertyName);
} catch (NoSuchMethodException nsme) {
throw new PropertyNotFoundException(
Util.message(context, "propertyNotFound", base.getClass().getName(), propertyName), nsme);
}
try {
return method.invoke(base);
} catch (ReflectiveOperationException e) {
throw new ELException(
Util.message(context, "propertyReadError", base.getClass().getName(), propertyName), e);
}
}
return null;
}
/**
* If the base object is an instance of {@link Record}, always returns {@code null} since {@link Record}s are always
* read-only.
* <p>
* If the base object is an instance of {@link Record}, the {@code propertyResolved} property of the provided
* {@link ELContext} must be set to {@code true} by this resolver before returning. If this property is not {@code
* true} after this method is called, the caller should ignore the return value.
*
* @param context The context of this evaluation.
* @param base The {@link Record} to analyze.
* @param property The name of the property to analyze. Will be coerced to a String.
*
* @return Always {@code null}
*
* @throws NullPointerException if the provided {@link ELContext} is {@code null}.
* @throws PropertyNotFoundException if the {@code base} is an instance of {@link Record} and the specified property
* does not exist.
*/
@Override
public Class<?> getType(ELContext context, Object base, Object property) {
Objects.requireNonNull(context);
if (base instanceof Record && property != null) {
context.setPropertyResolved(base, property);
String propertyName = property.toString();
try {
base.getClass().getMethod(propertyName);
} catch (NoSuchMethodException nsme) {
throw new PropertyNotFoundException(
Util.message(context, "propertyNotFound", base.getClass().getName(), propertyName), nsme);
}
}
return null;
}
/**
* If the base object is an instance of {@link Record}, always throws an exception since {@link Record}s are
* read-only.
* <p>
* If the base object is an instance of {@link Record}, the {@code propertyResolved} property of the provided
* {@link ELContext} must be set to {@code true} by this resolver before returning. If this property is not {@code
* true} after this method is called, the caller should ignore the return value.
*
* @param context The context of this evaluation.
* @param base The {@link Record} on which to set the property.
* @param property The name of the property to set. Will be coerced to a String.
*
* @throws NullPointerException if the provided {@link ELContext} is {@code null}.
* @throws PropertyNotFoundException if the {@code base} is an instance of {@link Record} and the specified
* property does not exist.
* @throws PropertyNotWritableException if the {@code base} is an instance of {@link Record} and the specified
* property exists.
*/
@Override
public void setValue(ELContext context, Object base, Object property, Object value) {
Objects.requireNonNull(context);
if (base instanceof Record && property != null) {
context.setPropertyResolved(base, property);
String propertyName = property.toString();
try {
base.getClass().getMethod(propertyName);
} catch (NoSuchMethodException nsme) {
throw new PropertyNotFoundException(
Util.message(context, "propertyNotFound", base.getClass().getName(), propertyName), nsme);
}
throw new PropertyNotWritableException(
Util.message(context, "resolverNotWritable", base.getClass().getName()));
}
}
/**
* If the base object is an instance of {@link Record}, always returns {@code true}.
* <p>
* If the base object is an instance of {@link Record}, the {@code propertyResolved} property of the provided
* {@link ELContext} must be set to {@code true} by this resolver before returning. If this property is not {@code
* true} after this method is called, the caller should ignore the return value.
*
* @param context The context of this evaluation.
* @param base The {@link Record} to analyze.
* @param property The name of the property to analyze. Will be coerced to a String.
*
* @throws NullPointerException if the provided {@link ELContext} is {@code null}.
* @throws PropertyNotFoundException if the {@code base} is an instance of {@link Record} and the specified property
* does not exist.
*/
@Override
public boolean isReadOnly(ELContext context, Object base, Object property) {
Objects.requireNonNull(context);
if (base instanceof Record && property != null) {
context.setPropertyResolved(base, property);
String propertyName = property.toString();
try {
base.getClass().getMethod(propertyName);
} catch (NoSuchMethodException nsme) {
throw new PropertyNotFoundException(
Util.message(context, "propertyNotFound", base.getClass().getName(), propertyName), nsme);
}
return true;
}
return false;
}
/**
* If the base object is an instance of {@link Record}, returns the most general type this resolver accepts for the
* {@code property} argument. Otherwise, returns {@code null}.
* <p>
* If the base object is an instance of {@link Record} this method will always return {@link Object} since any
* object is accepted for the property argument and coerced to a String.
*
* @param context The context of this evaluation.
* @param base The {@link Record} to analyze.
*
* @return {@link Object} is base is an instance of {@link Record}, otherwise {@code null}.
*/
@Override
public Class<?> getCommonPropertyType(ELContext context, Object base) {
if (base instanceof Record) {
// Fields can be of any type
return Object.class;
}
return null;
}
}
|
