org.apache.commons.collections.map
Class UnmodifiableEntrySet

java.lang.Object
  extended by org.apache.commons.collections.collection.AbstractCollectionDecorator
      extended by org.apache.commons.collections.set.AbstractSetDecorator
          extended by org.apache.commons.collections.map.UnmodifiableEntrySet
All Implemented Interfaces:
java.lang.Iterable, java.util.Collection, java.util.Set, Unmodifiable

public final class UnmodifiableEntrySet
extends AbstractSetDecorator
implements Unmodifiable

Decorates a map entry Set to ensure it can't be altered.

Since:
Commons Collections 3.0
Version:
$Revision: 646777 $ $Date: 2008-04-10 13:33:15 +0100 (Thu, 10 Apr 2008) $
Author:
Stephen Colebourne

Field Summary
 
Fields inherited from class org.apache.commons.collections.collection.AbstractCollectionDecorator
collection
 
Method Summary
 boolean add(java.lang.Object object)
           
 boolean addAll(java.util.Collection coll)
           
 void clear()
           
static java.util.Set decorate(java.util.Set set)
          Factory method to create an unmodifiable set of Map Entry objects.
 java.util.Iterator iterator()
           
 boolean remove(java.lang.Object object)
           
 boolean removeAll(java.util.Collection coll)
           
 boolean retainAll(java.util.Collection coll)
           
 java.lang.Object[] toArray()
           
 java.lang.Object[] toArray(java.lang.Object[] array)
           
 
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, 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
 

Method Detail

decorate

public static java.util.Set decorate(java.util.Set set)
Factory method to create an unmodifiable set of Map Entry objects.

Parameters:
set - the set to decorate, must not be null
Throws:
java.lang.IllegalArgumentException - if set is null

add

public boolean add(java.lang.Object object)
Specified by:
add in interface java.util.Collection
Specified by:
add in interface java.util.Set
Overrides:
add in class AbstractCollectionDecorator

addAll

public boolean addAll(java.util.Collection coll)
Specified by:
addAll in interface java.util.Collection
Specified by:
addAll in interface java.util.Set
Overrides:
addAll in class AbstractCollectionDecorator

clear

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

remove

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

removeAll

public boolean removeAll(java.util.Collection coll)
Specified by:
removeAll in interface java.util.Collection
Specified by:
removeAll in interface java.util.Set
Overrides:
removeAll in class AbstractCollectionDecorator

retainAll

public boolean retainAll(java.util.Collection coll)
Specified by:
retainAll in interface java.util.Collection
Specified by:
retainAll in interface java.util.Set
Overrides:
retainAll in class AbstractCollectionDecorator

iterator

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

toArray

public java.lang.Object[] toArray()
Specified by:
toArray in interface java.util.Collection
Specified by:
toArray in interface java.util.Set
Overrides:
toArray in class AbstractCollectionDecorator

toArray

public java.lang.Object[] toArray(java.lang.Object[] array)
Specified by:
toArray in interface java.util.Collection
Specified by:
toArray in interface java.util.Set
Overrides:
toArray in class AbstractCollectionDecorator


Copyright © 2001-2008 The Apache Software Foundation. All Rights Reserved.