KickJava   Java API By Example, From Geeks To Geeks.

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


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 that allows
29  * getting/removing messages from the end or beginning of the list.
30  */

31 public interface ListRemoveFirstLast
32 {
33   /** The commonly used name to refer to this interface. */
34   String JavaDoc ITF_NAME = "list-remove-first-last";
35
36   /**
37    * Returns the first element in this list.
38    *
39    * @return the first element in this list.
40    * @throws java.util.NoSuchElementException if this list is empty.
41    */

42   Object JavaDoc getFirst();
43
44   /**
45    * Returns the last element in this list.
46    *
47    * @return the last element in this list.
48    * @throws java.util.NoSuchElementException if this list is empty.
49    */

50   Object JavaDoc getLast();
51
52   /**
53    * Removes and returns the first element from this list.
54    *
55    * @return the first element from this list.
56    */

57   Object JavaDoc removeFirst();
58
59   /**
60    * Removes and returns the last element from this list.
61    *
62    * @return the last element from this list.
63    */

64   Object JavaDoc removeLast();
65 }
Popular Tags