This repository was archived by the owner on Jan 30, 2019. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 10
Expand file tree
/
Copy pathMapELResolver.java
More file actions
418 lines (395 loc) · 17.9 KB
/
MapELResolver.java
File metadata and controls
418 lines (395 loc) · 17.9 KB
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
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 1997-2010 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* https://glassfish.dev.java.net/public/CDDL+GPL_1_1.html
* or packager/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at packager/legal/LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*
*
* This file incorporates work covered by the following copyright and
* permission notice:
*
* Copyright 2004 The Apache Software Foundation
*
* 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 javax.el;
import java.beans.FeatureDescriptor;
import java.util.Map;
import java.util.Iterator;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.ArrayList;
/**
* Defines property resolution behavior on instances of {@link java.util.Map}.
*
* <p>This resolver handles base objects of type <code>java.util.Map</code>.
* It accepts any object as a property and uses that object as a key in
* the map. The resulting value is the value in the map that is associated with
* that key.</p>
*
* <p>This resolver can be constructed in read-only mode, which means that
* {@link #isReadOnly} will always return <code>true</code> and
* {@link #setValue} will always throw
* <code>PropertyNotWritableException</code>.</p>
*
* <p><code>ELResolver</code>s are combined together using
* {@link CompositeELResolver}s, to define rich semantics for evaluating
* an expression. See the javadocs for {@link ELResolver} for details.</p>
*
* @see CompositeELResolver
* @see ELResolver
* @see java.util.Map
* @since JSP 2.1
*/
public class MapELResolver extends ELResolver {
/**
* Creates a new read/write <code>MapELResolver</code>.
*/
public MapELResolver() {
this.isReadOnly = false;
}
/**
* Creates a new <code>MapELResolver</code> whose read-only status is
* determined by the given parameter.
*
* @param isReadOnly <code>true</code> if this resolver cannot modify
* maps; <code>false</code> otherwise.
*/
public MapELResolver(boolean isReadOnly) {
this.isReadOnly = isReadOnly;
}
/**
* If the base object is a map, returns the most general acceptable type
* for a value in this map.
*
* <p>If the base is a <code>Map</code>, the <code>propertyResolved</code>
* property of the <code>ELContext</code> object must be set to
* <code>true</code> by this resolver, before returning. If this property
* is not <code>true</code> after this method is called, the caller
* should ignore the return value.</p>
*
* <p>Assuming the base is a <code>Map</code>, this method will always
* return <code>Object.class</code>. This is because <code>Map</code>s
* accept any object as the value for a given key.</p>
*
* @param context The context of this evaluation.
* @param base The map to analyze. Only bases of type <code>Map</code>
* are handled by this resolver.
* @param property The key to return the acceptable type for.
* Ignored by this resolver.
* @return If the <code>propertyResolved</code> property of
* <code>ELContext</code> was set to <code>true</code>, then
* the most general acceptable type; otherwise undefined.
* @throws NullPointerException if context is <code>null</code>
* @throws ELException if an exception was thrown while performing
* the property or variable resolution. The thrown exception
* must be included as the cause property of this exception, if
* available.
*/
public Class<?> getType(ELContext context,
Object base,
Object property) {
if (context == null) {
throw new NullPointerException();
}
if (base != null && base instanceof Map) {
context.setPropertyResolved(true);
return Object.class;
}
return null;
}
/**
* If the base object is a map, returns the value associated with the
* given key, as specified by the <code>property</code> argument. If the
* key was not found, <code>null</code> is returned.
*
* <p>If the base is a <code>Map</code>, the <code>propertyResolved</code>
* property of the <code>ELContext</code> object must be set to
* <code>true</code> by this resolver, before returning. If this property
* is not <code>true</code> after this method is called, the caller
* should ignore the return value.</p>
*
* <p>Just as in {@link java.util.Map#get}, just because <code>null</code>
* is returned doesn't mean there is no mapping for the key; it's also
* possible that the <code>Map</code> explicitly maps the key to
* <code>null</code>.</p>
*
* @param context The context of this evaluation.
* @param base The map to be analyzed. Only bases of type <code>Map</code>
* are handled by this resolver.
* @param property The key whose associated value is to be returned.
* @return If the <code>propertyResolved</code> property of
* <code>ELContext</code> was set to <code>true</code>, then
* the value associated with the given key or <code>null</code>
* if the key was not found. Otherwise, undefined.
* @throws ClassCastException if the key is of an inappropriate type
* for this map (optionally thrown by the underlying <code>Map</code>).
* @throws NullPointerException if context is <code>null</code>, or if
* the key is null and this map does not permit null keys (the
* latter is optionally thrown by the underlying <code>Map</code>).
* @throws ELException if an exception was thrown while performing
* the property or variable resolution. The thrown exception
* must be included as the cause property of this exception, if
* available.
*/
public Object getValue(ELContext context,
Object base,
Object property) {
if (context == null) {
throw new NullPointerException();
}
if (base != null && base instanceof Map) {
context.setPropertyResolved(base, property);
Map map = (Map) base;
return map.get(property);
}
return null;
}
static private Class<?> theUnmodifiableMapClass =
Collections.unmodifiableMap(new HashMap<Object, Object>()).getClass();
/**
* If the base object is a map, attempts to set the value associated with
* the given key, as specified by the <code>property</code> argument.
*
* <p>If the base is a <code>Map</code>, the <code>propertyResolved</code>
* property of the <code>ELContext</code> object must be set to
* <code>true</code> by this resolver, before returning. If this property
* is not <code>true</code> after this method is called, the caller
* can safely assume no value was set.</p>
*
* <p>If this resolver was constructed in read-only mode, this method will
* always throw <code>PropertyNotWritableException</code>.</p>
*
* <p>If a <code>Map</code> was created using
* {@link java.util.Collections#unmodifiableMap}, this method must
* throw <code>PropertyNotWritableException</code>. Unfortunately,
* there is no Collections API method to detect this. However, an
* implementation can create a prototype unmodifiable <code>Map</code>
* and query its runtime type to see if it matches the runtime type of
* the base object as a workaround.</p>
*
* @param context The context of this evaluation.
* @param base The map to be modified. Only bases of type <code>Map</code>
* are handled by this resolver.
* @param property The key with which the specified value is to be
* associated.
* @param val The value to be associated with the specified key.
* @throws ClassCastException if the class of the specified key or
* value prevents it from being stored in this map.
* @throws NullPointerException if context is <code>null</code>, or if
* this map does not permit <code>null</code> keys or values, and
* the specified key or value is <code>null</code>.
* @throws IllegalArgumentException if some aspect of this key or
* value prevents it from being stored in this map.
* @throws ELException if an exception was thrown while performing
* the property or variable resolution. The thrown exception
* must be included as the cause property of this exception, if
* available.
* @throws PropertyNotWritableException if this resolver was constructed
* in read-only mode, or if the put operation is not supported by
* the underlying map.
*/
public void setValue(ELContext context,
Object base,
Object property,
Object val) {
if (context == null) {
throw new NullPointerException();
}
if (base != null && base instanceof Map) {
context.setPropertyResolved(base, property);
// The cast is safe
@SuppressWarnings("unchecked")
Map<Object, Object> map = (Map)base;
if (isReadOnly || map.getClass() == theUnmodifiableMapClass) {
throw new PropertyNotWritableException();
}
try {
map.put(property, val);
} catch (UnsupportedOperationException ex) {
throw new PropertyNotWritableException();
}
}
}
/**
* If the base object is a map, returns whether a call to
* {@link #setValue} will always fail.
*
* <p>If the base is a <code>Map</code>, the <code>propertyResolved</code>
* property of the <code>ELContext</code> object must be set to
* <code>true</code> by this resolver, before returning. If this property
* is not <code>true</code> after this method is called, the caller
* should ignore the return value.</p>
*
* <p>If this resolver was constructed in read-only mode, this method will
* always return <code>true</code>.</p>
*
* <p>If a <code>Map</code> was created using
* {@link java.util.Collections#unmodifiableMap}, this method must
* return <code>true</code>. Unfortunately, there is no Collections API
* method to detect this. However, an implementation can create a
* prototype unmodifiable <code>Map</code> and query its runtime type
* to see if it matches the runtime type of the base object as a
* workaround.</p>
*
* @param context The context of this evaluation.
* @param base The map to analyze. Only bases of type <code>Map</code>
* are handled by this resolver.
* @param property The key to return the read-only status for.
* Ignored by this resolver.
* @return If the <code>propertyResolved</code> property of
* <code>ELContext</code> was set to <code>true</code>, then
* <code>true</code> if calling the <code>setValue</code> method
* will always fail or <code>false</code> if it is possible that
* such a call may succeed; otherwise undefined.
* @throws NullPointerException if context is <code>null</code>
* @throws ELException if an exception was thrown while performing
* the property or variable resolution. The thrown exception
* must be included as the cause property of this exception, if
* available.
*/
public boolean isReadOnly(ELContext context,
Object base,
Object property) {
if (context == null) {
throw new NullPointerException();
}
if (base != null && base instanceof Map) {
context.setPropertyResolved(true);
Map map = (Map) base;
return isReadOnly || map.getClass() == theUnmodifiableMapClass;
}
return false;
}
/**
* If the base object is a map, returns an <code>Iterator</code>
* containing the set of keys available in the <code>Map</code>.
* Otherwise, returns <code>null</code>.
*
* <p>The <code>Iterator</code> returned must contain zero or more
* instances of {@link java.beans.FeatureDescriptor}. Each info object
* contains information about a key in the Map, and is initialized as
* follows:
* <dl>
* <li>displayName - The return value of calling the
* <code>toString</code> method on this key, or
* <code>"null"</code> if the key is <code>null</code>.</li>
* <li>name - Same as displayName property.</li>
* <li>shortDescription - Empty string</li>
* <li>expert - <code>false</code></li>
* <li>hidden - <code>false</code></li>
* <li>preferred - <code>true</code></li>
* </dl>
* In addition, the following named attributes must be set in the
* returned <code>FeatureDescriptor</code>s:
* <dl>
* <li>{@link ELResolver#TYPE} - The return value of calling the <code>getClass()</code>
* method on this key, or <code>null</code> if the key is
* <code>null</code>.</li>
* <li>{@link ELResolver#RESOLVABLE_AT_DESIGN_TIME} - <code>true</code></li>
* </dl>
* </p>
*
* @param context The context of this evaluation.
* @param base The map whose keys are to be iterated over. Only bases
* of type <code>Map</code> are handled by this resolver.
* @return An <code>Iterator</code> containing zero or more (possibly
* infinitely more) <code>FeatureDescriptor</code> objects, each
* representing a key in this map, or <code>null</code> if
* the base object is not a map.
*/
public Iterator<FeatureDescriptor> getFeatureDescriptors(
ELContext context,
Object base) {
if (base != null && base instanceof Map) {
Map map = (Map) base;
Iterator iter = map.keySet().iterator();
List<FeatureDescriptor> list = new ArrayList<FeatureDescriptor>();
while (iter.hasNext()) {
Object key = iter.next();
FeatureDescriptor descriptor = new FeatureDescriptor();
String name = (key==null)? null: key.toString();
descriptor.setName(name);
descriptor.setDisplayName(name);
descriptor.setShortDescription("");
descriptor.setExpert(false);
descriptor.setHidden(false);
descriptor.setPreferred(true);
if (key != null) {
descriptor.setValue("type", key.getClass());
}
descriptor.setValue("resolvableAtDesignTime", Boolean.TRUE);
list.add(descriptor);
}
return list.iterator();
}
return null;
}
/**
* If the base object is a map, returns the most general type that
* this resolver accepts for the <code>property</code> argument.
* Otherwise, returns <code>null</code>.
*
* <p>Assuming the base is a <code>Map</code>, this method will always
* return <code>Object.class</code>. This is because <code>Map</code>s
* accept any object as a key.</p>
*
* @param context The context of this evaluation.
* @param base The map to analyze. Only bases of type <code>Map</code>
* are handled by this resolver.
* @return <code>null</code> if base is not a <code>Map</code>; otherwise
* <code>Object.class</code>.
*/
public Class<?> getCommonPropertyType(ELContext context,
Object base) {
if (base != null && base instanceof Map) {
return Object.class;
}
return null;
}
private boolean isReadOnly;
}