| /* |
| * Licensed to the Apache Software Foundation (ASF) under one or more |
| * contributor license agreements. See the NOTICE file distributed with |
| * this work for additional information regarding copyright ownership. |
| * The ASF licenses this file to You under the Apache License, Version 2.0 |
| * (the "License"); you may not use this file except in compliance with |
| * the License. You may obtain a copy of the License at |
| * |
| * http://www.apache.org/licenses/LICENSE-2.0 |
| * |
| * Unless required by applicable law or agreed to in writing, software |
| * distributed under the License is distributed on an "AS IS" BASIS, |
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| * See the License for the specific language governing permissions and |
| * limitations under the License. |
| */ |
| package org.apache.commons.collections; |
| |
| /** |
| * Defines a map that is bounded in size. |
| * <p> |
| * The size of the map can vary, but it can never exceed a preset |
| * maximum number of elements. This interface allows the querying of details |
| * associated with the maximum number of elements. |
| * |
| * @since Commons Collections 3.0 |
| * @version $Revision$ $Date$ |
| * |
| * @author Stephen Colebourne |
| */ |
| public interface BoundedMap<K, V> extends IterableMap<K, V> { |
| |
| /** |
| * Returns true if this map is full and no new elements can be added. |
| * |
| * @return <code>true</code> if the map is full |
| */ |
| boolean isFull(); |
| |
| /** |
| * Gets the maximum size of the map (the bound). |
| * |
| * @return the maximum number of elements the map can hold |
| */ |
| int maxSize(); |
| |
| } |