BufferAddFirstLast


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   * adding messages to its begining or to its end.
32   */
33  public interface BufferAddFirstLast
34  {
35    /** The commonly used name to refer to this interface. */
36    String   ITF_NAME = "buffer-add-first-last";
37  
38    /**
39     * Inserts the given message at the beginning of this buffer.
40     * 
41     * @param message the message to be inserted at the beginning of this buffer.
42     * @throws InterruptedException if it is interrupted while waiting for a
43     *           message to be removed.
44     */
45    void addFirst(Message message) throws InterruptedException  ;
46  
47    /**
48     * Inserts the given message at the end of this buffer.
49     * 
50     * @param message the message to be inserted at the end of this buffer.
51     * @throws InterruptedException if it is interrupted while waiting for a
52     *           message to be removed.
53     */
54    void addLast(Message message) throws InterruptedException  ;
55  
56  }
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags