BufferRemoveFirstLast


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  import org.objectweb.dream.message.Message;
28  
29  /**
30   * This interface defines methods that must be implemented by a buffer for
31   * removing messages from its begining or from its end.
32   */
33  public interface BufferRemoveFirstLast
34  {
35    /** The commonly used name to refer to this interface. */
36    String   ITF_NAME = "buffer-remove-first-last";
37  
38    /**
39     * Returns the first message in this buffer. If no message is available, this
40     * method blocks.
41     * 
42     * @return the first message in this list.
43     * @throws InterruptedException if it is interrupted while waiting for a
44     *           message to be added.
45     */
46    Message getFirst() throws InterruptedException  ;
47  
48    /**
49     * Removes and returns the first message from this buffer. If no message is
50     * available, this method blocks.
51     * 
52     * @return the first message from this buffer.
53     * @throws InterruptedException if it is interrupted while waiting for a
54     *           message to be added.
55     */
56    Message removeFirst() throws InterruptedException  ;
57  
58    /**
59     * Returns the last message in this buffer. If no message is available, this
60     * method blocks.
61     * 
62     * @return the last message in this list.
63     * @throws InterruptedException if it is interrupted while waiting for a
64     *           message to be added.
65     */
66    Message getLast() throws InterruptedException  ;
67  
68    /**
69     * Removes and returns the last message from this buffer. If no message is
70     * available, this method blocks.
71     * 
72     * @return the last message from this buffer.
73     * @throws InterruptedException if it is interrupted while waiting for a
74     *           message to be added.
75     */
76    Message removeLast() throws InterruptedException  ;
77  }
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags