1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one or more
3 * contributor license agreements. See the NOTICE file distributed with
4 * this work for additional information regarding copyright ownership.
5 * The ASF licenses this file to You under the Apache License, Version 2.0
6 * (the "License"); you may not use this file except in compliance with
7 * the License. You may obtain a copy of the License at
8 *
9 * https://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 */
17
18 package org.apache.commons.collections4;
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 of elements. This interface allows the querying of details associated with the
24 * maximum number of elements.
25 * </p>
26 *
27 * @param <K> The type of the keys in this map.
28 * @param <V> The type of the values in this map.
29 * @since 3.0
30 */
31 public interface BoundedMap<K, V> extends IterableMap<K, V> {
32
33 /**
34 * Returns true if this map is full and no new elements can be added.
35 *
36 * @return {@code true} if the map is full.
37 */
38 boolean isFull();
39
40 /**
41 * Gets the maximum size of the map (the bound).
42 *
43 * @return The maximum number of elements the map can hold.
44 */
45 int maxSize();
46 }