-
Notifications
You must be signed in to change notification settings - Fork 55
/
ContextBase.java
769 lines (674 loc) · 25 KB
/
ContextBase.java
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
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
/*
* 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 org.apache.commons.chain2.impl;
import org.apache.commons.chain2.Context;
import java.beans.IntrospectionException;
import java.beans.Introspector;
import java.beans.PropertyDescriptor;
import java.io.Serializable;
import java.lang.reflect.Method;
import java.util.AbstractCollection;
import java.util.AbstractSet;
import java.util.Collection;
import java.util.HashMap;
import java.util.Iterator;
import java.util.Map;
import java.util.Set;
/**
* <p>Convenience base class for {@link Context} implementations.</p>
*
* <p>In addition to the minimal functionality required by the {@link Context}
* interface, this class implements the recommended support for
* <em>Attribute-Property Transparency</em>. This is implemented by
* analyzing the available JavaBeans properties of this class (or its
* subclass), exposes them as key-value pairs in the <code>Map</code>,
* with the key being the name of the property itself.</p>
*
* <p><strong>IMPLEMENTATION NOTE</strong> - Because <code>empty</code> is a
* read-only property defined by the <code>Map</code> interface, it may not
* be utilized as an attribute key or property name.</p>
*
* @version $Id$
*/
public class ContextBase extends ContextMap<String, Object> {
// ------------------------------------------------------------ Constructors
/**
*
*/
private static final long serialVersionUID = 20120724L;
/**
* Default, no argument constructor.
*/
public ContextBase() {
super();
initialize();
}
/**
* <p>Initialize the contents of this {@link Context} by copying the
* values from the specified <code>Map</code>. Any keys in <code>map</code>
* that correspond to local properties will cause the setter method for
* that property to be called.</p>
*
* @param map Map whose key-value pairs are added
*
* @throws IllegalArgumentException if an exception is thrown
* writing a local property value
* @throws UnsupportedOperationException if a local property does not
* have a write method.
*/
public ContextBase(Map<? extends String, ? extends Object> map) {
super(map);
initialize();
putAll(map);
}
// ------------------------------------------------------ Instance Variables
// NOTE - PropertyDescriptor instances are not Serializable, so the
// following variables must be declared as transient. When a ContextBase
// instance is deserialized, the no-arguments constructor is called,
// and the initialize() method called there will repoopulate them.
// Therefore, no special restoration activity is required.
/**
* <p>The <code>PropertyDescriptor</code>s for all JavaBeans properties
* of this {@link Context} implementation class, keyed by property name.
* This collection is allocated only if there are any JavaBeans
* properties.</p>
*/
private transient Map<String, PropertyDescriptor> descriptors = null;
/**
* <p>The same <code>PropertyDescriptor</code>s as an array.</p>
*/
private transient PropertyDescriptor[] pd = null;
/**
* <p>Distinguished singleton value that is stored in the map for each
* key that is actually a property. This value is used to ensure that
* <code>equals()</code> comparisons will always fail.</p>
*/
private static final Object singleton;
static {
singleton = new Serializable() {
private static final long serialVersionUID = 20120724L;
@Override
public boolean equals(Object object) {
return false;
}
@Override
public int hashCode() {
return super.hashCode();
}
};
}
/**
* <p>Zero-length array of parameter values for calling property getters.
* </p>
*/
private static Object[] zeroParams = new Object[0];
// ------------------------------------------------------------- Map Methods
/**
* <p>Override the default <code>Map</code> behavior to clear all keys and
* values except those corresponding to JavaBeans properties.</p>
*/
@Override
public void clear() {
if (descriptors == null) {
super.clear();
} else {
Iterator<String> keys = keySet().iterator();
while (keys.hasNext()) {
String key = keys.next();
if (!descriptors.containsKey(key)) {
keys.remove();
}
}
}
}
/**
* <p>Override the default <code>Map</code> behavior to return
* <code>true</code> if the specified value is present in either the
* underlying <code>Map</code> or one of the local property values.</p>
*
* @param value the value look for in the context.
* @return <code>true</code> if found in this context otherwise
* <code>false</code>.
* @throws IllegalArgumentException if a property getter
* throws an exception
*/
@Override
public boolean containsValue(Object value) {
// Case 1 -- no local properties
if (descriptors == null) {
return super.containsValue(value);
// Case 2 -- value found in the underlying Map
} else if (super.containsValue(value)) {
return true;
}
// Case 3 -- check the values of our readable properties
for (PropertyDescriptor aPd : pd) {
if (aPd.getReadMethod() != null) {
Object prop = readProperty(aPd);
if (value == null) {
if (prop == null) {
return true;
}
} else if (value.equals(prop)) {
return true;
}
}
}
return false;
}
/**
* <p>Override the default <code>Map</code> behavior to return a
* <code>Set</code> that meets the specified default behavior except
* for attempts to remove the key for a property of the {@link Context}
* implementation class, which will throw
* <code>UnsupportedOperationException</code>.</p>
*
* @return Set of entries in the Context.
*/
@Override
public Set<Entry<String, Object>> entrySet() {
return new EntrySetImpl();
}
/**
* <p>Override the default <code>Map</code> behavior to return the value
* of a local property if the specified key matches a local property name.
* </p>
*
* <p><strong>IMPLEMENTATION NOTE</strong> - If the specified
* <code>key</code> identifies a write-only property, <code>null</code>
* will arbitrarily be returned, in order to avoid difficulties implementing
* the contracts of the <code>Map</code> interface.</p>
*
* @param key Key of the value to be returned
* @return The value for the specified key.
*
* @throws IllegalArgumentException if an exception is thrown
* reading this local property value
* @throws UnsupportedOperationException if this local property does not
* have a read method.
*/
@Override
public Object get(Object key) {
// Case 1 -- no local properties
if (descriptors == null) {
return super.get(key);
}
// Case 2 -- this is a local property
if (key != null) {
PropertyDescriptor descriptor = descriptors.get(key);
if (descriptor != null) {
if (descriptor.getReadMethod() != null) {
return readProperty(descriptor);
} else {
return null;
}
}
}
// Case 3 -- retrieve value from our underlying Map
return super.get(key);
}
/**
* <p>Override the default <code>Map</code> behavior to return
* <code>true</code> if the underlying <code>Map</code> only contains
* key-value pairs for local properties (if any).</p>
*
* @return <code>true</code> if this Context is empty, otherwise
* <code>false</code>.
*/
@Override
public boolean isEmpty() {
// Case 1 -- no local properties
if (descriptors == null) {
return super.isEmpty();
}
// Case 2 -- compare key count to property count
return super.size() <= descriptors.size();
}
/**
* <p>Override the default <code>Map</code> behavior to return a
* <code>Set</code> that meets the specified default behavior except
* for attempts to remove the key for a property of the {@link Context}
* implementation class, which will throw
* <code>UnsupportedOperationException</code>.</p>
*
* @return The set of keys for objects in this Context.
*/
@Override
public Set<String> keySet() {
return super.keySet();
}
/**
* <p>Override the default <code>Map</code> behavior to set the value
* of a local property if the specified key matches a local property name.
* </p>
*
* @param key Key of the value to be stored or replaced
* @param value New value to be stored
* @return The value added to the Context.
*
* @throws IllegalArgumentException if an exception is thrown
* reading or writing this local property value
* @throws UnsupportedOperationException if this local property does not
* have both a read method and a write method
*/
@Override
public Object put(String key, Object value) {
/*
* ConcurrentHashMap doesn't accept null values, see
* http://download.oracle.com/javase/1.5.0/docs/api/java/util/concurrent/ConcurrentHashMap.html#put(String, Object)
*/
if (value == null) {
if (containsKey(key)) {
remove(key);
}
return null;
}
// Case 1 -- no local properties
if (descriptors == null) {
return super.put(key, value);
}
// Case 2 -- this is a local property
if (key != null) {
PropertyDescriptor descriptor = descriptors.get(key);
if (descriptor != null) {
Object previous = null;
if (descriptor.getReadMethod() != null) {
previous = readProperty(descriptor);
}
writeProperty(descriptor, value);
return previous;
}
}
// Case 3 -- store or replace value in our underlying map
return super.put(key, value);
}
/**
* <p>Override the default <code>Map</code> behavior to call the
* <code>put()</code> method individually for each key-value pair
* in the specified <code>Map</code>.</p>
*
* @param map <code>Map</code> containing key-value pairs to store
* (or replace)
*
* @throws IllegalArgumentException if an exception is thrown
* reading or writing a local property value
* @throws UnsupportedOperationException if a local property does not
* have both a read method and a write method
*/
@Override
public void putAll(Map<? extends String, ? extends Object> map) {
for (Entry<? extends String, ? extends Object> pair : map.entrySet()) {
put(pair.getKey(), pair.getValue());
}
}
/**
* <p>Override the default <code>Map</code> behavior to throw
* <code>UnsupportedOperationException</code> on any attempt to
* remove a key that is the name of a local property.</p>
*
* @param key Key to be removed
* @return The value removed from the Context.
*
* @throws UnsupportedOperationException if the specified
* <code>key</code> matches the name of a local property
*/
@Override
public Object remove(Object key) {
// Case 1 -- no local properties
if (descriptors == null) {
return super.remove(key);
}
// Case 2 -- this is a local property
if (key != null) {
PropertyDescriptor descriptor = descriptors.get(key);
if (descriptor != null) {
throw new UnsupportedOperationException
("Local property '" + key + "' cannot be removed");
}
}
// Case 3 -- remove from underlying Map
return super.remove(key);
}
/**
* <p>Override the default <code>Map</code> behavior to return a
* <code>Collection</code> that meets the specified default behavior except
* for attempts to remove the key for a property of the {@link Context}
* implementation class, which will throw
* <code>UnsupportedOperationException</code>.</p>
*
* @return The collection of values in this Context.
*/
@Override
public Collection<Object> values() {
return new ValuesImpl();
}
// --------------------------------------------------------- Private Methods
/**
* <p>Return an <code>Iterator</code> over the set of <code>Map.Entry</code>
* objects representing our key-value pairs.</p>
*/
private Iterator<Entry<String, Object>> entriesIterator() {
return new EntrySetIterator();
}
/**
* <p>Return a <code>Map.Entry</code> for the specified key value, if it
* is present; otherwise, return <code>null</code>.</p>
*
* @param key Attribute key or property name
*/
private Map.Entry<String, Object> entry(String key) {
if (containsKey(key)) {
return new MapEntryImpl(key, get(key));
}
return null;
}
/**
* <p>Customize the contents of our underlying <code>Map</code> so that
* it contains keys corresponding to all of the JavaBeans properties of
* the {@link Context} implementation class.</p>
*
*
* @throws IllegalArgumentException if an exception is thrown
* writing this local property value
* @throws UnsupportedOperationException if this local property does not
* have a write method.
*/
private void initialize() {
// Retrieve the set of property descriptors for this Context class
try {
pd = Introspector.getBeanInfo
(getClass()).getPropertyDescriptors();
} catch (IntrospectionException e) {
pd = new PropertyDescriptor[0]; // Should never happen
}
// Initialize the underlying Map contents
for (PropertyDescriptor propertyDescriptor : pd) {
String name = propertyDescriptor.getName();
// Add descriptor (ignoring getClass() and isEmpty())
if (!("class".equals(name) || "empty".equals(name))) {
if (descriptors == null) {
descriptors = new HashMap<String, PropertyDescriptor>(pd.length - 2);
}
descriptors.put(name, propertyDescriptor);
super.put(name, singleton);
}
}
}
/**
* <p>Get and return the value for the specified property.</p>
*
* @param descriptor <code>PropertyDescriptor</code> for the
* specified property
*
* @throws IllegalArgumentException if an exception is thrown
* reading this local property value
* @throws UnsupportedOperationException if this local property does not
* have a read method.
*/
private Object readProperty(PropertyDescriptor descriptor) {
try {
Method method = descriptor.getReadMethod();
if (method == null) {
throw new UnsupportedOperationException
("Property '" + descriptor.getName()
+ "' is not readable");
}
return method.invoke(this, zeroParams);
} catch (Exception e) {
throw new UnsupportedOperationException
("Exception reading property '" + descriptor.getName()
+ "': " + e.getMessage());
}
}
/**
* <p>Remove the specified key-value pair, if it exists, and return
* <code>true</code>. If this pair does not exist, return
* <code>false</code>.</p>
*
* @param entry Key-value pair to be removed
*
* @throws UnsupportedOperationException if the specified key
* identifies a property instead of an attribute
*/
private boolean remove(Map.Entry<String, Object> entry) {
Map.Entry<String, Object> actual = entry(entry.getKey());
if (actual == null) {
return false;
} else if (!entry.equals(actual)) {
return false;
} else {
remove(entry.getKey());
return true;
}
}
/**
* <p>Return an <code>Iterator</code> over the set of values in this
* <code>Map</code>.</p>
*/
private Iterator<Object> valuesIterator() {
return new ValuesIterator();
}
/**
* <p>Set the value for the specified property.</p>
*
* @param descriptor <code>PropertyDescriptor</code> for the
* specified property
* @param value The new value for this property (must be of the
* correct type)
*
* @throws IllegalArgumentException if an exception is thrown
* writing this local property value
* @throws UnsupportedOperationException if this local property does not
* have a write method.
*/
private void writeProperty(PropertyDescriptor descriptor, Object value) {
try {
Method method = descriptor.getWriteMethod();
if (method == null) {
throw new UnsupportedOperationException
("Property '" + descriptor.getName()
+ "' is not writeable");
}
method.invoke(this, new Object[] {value});
} catch (Exception e) {
throw new UnsupportedOperationException
("Exception writing property '" + descriptor.getName()
+ "': " + e.getMessage());
}
}
// --------------------------------------------------------- Private Classes
/**
* <p>Private implementation of <code>Set</code> that implements the
* semantics required for the value returned by <code>entrySet()</code>.</p>
*/
private class EntrySetImpl extends AbstractSet<Entry<String, Object>> {
@Override
public void clear() {
ContextBase.this.clear();
}
@Override
public boolean contains(Object obj) {
if (!(obj instanceof Map.Entry)) {
return false;
}
/* The contains method is expecting the search type to be of the
* same type stored. This contract is enforced as a precondition.
* So we can safely suppress type safety warnings below. */
@SuppressWarnings("unchecked")
Map.Entry<String, Object> entry = (Map.Entry<String, Object>) obj;
Entry<String, Object> actual = ContextBase.this.entry(entry.getKey());
if (actual != null) {
return actual.equals(entry);
}
return false;
}
@Override
public boolean isEmpty() {
return ContextBase.this.isEmpty();
}
@Override
public Iterator<Entry<String, Object>> iterator() {
return ContextBase.this.entriesIterator();
}
@Override
public boolean remove(Object obj) {
if (obj instanceof Map.Entry) {
/* The remove method is expecting an input of the the same
* type as the entry set. This precondition is checked above,
* so we can safely suppress the unchecked warnings. */
@SuppressWarnings("unchecked")
Map.Entry<String, Object> entry = (Map.Entry<String, Object>) obj;
return ContextBase.this.remove(entry);
}
return false;
}
@Override
public int size() {
return ContextBase.this.size();
}
}
/**
* <p>Private implementation of <code>Iterator</code> for the
* <code>Set</code> returned by <code>entrySet()</code>.</p>
*/
private class EntrySetIterator implements Iterator<Entry<String, Object>> {
private Map.Entry<String, Object> entry = null;
private Iterator<String> keys = ContextBase.this.keySet().iterator();
public boolean hasNext() {
return keys.hasNext();
}
public Entry<String, Object> next() {
entry = ContextBase.this.entry(keys.next());
return entry;
}
public void remove() {
ContextBase.this.remove(entry);
}
}
/**
* <p>Private implementation of <code>Map.Entry</code> for each item in
* <code>EntrySetImpl</code>.</p>
*/
private class MapEntryImpl implements Map.Entry<String, Object> {
MapEntryImpl(String key, Object value) {
this.key = key;
this.value = value;
}
private String key;
private Object value;
@Override
public boolean equals(Object obj) {
if (obj == null) {
return false;
} else if (!(obj instanceof Map.Entry)) {
return false;
}
Map.Entry<?, ?> entry = (Map.Entry<?, ?>) obj;
if (key == null) {
return entry.getKey() == null;
}
if (key.equals(entry.getKey())) {
if (value == null) {
return entry.getValue() == null;
}
return value.equals(entry.getValue());
}
return false;
}
public String getKey() {
return this.key;
}
public Object getValue() {
return this.value;
}
@Override
public int hashCode() {
return (key == null ? 0 : key.hashCode())
^ (value == null ? 0 : value.hashCode());
}
public Object setValue(Object value) {
Object previous = this.value;
ContextBase.this.put(this.key, value);
this.value = value;
return previous;
}
@Override
public String toString() {
return getKey() + "=" + getValue();
}
}
/**
* <p>Private implementation of <code>Collection</code> that implements the
* semantics required for the value returned by <code>values()</code>.</p>
*/
private class ValuesImpl extends AbstractCollection<Object> {
@Override
public void clear() {
ContextBase.this.clear();
}
@Override
public boolean contains(Object obj) {
if (!(obj instanceof Map.Entry)) {
return false;
}
Map.Entry<?, ?> entry = (Map.Entry<?, ?>) obj;
return ContextBase.this.containsValue(entry.getValue());
}
@Override
public boolean isEmpty() {
return ContextBase.this.isEmpty();
}
@Override
public Iterator<Object> iterator() {
return ContextBase.this.valuesIterator();
}
@Override
public boolean remove(Object obj) {
if (obj instanceof Map.Entry) {
/* We are expecting the passed entry to be of a type
* Entry<String, Object>. This is checked in the precondition
* above, so we can safely suppress unchecked warnings. */
@SuppressWarnings("unchecked")
Map.Entry<String, Object> entry = (Map.Entry<String, Object>) obj;
return ContextBase.this.remove(entry);
}
return false;
}
@Override
public int size() {
return ContextBase.this.size();
}
}
/**
* <p>Private implementation of <code>Iterator</code> for the
* <code>Collection</code> returned by <code>values()</code>.</p>
*/
private class ValuesIterator implements Iterator<Object> {
private Map.Entry<String, Object> entry = null;
private Iterator<String> keys = ContextBase.this.keySet().iterator();
public boolean hasNext() {
return keys.hasNext();
}
public Object next() {
entry = ContextBase.this.entry(keys.next());
return entry.getValue();
}
public void remove() {
ContextBase.this.remove(entry);
}
}
}