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: import org.jicarilla.plumbing.Sink;
29:
30: /**
31: * <p>A sink which simply discards any message you send to it (similar to
32: * <code>/dev/null</code> on unix systems). This can be a useful end to
33: * a pipeline where all messages have already been handled and are of no
34: * further use, for example.</p>
35: *
36: * @author <a href="lsimons at jicarilla dot org">Leo Simons</a>
37: * @version $Id: NoopSink.java,v 1.1 2004/03/22 21:20:13 lsimons Exp $
38: */
39: public class NoopSink implements Sink {
40: /**
41: * Discards a message.
42: *
43: * @param o the message that is discarded
44: */
45: public void put(final Object o) {
46: }
47:
48: /**
49: * Discard a message.
50: *
51: * @param o the message that is discarded
52: * @param l an ignored parameter specifying how long we should take in
53: * discarding the message
54: * @return true to indicate the message was discarded.
55: */
56: public boolean offer(final Object o, final long l) {
57: return true;
58: }
59: }
|