KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > commons > collections > BoundedCollection


1 /*
2  * Copyright 2002-2004 The Apache Software Foundation
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 package org.apache.commons.collections;
17
18 import java.util.Collection JavaDoc;
19
20 /**
21  * Defines a collection that is bounded in size.
22  * <p>
23  * The size of the collection can vary, but it can never exceed a preset
24  * maximum number of elements. This interface allows the querying of details
25  * associated with the maximum number of elements.
26  *
27  * @see CollectionUtils#isFull
28  * @see CollectionUtils#maxSize
29  *
30  * @since Commons Collections 3.0
31  * @version $Revision: 1.11 $ $Date: 2004/04/14 20:13:11 $
32  *
33  * @author Herve Quiroz
34  * @author Stephen Colebourne
35  */
36 public interface BoundedCollection extends Collection JavaDoc {
37
38     /**
39      * Returns true if this collection is full and no new elements can be added.
40      *
41      * @return <code>true</code> if the collection is full
42      */
43     boolean isFull();
44
45     /**
46      * Gets the maximum size of the collection (the bound).
47      *
48      * @return the maximum number of elements the collection can hold
49      */
50     int maxSize();
51
52 }
53
Popular Tags