Package org.apache.commons.collections

Interface BoundedMap

  • All Superinterfaces:
    java.util.Map
    All Known Implementing Classes:
    FixedSizeMap, FixedSizeSortedMap, LRUMap, SingletonMap
    @Deprecated(since="2021-04-30")
public interface BoundedMap
extends java.util.Map
    Deprecated.
    Apache Commons Collections version 3.x is being deprecated from AEMaaCS. The upgraded version 4.4 of Commons Collections is already included as replacement. Customers are advised to upgrade to this version of the library. Please note: the package name was changed to org.apache.commons.collections4. Further note that there are AEM APIs currently exposing the old collections classes; these will be updated in upcoming releases.
    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 Deprecated Methods 
      Modifier and Type Method Description
      boolean isFull()
      Deprecated.
      Returns true if this map is full and no new elements can be added.
      int maxSize()
      Deprecated.
      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()
        Deprecated.
        Returns true if this map is full and no new elements can be added.
        Returns:
        true if the map is full

      • maxSize

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