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 *      https://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
018package org.apache.commons.collections4;
019
020/**
021 * Defines a map that is bounded in size.
022 * <p>
023 * 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
024 * 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} 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}