org.apache.commons.collections.set
Class UnmodifiableSortedSet

java.lang.Object
  |
  +--org.apache.commons.collections.collection.AbstractCollectionDecorator
        |
        +--org.apache.commons.collections.set.AbstractSetDecorator
              |
              +--org.apache.commons.collections.set.AbstractSortedSetDecorator
                    |
                    +--org.apache.commons.collections.set.UnmodifiableSortedSet
All Implemented Interfaces:
Collection, Set, SortedSet, Unmodifiable

public final class UnmodifiableSortedSet
extends AbstractSortedSetDecorator
implements Unmodifiable

Decorates another SortedSet to ensure it can't be altered.

Since:
Commons Collections 3.0
Version:
$Revision: 1.4 $ $Date: 2004/01/14 21:43:14 $
Author:
Stephen Colebourne

Fields inherited from class org.apache.commons.collections.collection.AbstractCollectionDecorator
collection
 
Method Summary
 boolean add(Object object)
           
 boolean addAll(Collection coll)
           
 void clear()
           
static SortedSet decorate(SortedSet set)
          Factory method to create an unmodifiable set.
 SortedSet headSet(Object toElement)
           
 Iterator iterator()
           
 boolean remove(Object object)
           
 boolean removeAll(Collection coll)
           
 boolean retainAll(Collection coll)
           
 SortedSet subSet(Object fromElement, Object toElement)
           
 SortedSet tailSet(Object fromElement)
           
 
Methods inherited from class org.apache.commons.collections.set.AbstractSortedSetDecorator
comparator, first, getSortedSet, last
 
Methods inherited from class org.apache.commons.collections.set.AbstractSetDecorator
getSet
 
Methods inherited from class org.apache.commons.collections.collection.AbstractCollectionDecorator
contains, containsAll, equals, getCollection, hashCode, isEmpty, size, toArray, toArray, toString
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface java.util.Set
contains, containsAll, equals, hashCode, isEmpty, size, toArray, toArray
 

Method Detail

decorate

public static SortedSet decorate(SortedSet set)
Factory method to create an unmodifiable set.
Parameters:
set - the set to decorate, must not be null
Throws:
IllegalArgumentException - if set is null

iterator

public Iterator iterator()
Overrides:
iterator in class AbstractCollectionDecorator

add

public boolean add(Object object)
Overrides:
add in class AbstractCollectionDecorator

addAll

public boolean addAll(Collection coll)
Overrides:
addAll in class AbstractCollectionDecorator

clear

public void clear()
Overrides:
clear in class AbstractCollectionDecorator

remove

public boolean remove(Object object)
Overrides:
remove in class AbstractCollectionDecorator

removeAll

public boolean removeAll(Collection coll)
Overrides:
removeAll in class AbstractCollectionDecorator

retainAll

public boolean retainAll(Collection coll)
Overrides:
retainAll in class AbstractCollectionDecorator

subSet

public SortedSet subSet(Object fromElement,
                        Object toElement)
Overrides:
subSet in class AbstractSortedSetDecorator

headSet

public SortedSet headSet(Object toElement)
Overrides:
headSet in class AbstractSortedSetDecorator

tailSet

public SortedSet tailSet(Object fromElement)
Overrides:
tailSet in class AbstractSortedSetDecorator


Copyright © 2001-2004 Apache Software Foundation. All Rights Reserved.