Package org.apache.commons.collections

Interface BoundedMap

  • All Superinterfaces:
    java.util.Map
    All Known Implementing Classes:
    FixedSizeMap, FixedSizeSortedMap, LRUMap, SingletonMap
    public interface BoundedMap
extends java.util.Map
    Defines a map that is bounded in size.

    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

    • Nested Class Summary

      • Nested classes/interfaces inherited from interface java.util.Map

        java.util.Map.Entry<K extends java.lang.Object,​V extends java.lang.Object>

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      boolean isFull()
      Returns true if this map is full and no new elements can be added.
      int maxSize()
      Gets the maximum size of the map (the bound).

      • Methods inherited from interface java.util.Map

        clear, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, equals, forEach, get, getOrDefault, hashCode, isEmpty, keySet, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values

    • Method Detail

      • isFull

        boolean isFull()
        Returns true if this map is full and no new elements can be added.
        Returns:
        true if the map is full

      • maxSize

        int maxSize()
        Gets the maximum size of the map (the bound).
        Returns:
        the maximum number of elements the map can hold