View Javadoc

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 net.sf.collections15;
17  
18  import java.util.Collection;
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 maximum
24   * number of elements. This interface allows the querying of details associated
25   * with the maximum number of elements.
26   *
27   * @author Herve Quiroz
28   * @author Stephen Colebourne
29   * @version $Revision: 1.2 $ $Date: 2004/10/17 01:02:42 $
30   * @since Commons Collections15 1.0
31   */
32  public interface BoundedCollection <E> extends Collection<E>
33  {
34  
35      /***
36       * Returns true if this collection is full and no new elements can be
37       * added.
38       *
39       * @return <code>true</code> if the collection is full
40       */
41      boolean isFull();
42  
43      /***
44       * Gets the maximum size of the collection (the bound).
45       *
46       * @return the maximum number of elements the collection can hold
47       */
48      int maxSize();
49  
50  }