001 /* 002 * Licensed to the Apache Software Foundation (ASF) under one or more 003 * contributor license agreements. See the NOTICE file distributed with 004 * this work for additional information regarding copyright ownership. 005 * The ASF licenses this file to You under the Apache License, Version 2.0 006 * (the "License"); you may not use this file except in compliance with 007 * the License. You may obtain a copy of the License at 008 * 009 * http://www.apache.org/licenses/LICENSE-2.0 010 * 011 * Unless required by applicable law or agreed to in writing, software 012 * distributed under the License is distributed on an "AS IS" BASIS, 013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 014 * See the License for the specific language governing permissions and 015 * limitations under the License. 016 */ 017 package org.apache.commons.collections; 018 019 import java.util.Map; 020 021 /** 022 * Defines a map that is bounded in size. 023 * <p> 024 * The size of the map can vary, but it can never exceed a preset 025 * maximum number of elements. This interface allows the querying of details 026 * associated with the maximum number of elements. 027 * 028 * @since Commons Collections 3.0 029 * @version $Revision: 646777 $ $Date: 2008-04-10 13:33:15 +0100 (Thu, 10 Apr 2008) $ 030 * 031 * @author Stephen Colebourne 032 */ 033 public interface BoundedMap extends Map { 034 035 /** 036 * Returns true if this map is full and no new elements can be added. 037 * 038 * @return <code>true</code> if the map is full 039 */ 040 boolean isFull(); 041 042 /** 043 * Gets the maximum size of the map (the bound). 044 * 045 * @return the maximum number of elements the map can hold 046 */ 047 int maxSize(); 048 049 }