org.magicwerk.brownies.collections

Class KeyCollectionAsSet<E>

java.lang.Object

org.magicwerk.brownies.collections.CollectionAsSet<E>

org.magicwerk.brownies.collections.KeyCollectionAsSet<E>

All Implemented Interfaces:

java.io.Serializable, java.lang.Iterable<E>, java.util.Collection<E>, java.util.Set<E>

public class KeyCollectionAsSet<E>
extends CollectionAsSet<E>
implements java.io.Serializable

Implements a Set based on a Collection.

Version:

$Id: KeyCollectionAsSet.java 1914 2013-10-15 22:51:28Z origo $

Author:

Thomas Mauch

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
KeyCollectionAsSet(KeyCollectionImpl<E> coll, boolean immutable)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	add(E e) Adds the specified element to this set if it is not already present (optional operation).
boolean	addAll(java.util.Collection<? extends E> c) Adds all of the elements in the specified collection to this set if they're not already present (optional operation).

Methods inherited from class org.magicwerk.brownies.collections.CollectionAsSet

clear, contains, containsAll, equals, hashCode, isEmpty, iterator, remove, removeAll, retainAll, size, toArray, toArray, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

KeyCollectionAsSet

public KeyCollectionAsSet(KeyCollectionImpl<E> coll,
                  boolean immutable)

Method Detail

add

public boolean add(E e)

Description copied from interface: java.util.Set

Adds the specified element to this set if it is not already present (optional operation). More formally, adds the specified element e to this set if the set contains no element e2 such that (e==null ? e2==null : e.equals(e2)). If this set already contains the element, the call leaves the set unchanged and returns false. In combination with the restriction on constructors, this ensures that sets never contain duplicate elements.

The stipulation above does not imply that sets must accept all elements; sets may refuse to add any particular element, including null, and throw an exception, as described in the specification for Collection.add. Individual set implementations should clearly document any restrictions on the elements that they may contain.

Specified by:

add in interface java.util.Collection<E>

Specified by:

add in interface java.util.Set<E>

Overrides:

add in class CollectionAsSet<E>

Parameters:

e - element to be added to this set

Returns:

true if this set did not already contain the specified element

addAll

public boolean addAll(java.util.Collection<? extends E> c)

Description copied from interface: java.util.Set

Adds all of the elements in the specified collection to this set if they're not already present (optional operation). If the specified collection is also a set, the addAll operation effectively modifies this set so that its value is the union of the two sets. The behavior of this operation is undefined if the specified collection is modified while the operation is in progress.

Specified by:

addAll in interface java.util.Collection<E>

Specified by:

addAll in interface java.util.Set<E>

Overrides:

addAll in class CollectionAsSet<E>

Parameters:

c - collection containing elements to be added to this set

Returns:

true if this set changed as a result of the call

See Also:

Set.add(Object)