KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > net > jforum > util > concurrent > Queue


1 /*
2  * Copyright (c) 2003, Rafael Steil
3  * All rights reserved.
4
5  * Redistribution and use in source and binary forms,
6  * with or without modification, are permitted provided
7  * that the following conditions are met:
8
9  * 1) Redistributions of source code must retain the above
10  * copyright notice, this list of conditions and the
11  * following disclaimer.
12  * 2) Redistributions in binary form must reproduce the
13  * above copyright notice, this list of conditions and
14  * the following disclaimer in the documentation and/or
15  * other materials provided with the distribution.
16  * 3) Neither the name of "Rafael Steil" nor
17  * the names of its contributors may be used to endorse
18  * or promote products derived from this software without
19  * specific prior written permission.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT
22  * HOLDERS AND CONTRIBUTORS "AS IS" AND ANY
23  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING,
24  * BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
25  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR
26  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
27  * THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE
28  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
29  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES
30  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
31  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
32  * OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
33  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
34  * IN CONTRACT, STRICT LIABILITY, OR TORT
35  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
36  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
37  * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE
38  *
39  * This file creation date: Jan 28, 2004
40  * net.jforum.util.concurrent.Queue.java
41  * The JForum Project
42  * http://www.jforum.net
43  *
44  * $Id: Queue.java,v 1.4 2005/07/26 03:05:08 rafaelsteil Exp $
45  */
46 package net.jforum.util.concurrent;
47
48 /**
49  * Interface for thread-safe queues
50  *
51  *@author Rodrigo Kumpera
52  */
53 public interface Queue
54 {
55     /**
56      * Returns the next object, possibly waiting for an object getting available
57      * */
58     Object JavaDoc get() throws InterruptedException JavaDoc;
59     
60     /**
61      * Try to get the next object waiting for a given timeout
62      * */
63     Object JavaDoc pool(long timeout) throws InterruptedException JavaDoc;
64     
65     /**
66      * Put an object on the queue, possiblt waiting for the queue getting available
67      * */
68     void put(Object JavaDoc obj) throws InterruptedException JavaDoc;
69     
70     /**
71      * Try to put the object on the queue
72      * */
73     boolean offer(Object JavaDoc obj, long timeout) throws InterruptedException JavaDoc;
74     
75     /**
76      * Itens on this queue.
77      * */
78     int size();
79 }
80
Popular Tags