java.util
Class Collections.UnmodifiableMap.UnmodifiableEntrySet

java.lang.Object
  java.util.Collections.UnmodifiableCollection
      java.util.Collections.UnmodifiableSet
          java.util.Collections.UnmodifiableMap.UnmodifiableEntrySet

All Implemented Interfaces:

Collection, Serializable, Set

Enclosing class:

Collections.UnmodifiableMap

static class Collections.UnmodifiableMap.UnmodifiableEntrySet

extends Collections.UnmodifiableSet

We need this class in addition to UnmodifiableSet as Map.Entries themselves permit modification of the backing Map via their setValue operation. This class is subtle: there are many possible attacks that must be thwarted.

See Also:

Serialized Form

Nested Class Summary

private static class

Collections.UnmodifiableMap.UnmodifiableEntrySet.UnmodifiableEntry This "wrapper class" serves two purposes: it prevents the client from modifying the backing Map, by short-circuiting the setValue method, and it protects the backing Map against an ill-behaved Map.Entry that attempts to modify another Map Entry when asked to perform an equality check.

Field Summary

(package private) Collection

c

Constructor Summary

(package private)

Collections.UnmodifiableMap.UnmodifiableEntrySet(Set s)

Method Summary

boolean	add(Object o) Adds the specified element to this set if it is not already present (optional operation).
boolean	addAll(Collection coll) Adds all of the elements in the specified collection to this set if they're not already present (optional operation).
void	clear() Removes all of the elements from this set (optional operation).
boolean	contains(Object o) This method is overridden to protect the backing set against an object with a nefarious equals function that senses that the equality-candidate is Map.Entry and calls its setValue method.
boolean	containsAll(Collection coll) The next two methods are overridden to protect against an unscrupulous List whose contains(Object o) method senses when o is a Map.Entry, and calls o.setValue.
boolean	equals(Object o) Compares the specified object with this set for equality.
int	hashCode() Returns the hash code value for this set.
boolean	isEmpty() Returns true if this set contains no elements.
Iterator	iterator() Returns an iterator over the elements in this set.
boolean	remove(Object o) Removes the specified element from this set if it is present (optional operation).
boolean	removeAll(Collection coll) Removes from this set all of its elements that are contained in the specified collection (optional operation).
boolean	retainAll(Collection coll) Retains only the elements in this set that are contained in the specified collection (optional operation).
int	size() Returns the number of elements in this set (its cardinality).
Object[]	toArray() Returns an array containing all of the elements in this set.
Object[]	toArray(Object[] a) Returns an array containing all of the elements in this set; the runtime type of the returned array is that of the specified array.
String	toString() Returns a string representation of the object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Set

add, addAll, clear, isEmpty, remove, removeAll, retainAll, size

Field Detail

c

Collection c

Constructor Detail

Collections.UnmodifiableMap.UnmodifiableEntrySet

Collections.UnmodifiableMap.UnmodifiableEntrySet(Set s)

Method Detail

iterator

public Iterator iterator()

Description copied from interface: Set

Returns an iterator over the elements in this set. The elements are returned in no particular order (unless this set is an instance of some class that provides a guarantee).

Specified by:

iterator in interface Set

Overrides:

iterator in class Collections.UnmodifiableCollection

toArray

public Object[] toArray()

Description copied from interface: Set

Returns an array containing all of the elements in this set. Obeys the general contract of the Collection.toArray method.

Specified by:

toArray in interface Set

Overrides:

toArray in class Collections.UnmodifiableCollection

toArray

public Object[] toArray(Object[] a)

Description copied from interface: Set

Returns an array containing all of the elements in this set; the runtime type of the returned array is that of the specified array. Obeys the general contract of the Collection.toArray(Object[]) method.

Specified by:

toArray in interface Set

Overrides:

toArray in class Collections.UnmodifiableCollection

contains

public boolean contains(Object o)

This method is overridden to protect the backing set against an object with a nefarious equals function that senses that the equality-candidate is Map.Entry and calls its setValue method.

Specified by:

contains in interface Set

Overrides:

contains in class Collections.UnmodifiableCollection

containsAll

public boolean containsAll(Collection coll)

The next two methods are overridden to protect against an unscrupulous List whose contains(Object o) method senses when o is a Map.Entry, and calls o.setValue.

Specified by:

containsAll in interface Set

Overrides:

containsAll in class Collections.UnmodifiableCollection

equals

public boolean equals(Object o)

Description copied from interface: Set

Compares the specified object with this set for equality. Returns true if the specified object is also a set, the two sets have the same size, and every member of the specified set is contained in this set (or equivalently, every member of this set is contained in the specified set). This definition ensures that the equals method works properly across different implementations of the set interface.

Specified by:

equals in interface Set

Overrides:

equals in class Collections.UnmodifiableSet

hashCode

public int hashCode()

Description copied from interface: Set

Returns the hash code value for this set. The hash code of a set is defined to be the sum of the hash codes of the elements in the set, where the hashcode of a null element is defined to be zero. This ensures that s1.equals(s2) implies that s1.hashCode()==s2.hashCode() for any two sets s1 and s2, as required by the general contract of the Object.hashCode method.

Specified by:

hashCode in interface Set

Overrides:

hashCode in class Object

Returns:

a hash code value for this object.

See Also:

Object.equals(java.lang.Object), Hashtable

size

public int size()

Description copied from interface: Collection

Returns the number of elements in this collection. If this collection contains more than Integer.MAX_VALUE elements, returns Integer.MAX_VALUE.

Specified by:

size in interface Collection

Returns:

the number of elements in this collection

isEmpty

public boolean isEmpty()

Description copied from interface: Collection

Returns true if this collection contains no elements.

Specified by:

isEmpty in interface Collection

Returns:

true if this collection contains no elements

toString

public String toString()

Description copied from class: Object

Returns a string representation of the object. In general, the toString method returns a string that "textually represents" this object. The result should be a concise but informative representation that is easy for a person to read. It is recommended that all subclasses override this method.

The toString method for class Object returns a string consisting of the name of the class of which the object is an instance, the at-sign character `@', and the unsigned hexadecimal representation of the hash code of the object. In other words, this method returns a string equal to the value of:

 getClass().getName() + '@' + Integer.toHexString(hashCode())
 

Overrides:

toString in class Object

Returns:

a string representation of the object.

add

public boolean add(Object o)

Description copied from interface: Collection

Ensures that this collection contains the specified element (optional operation). Returns true if this collection changed as a result of the call. (Returns false if this collection does not permit duplicates and already contains the specified element.)

Collections that support this operation may place limitations on what elements may be added to this collection. In particular, some collections will refuse to add null elements, and others will impose restrictions on the type of elements that may be added. Collection classes should clearly specify in their documentation any restrictions on what elements may be added.

If a collection refuses to add a particular element for any reason other than that it already contains the element, it must throw an exception (rather than returning false). This preserves the invariant that a collection always contains the specified element after this call returns.

Specified by:

add in interface Collection

Parameters:

o - element whose presence in this collection is to be ensured.

Returns:

true if this collection changed as a result of the call

remove

public boolean remove(Object o)

Description copied from interface: Collection

Removes a single instance of the specified element from this collection, if it is present (optional operation). More formally, removes an element e such that (o==null ? e==null : o.equals(e)), if this collection contains one or more such elements. Returns true if this collection contained the specified element (or equivalently, if this collection changed as a result of the call).

Specified by:

remove in interface Collection

Parameters:

o - element to be removed from this collection, if present.

Returns:

true if this collection changed as a result of the call

addAll

public boolean addAll(Collection coll)

Description copied from interface: Collection

Adds all of the elements in the specified collection to this collection (optional operation). The behavior of this operation is undefined if the specified collection is modified while the operation is in progress. (This implies that the behavior of this call is undefined if the specified collection is this collection, and this collection is nonempty.)

Specified by:

addAll in interface Collection

Parameters:

coll - elements to be inserted into this collection.

Returns:

true if this collection changed as a result of the call

See Also:

Collection.add(Object)

removeAll

public boolean removeAll(Collection coll)

Description copied from interface: Collection

Removes all this collection's elements that are also contained in the specified collection (optional operation). After this call returns, this collection will contain no elements in common with the specified collection.

Specified by:

removeAll in interface Collection

Parameters:

coll - elements to be removed from this collection.

Returns:

true if this collection changed as a result of the call

See Also:

Collection.remove(Object), Collection.contains(Object)

retainAll

public boolean retainAll(Collection coll)

Description copied from interface: Collection

Retains only the elements in this collection that are contained in the specified collection (optional operation). In other words, removes from this collection all of its elements that are not contained in the specified collection.

Specified by:

retainAll in interface Collection

Parameters:

coll - elements to be retained in this collection.

Returns:

true if this collection changed as a result of the call

See Also:

Collection.remove(Object), Collection.contains(Object)

clear

public void clear()

Description copied from interface: Collection

Removes all of the elements from this collection (optional operation). This collection will be empty after this method returns unless it throws an exception.

Specified by:

clear in interface Collection