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 * A SourceSink that gets and sets its values via another
57 * underlying SourceSink. FilteringSourceSink provides hooks
58 * for derived classes to transform the value between its own
59 * get/set interface and that of the underlying SourceSink.
60 *
61 * FilteringSourceSink is used as a base class for any SourceSink
62 * that provides some specific filtering behavior.
63 *
64 * @author Scott Howlett
65 * @version $Revision: 1.2 $
66 */
67 public abstract class FilteringSourceSink extends AbstractSourceSink {
68
69 private SourceSink ss;
70
71 /***
72 * Create a new FilteringSourceSink
73 * @param srcSink The underlying SourceSink.
74 */
75
76 public FilteringSourceSink(SourceSink srcSink) {
77 ss = srcSink;
78 ss.addChangeListener(new ChangeListener() {
79 public void stateChanged(ChangeEvent e) {
80 fireStateChanged();
81 }
82 });
83 }
84
85 /***
86 * Retrieve the value from the underlying SourceSink
87 * after passing it through the readFilter method.
88 */
89 public Object get() {
90 return readFilter(ss.get());
91 }
92
93 /***
94 * Set the value in the underlying SourceSink
95 * after passing it through the writeFilter method.
96 */
97
98 public void set(Object value) {
99 ss.set(writeFilter(value));
100 }
101
102 /***
103 * Transform a value on its way out from the underlying
104 * SourceSink.
105 * @param value The value read from the underlying SourceSink
106 * @return The value to be returned to the caller of this
107 * SourceSink's get() method.
108 */
109 protected abstract Object readFilter(Object value);
110
111 /***
112 * Transform a value on its way into the underlying
113 * SourceSink.
114 * @param value The value passed in by the caller of
115 * this SourceSink's set() method.
116 * @return The value to be written into the underlying
117 * SourceSink.
118 */
119 protected abstract Object writeFilter(Object value);
120 }
This page was automatically generated by Maven