KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > objectweb > dream > queue > List


1 /**
2  * Dream
3  * Copyright (C) 2003-2004 INRIA Rhone-Alpes
4  *
5  * This library is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU Lesser General Public
7  * License as published by the Free Software Foundation; either
8  * version 2 of the License, or (at your option) any later version.
9  *
10  * This library is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13  * Lesser General Public License for more details.
14  *
15  * You should have received a copy of the GNU Lesser General Public
16  * License along with this library; if not, write to the Free Software
17  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18  *
19  * Contact: dream@objectweb.org
20  *
21  * Initial developer(s): Vivien Quema
22  * Contributor(s):
23  */

24
25 package org.objectweb.dream.queue;
26
27 /**
28  * This interface defines methods that must be implemented by a list. Lists can
29  * be used to implement buffers.
30  */

31 public interface List
32 {
33   /** The commonly used name to refer to this interface. */
34   String JavaDoc ITF_NAME = "list";
35
36   /**
37    * Adds the specified element to the list.
38    * <p>
39    *
40    * @param o element to be added to this list.
41    */

42   void add(Object JavaDoc o);
43
44   /**
45    * Removes an object from the list.
46    *
47    * @return the removed object, or <code>null</code> if the list is empty.
48    */

49   Object JavaDoc remove();
50
51   /**
52    * Returns <code>true</code> if the list is empty.
53    *
54    * @return <code>true</code> if the list is empty.
55    */

56   boolean isEmpty();
57 }
Popular Tags