summaryrefslogtreecommitdiff
path: root/israfil-foundation-concurrent/src/main/java/net/israfil/foundation/concurrent/AbstractPipe.java
blob: 4c5226a436399f40bafa6ec236ca2358f7d938df (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
/*
 * Copyright (c) 2006, 2007 Israfil Consulting Services Corporation
 * Copyright (c) 2006, 2007 Christian Edward Gruber
 * All Rights Reserved
 * 
 * This software is licensed under the Berkeley Standard Distribution license,
 * (BSD license), as defined below:
 * 
 * Redistribution and use in source and binary forms, with or without 
 * modification, are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice, this 
 *    list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright notice, 
 *    this list of conditions and the following disclaimer in the documentation 
 *    and/or other materials provided with the distribution.
 * 3. Neither the name of Israfil Consulting Services nor the names of its contributors 
 *    may be used to endorse or promote products derived from this software without 
 *    specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND 
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED 
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 
 * IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, 
 * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, 
 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, 
 * OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, 
 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY 
 * OF SUCH DAMAGE.
 * 
 * $Id: Source.java 129 2006-12-31 23:20:02Z cgruber $
 */
package net.israfil.foundation.concurrent;

import java.util.concurrent.BlockingQueue;
import java.util.concurrent.TimeUnit;

/**
 * An object that consumes an object and processes it, then produces the result
 * upon request.  If the processor has no item in processing, it may consume 
 * an item.  If the processor has an item it produces it when requested.  In 
 * the converse cases the behaviour of the object depends on whether the 
 * processor is in its on state or its off state. 
 *
 * @author <a href="mailto:cgruber@israfil.net">Christian Edward Gruber </a>
 */
public abstract class AbstractPipe<I,O> extends AbstractGated implements Pipe<I,O> {

	protected BlockingQueue<I> queue;

	public AbstractPipe() {}

	public BlockingQueue<I> getQueue() { return queue; }
	public void setQueue(BlockingQueue<I> queue) { this.queue = queue; }

	public void consume(I item) {
		try {
			this.consume(item,0,null);
		} catch (InterruptedException e) {
			throw new RuntimeException(e);
		}
	}

	public O produce() {
		try {
			return this.produce(0,null);
		} catch (InterruptedException e) {
			throw new RuntimeException(e);
		}
	}
	
	protected static void validateTimeout(long timeout, TimeUnit unit) {
		if (timeout > 0 && unit == null) 
			throw new IllegalArgumentException("Cannot set a timeout with a null TimeUnit");
	}
}