KickJava   Java API By Example, From Geeks To Geeks.

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


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): Matthieu Leclercq
22  * Contributor(s):
23  */
24
25 package org.objectweb.dream.queue;
26
27 import org.objectweb.fractal.api.control.AttributeController;
28
29 /**
30  * Base attribute controller interface for queue implementations. It defines a
31  * read only attribute which is the current size of the queue. It defines also
32  * the maximum capacity of the queue. A maximum capacity equals to zero indicate
33  * that their is no capacity limitation.
34  */
35 public interface QueueAttributeController extends AttributeController
36 {
37
38   /**
39    * Returns the current size of the queue.
40    *
41    * @return the current size of the queue.
42    */
43   int getCurrentSize();
44
45   /**
46    * Returns the maximum capacity of the queue.
47    *
48    * @return the maximum capacity of the queue.
49    */
50   int getMaxCapacity();
51
52   /**
53    * Sets the maximum capacity of the queue.
54    *
55    * @param maxCapacity the maximum capacity of the queue.
56    * @throws IllegalArgumentException if <code>maxCapacity</code> is negative.
57    */
58   void setMaxCapacity(int maxCapacity);
59
60 }
Popular Tags