Package org.apache.commons.collections.collection

Class SynchronizedCollection

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Iterable, java.util.Collection
    Direct Known Subclasses:
    SynchronizedBag, SynchronizedBuffer, SynchronizedList, SynchronizedSet, SynchronizedSortedSet
    @Deprecated(since="2021-04-30")
public class SynchronizedCollection
extends java.lang.Object
implements java.util.Collection, java.io.Serializable
    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 Collection to synchronize its behaviour for a multi-threaded environment.

    Iterators must be manually synchronized: 

      synchronized (coll) {
    Iterator it = coll.iterator();
    // do stuff with iterator
  }

    This class is Serializable from Commons Collections 3.1.

    Since:
    Commons Collections 3.0
    See Also:
    Serialized Form

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      boolean add​(java.lang.Object object)
      Deprecated.
       
      boolean addAll​(java.util.Collection coll)
      Deprecated.
       
      void clear()
      Deprecated.
       
      boolean contains​(java.lang.Object object)
      Deprecated.
       
      boolean containsAll​(java.util.Collection coll)
      Deprecated.
       
      static java.util.Collection decorate​(java.util.Collection coll)
      Deprecated.
      Factory method to create a synchronized collection.
      boolean equals​(java.lang.Object object)
      Deprecated.
       
      int hashCode()
      Deprecated.
       
      boolean isEmpty()
      Deprecated.
       
      java.util.Iterator iterator()
      Deprecated.
      Iterators must be manually synchronized.
      boolean remove​(java.lang.Object object)
      Deprecated.
       
      boolean removeAll​(java.util.Collection coll)
      Deprecated.
       
      boolean retainAll​(java.util.Collection coll)
      Deprecated.
       
      int size()
      Deprecated.
       
      java.lang.Object[] toArray()
      Deprecated.
       
      java.lang.Object[] toArray​(java.lang.Object[] object)
      Deprecated.
       
      java.lang.String toString()
      Deprecated.
       

      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait

      • Methods inherited from interface java.util.Collection

        parallelStream, removeIf, spliterator, stream, toArray

      • Methods inherited from interface java.lang.Iterable

        forEach

    • Method Detail

      • decorate

        public static java.util.Collection decorate​(java.util.Collection coll)
        Deprecated.
        Factory method to create a synchronized collection.
        Parameters:
        coll - the collection to decorate, must not be null
        Returns:
        a new synchronized collection
        Throws:
        java.lang.IllegalArgumentException - if collection is null

      • add

        public boolean add​(java.lang.Object object)
        Deprecated.
        Specified by:
        add in interface java.util.Collection

      • addAll

        public boolean addAll​(java.util.Collection coll)
        Deprecated.
        Specified by:
        addAll in interface java.util.Collection

      • clear

        public void clear()
        Deprecated.
        Specified by:
        clear in interface java.util.Collection

      • contains

        public boolean contains​(java.lang.Object object)
        Deprecated.
        Specified by:
        contains in interface java.util.Collection

      • containsAll

        public boolean containsAll​(java.util.Collection coll)
        Deprecated.
        Specified by:
        containsAll in interface java.util.Collection

      • isEmpty

        public boolean isEmpty()
        Deprecated.
        Specified by:
        isEmpty in interface java.util.Collection

      • iterator

        public java.util.Iterator iterator()
        Deprecated.
        Iterators must be manually synchronized. 
         synchronized (coll) {
   Iterator it = coll.iterator();
   // do stuff with iterator
 }
        Specified by:
        iterator in interface java.util.Collection
        Specified by:
        iterator in interface java.lang.Iterable
        Returns:
        an iterator that must be manually synchronized on the collection

      • toArray

        public java.lang.Object[] toArray()
        Deprecated.
        Specified by:
        toArray in interface java.util.Collection

      • toArray

        public java.lang.Object[] toArray​(java.lang.Object[] object)
        Deprecated.
        Specified by:
        toArray in interface java.util.Collection

      • remove

        public boolean remove​(java.lang.Object object)
        Deprecated.
        Specified by:
        remove in interface java.util.Collection

      • removeAll

        public boolean removeAll​(java.util.Collection coll)
        Deprecated.
        Specified by:
        removeAll in interface java.util.Collection

      • retainAll

        public boolean retainAll​(java.util.Collection coll)
        Deprecated.
        Specified by:
        retainAll in interface java.util.Collection

      • size

        public int size()
        Deprecated.
        Specified by:
        size in interface java.util.Collection

      • equals

        public boolean equals​(java.lang.Object object)
        Deprecated.
        Specified by:
        equals in interface java.util.Collection
        Overrides:
        equals in class java.lang.Object

      • hashCode

        public int hashCode()
        Deprecated.
        Specified by:
        hashCode in interface java.util.Collection
        Overrides:
        hashCode in class java.lang.Object

      • toString

        public java.lang.String toString()
        Deprecated.
        Overrides:
        toString in class java.lang.Object