Package org.apache.commons.collections4.set

Class UnmodifiableSortedSet<E>

  • Type Parameters:
    E - the type of the elements in this set
    All Implemented Interfaces:
    java.io.Serializable, java.lang.Iterable<E>, java.util.Collection<E>, java.util.Set<E>, java.util.SortedSet<E>, Unmodifiable
    public final class UnmodifiableSortedSet<E>
extends AbstractSortedSetDecorator<E>
implements Unmodifiable
    Decorates another SortedSet to ensure it can't be altered.

    This class is Serializable from Commons Collections 3.1.

    Attempts to modify it will result in an UnsupportedOperationException.

    Since:
    3.0
    See Also:
    Serialized Form

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean add​(E object)  
      boolean addAll​(java.util.Collection<? extends E> coll)  
      void clear()  
      java.util.SortedSet<E> headSet​(E toElement)  
      java.util.Iterator<E> iterator()  
      boolean remove​(java.lang.Object object)  
      boolean removeAll​(java.util.Collection<?> coll)  
      boolean removeIf​(java.util.function.Predicate<? super E> filter)  
      boolean retainAll​(java.util.Collection<?> coll)  
      java.util.SortedSet<E> subSet​(E fromElement, E toElement)  
      java.util.SortedSet<E> tailSet​(E fromElement)  
      static <E> java.util.SortedSet<E> unmodifiableSortedSet​(java.util.SortedSet<E> set)
      Factory method to create an unmodifiable set.

      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait

      • Methods inherited from interface java.util.Collection

        parallelStream, stream, toArray

      • Methods inherited from interface java.lang.Iterable

        forEach

      • Methods inherited from interface java.util.Set

        contains, containsAll, equals, hashCode, isEmpty, size, toArray, toArray

      • Methods inherited from interface java.util.SortedSet

        spliterator

    • Method Detail

      • unmodifiableSortedSet

        public static <E> java.util.SortedSet<E> unmodifiableSortedSet​(java.util.SortedSet<E> set)
        Factory method to create an unmodifiable set.
        Type Parameters:
        E - the element type
        Parameters:
        set - the set to decorate, must not be null
        Returns:
        a new unmodifiable SortedSet
        Throws:
        java.lang.NullPointerException - if set is null
        Since:
        4.0

      • iterator

        public java.util.Iterator<E> iterator()
        Specified by:
        iterator in interface java.util.Collection<E>
        Specified by:
        iterator in interface java.lang.Iterable<E>
        Specified by:
        iterator in interface java.util.Set<E>
        Overrides:
        iterator in class AbstractCollectionDecorator<E>

      • add

        public boolean add​(E object)
        Specified by:
        add in interface java.util.Collection<E>
        Specified by:
        add in interface java.util.Set<E>
        Overrides:
        add in class AbstractCollectionDecorator<E>

      • addAll

        public boolean addAll​(java.util.Collection<? extends E> coll)
        Specified by:
        addAll in interface java.util.Collection<E>
        Specified by:
        addAll in interface java.util.Set<E>
        Overrides:
        addAll in class AbstractCollectionDecorator<E>

      • clear

        public void clear()
        Specified by:
        clear in interface java.util.Collection<E>
        Specified by:
        clear in interface java.util.Set<E>
        Overrides:
        clear in class AbstractCollectionDecorator<E>

      • remove

        public boolean remove​(java.lang.Object object)
        Specified by:
        remove in interface java.util.Collection<E>
        Specified by:
        remove in interface java.util.Set<E>
        Overrides:
        remove in class AbstractCollectionDecorator<E>

      • removeIf

        public boolean removeIf​(java.util.function.Predicate<? super E> filter)
        Specified by:
        removeIf in interface java.util.Collection<E>
        Overrides:
        removeIf in class AbstractCollectionDecorator<E>
        Since:
        4.4

      • removeAll

        public boolean removeAll​(java.util.Collection<?> coll)
        Specified by:
        removeAll in interface java.util.Collection<E>
        Specified by:
        removeAll in interface java.util.Set<E>
        Overrides:
        removeAll in class AbstractCollectionDecorator<E>

      • retainAll

        public boolean retainAll​(java.util.Collection<?> coll)
        Specified by:
        retainAll in interface java.util.Collection<E>
        Specified by:
        retainAll in interface java.util.Set<E>
        Overrides:
        retainAll in class AbstractCollectionDecorator<E>

      • subSet

        public java.util.SortedSet<E> subSet​(E fromElement,
                                     E toElement)
        Specified by:
        subSet in interface java.util.SortedSet<E>
        Overrides:
        subSet in class AbstractSortedSetDecorator<E>

      • headSet

        public java.util.SortedSet<E> headSet​(E toElement)
        Specified by:
        headSet in interface java.util.SortedSet<E>
        Overrides:
        headSet in class AbstractSortedSetDecorator<E>

      • tailSet

        public java.util.SortedSet<E> tailSet​(E fromElement)
        Specified by:
        tailSet in interface java.util.SortedSet<E>
        Overrides:
        tailSet in class AbstractSortedSetDecorator<E>