View Javadoc
1 /*
2 * Copyright (c) 2003 Scott Howlett & Paul Libbrecht.
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 *
9 * 1. Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 *
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in
14 * the documentation and/or other materials provided with the
15 * distribution.
16 *
17 * 3. The end-user documentation included with the redistribution,
18 * if any, must include the following acknowledgment:
19 * "This product includes software developed by the Xwing
20 * Project ( http://xwing.sourceforge.net/ )."
21 * Alternately, this acknowledgment may appear in the software itself,
22 * if and wherever such third-party acknowledgments normally appear.
23 *
24 * 4. The name "Xwing" must not be used to endorse or promote products
25 * derived from this software without prior written permission. For
26 * written permission, please contact the project authors via
27 * the Xwing project site, http://xwing.sourceforge.net/ .
28 *
29 * 5. Products derived from this software may not be called "Xwing",
30 * nor may "Xwing" appear in their name, without prior written
31 * permission of the Xwing project.
32 *
33 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
34 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
35 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
36 * DISCLAIMED. IN NO EVENT SHALL THE XWING AUTHORS OR THE PROJECT
37 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
38 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
39 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
40 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
41 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
42 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
43 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
44 * SUCH DAMAGE.
45 *
46 * For more information on Xwing, please see
47 * < http://xwing.sourceforge.net/ >.
48 */
49
50 package net.sourceforge.xwing;
51
52 import javax.swing.event.ChangeEvent;
53 import javax.swing.event.ChangeListener;
54
55
56 /***
57 * A SourceSink that caches values retrieved from an underlying
58 * SourceSink. Cached values are held by this SourceSink until
59 * it receives notification from the underlying SourceSink that
60 * its value has changed.
61 * Blah blah blah
62 *
63 * @author Scott Howlett
64 * @version $Revision: 1.2 $
65 */
66
67 public class CachingSourceSink extends AbstractSourceSink {
68
69 private SourceSink ss;
70 private boolean dirty;
71 private Object cachedState;
72
73 /***
74 * Create a new CachingSourceSink.
75 * @param srcSink The underlying SourceSink whose value
76 * should be cached.
77 */
78 public CachingSourceSink(SourceSink srcSink) {
79 ss = srcSink;
80 dirty = true;
81
82 ss.addChangeListener(new ChangeListener() {
83 public void stateChanged(ChangeEvent e) {
84 clearCache();
85 fireStateChanged();
86 }
87 });
88 }
89
90 public synchronized Object get() {
91 if (dirty) {
92 cachedState = ss.get();
93 dirty = false;
94 }
95 return cachedState;
96 }
97
98 public void set(Object newValue) {
99 ss.set(newValue);
100 }
101
102 private synchronized void clearCache() {
103 dirty = true;
104 cachedState = null;
105 }
106
107 }
This page was automatically generated by Maven