Package org.apache.commons.collections.map

Class TypedMap

  • @Deprecated(since="2021-04-30")
public class TypedMap
extends java.lang.Object
    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.
    Decorates another Map to validate that elements added are of a specific type.

    The validation of additions is performed via an instanceof test against a specified Class. If an object cannot be added to the collection, an IllegalArgumentException is thrown.

    Note that TypedMap is not synchronized and is not thread-safe. If you wish to use this map from multiple threads concurrently, you must use appropriate synchronization. The simplest approach is to wrap this map using Collections.synchronizedMap(Map). This class may throw exceptions when accessed by concurrent threads without synchronization.

    The returned implementation is Serializable from Commons Collections 3.1.

    Since:
    Commons Collections 3.0

    • Method Summary

      All Methods Static Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      static java.util.Map decorate​(java.util.Map map, java.lang.Class keyType, java.lang.Class valueType)
      Deprecated.
      Factory method to create a typed map.

      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Method Detail

      • decorate

        public static java.util.Map decorate​(java.util.Map map,
                                     java.lang.Class keyType,
                                     java.lang.Class valueType)
        Deprecated.
        Factory method to create a typed map.

        If there are any elements already in the map being decorated, they are validated.

        Parameters:
        map - the map to decorate, must not be null
        keyType - the type to allow as keys, must not be null
        valueType - the type to allow as values, must not be null
        Throws:
        java.lang.IllegalArgumentException - if list or type is null
        java.lang.IllegalArgumentException - if the list contains invalid elements