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.ChangeListener;
53
54 /***
55 * A proxy for some value that can be read and written, and to which
56 * interested listeners may subscribe to receive change notification.
57 *
58 * SourceSink serves a similar function to the Swing ListModel and
59 * TreeModel classes in that it abstracts notions of reading,
60 * modifying, and change notification away from the value objects
61 * themselves. But where ListModel and TreeModel perform this
62 * function for values organized in list or tree form, SourceSink
63 * provides it for individual values.
64 *
65 * @author Scott Howlett
66 * @version $Revision: 1.3 $
67 */
68 public interface SourceSink {
69
70 /***
71 * Retrieve some value.
72 * @return a value.
73 */
74 Object get();
75
76 /***
77 * Store some value.
78 * @param value The value to be stored. In general, if a value
79 * is stored via set(), the value retrieved by a subsequent
80 * get() call will equal the set value as defined by the value's
81 * equals() method.
82 */
83 void set(Object value);
84
85 /***
86 * Add the specified listener to the list of interested change
87 * listeners. In general, whenever our value changes (either
88 * a new value is set via the set() method or the existing
89 * value's internal state changes), all subscribed listeners
90 * are notified with a ChangeEvent.
91 * @param l The listener to add.
92 */
93 void addChangeListener(ChangeListener l);
94
95 /***
96 * Remove the specified listener from the list of interested
97 * change listeners.
98 * @param l The listener to remove.
99 */
100 void removeChangeListener(ChangeListener l);
101 }
This page was automatically generated by Maven