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 */
017package org.apache.commons.collections4;
018
019/**
020 * Defines a map that is bounded in size.
021 * <p>
022 * The size of the map can vary, but it can never exceed a preset
023 * maximum number of elements. This interface allows the querying of details
024 * associated with the maximum number of elements.
025 * </p>
026 *
027 * @param <K> the type of the keys in this map
028 * @param <V> the type of the values in this map
029 * @since 3.0
030 */
031public interface BoundedMap<K, V> extends IterableMap<K, V> {
032
033    /**
034     * Returns true if this map is full and no new elements can be added.
035     *
036     * @return <code>true</code> if the map is full
037     */
038    boolean isFull();
039
040    /**
041     * Gets the maximum size of the map (the bound).
042     *
043     * @return the maximum number of elements the map can hold
044     */
045    int maxSize();
046
047}