View Javadoc

1   /*
2    *  Copyright 2003-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.Map;
19  
20  /***
21   * Defines a map that is bounded in size.
22   * <p/>
23   * The size of the map can vary, but it can never exceed a preset maximum number
24   * of elements. This interface allows the querying of details associated with
25   * the maximum number of elements.
26   *
27   * @author Stephen Colebourne
28   * @version $Revision: 1.2 $ $Date: 2004/10/17 01:02:42 $
29   * @since Commons Collections15 1.0
30   */
31  public interface BoundedMap <K, V> extends Map<K, V>
32  {
33  
34      /***
35       * Returns true if this map is full and no new elements can be added.
36       *
37       * @return <code>true</code> if the map is full
38       */
39      boolean isFull();
40  
41      /***
42       * Gets the maximum size of the map (the bound).
43       *
44       * @return the maximum number of elements the map can hold
45       */
46      int maxSize();
47  }