01: /* ====================================================================
02: The Jicarilla Software License
03:
04: Copyright (c) 2003 Leo Simons.
05: All rights reserved.
06:
07: Permission is hereby granted, free of charge, to any person obtaining
08: a copy of this software and associated documentation files (the
09: "Software"), to deal in the Software without restriction, including
10: without limitation the rights to use, copy, modify, merge, publish,
11: distribute, sublicense, and/or sell copies of the Software, and to
12: permit persons to whom the Software is furnished to do so, subject to
13: the following conditions:
14:
15: The above copyright notice and this permission notice shall be
16: included in all copies or substantial portions of the Software.
17:
18: THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
19: EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
20: MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
21: IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
22: CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
23: TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
24: SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
25: ==================================================================== */
26: package org.jicarilla.plumbing;
27:
28: /**
29: * <p>Combines multiple sources into a single one. A collector is used in the
30: * event pipeline pumbling to combine multiple sources and form a single new
31: * one. Each <code>get()</code> performed on the Collector will retrieve an
32: * element from one of the sources the Collector contains. From wich source an
33: * element will be retrieved is implementation-specific, though the
34: * implementation should strive to make sure that no starvation occurs. In
35: * diagram form:</p>
36: *
37: * <pre>
38: * +---------------+
39: * |Collector |
40: * addSource() |+---------+ |
41: * ------> ||Source |-\ |
42: * |+---------+ | |
43: * |+---------+ | |
44: * ||Source |->--|--> get() / poll()
45: * |+---------+ | |
46: * |+---------+ | |
47: * ||Source |-/ |
48: * |+---------+ |
49: * +---------------+
50: * </pre>
51: *
52: * @author <a href="lsimons at jicarilla dot org">Leo Simons</a>
53: * @version $Id: Collector.java,v 1.1 2004/03/22 21:20:13 lsimons Exp $
54: */
55: public interface Collector extends Source {
56: /**
57: * Connect a Source to this collector. It is okay to connect the same
58: * source multiple times.
59: *
60: * @param source the source to connect.
61: */
62: void addSource(Source source);
63: }
|