mchange-commons-java 0.3.1 · com.mchange.v1.identicator.IdHashSet

Modifier and Type	Field and Description
pack-priv Identicator	id
pack-priv HashSet<E>	inner

Access	Constructor and Description
private	IdHashSet(HashSet<E> inner, Identicator id)
public	IdHashSet(Identicator id)
public	IdHashSet(Collection<E> c, Identicator id)
public	IdHashSet(int initialCapacity, float loadFactor, Identicator id)
public	IdHashSet(int initialCapacity, Identicator id)

Method Summary

Modifier and Type	Method and Description
public boolean	add(Object element to be added to this set o) Overrides java.util.AbstractCollection.add. Implements java.util.Set.add, java.util.Collection.add. Adds the specified element to this set if it is not already present (optional operation).
public void	clear() Overrides java.util.AbstractCollection.clear. Implements java.util.Set.clear, java.util.Collection.clear. Removes all of the elements from this set (optional operation).
public boolean	contains(Object element whose presence in this set is to be tested o) Overrides java.util.AbstractCollection.contains. Implements java.util.Set.contains, java.util.Collection.contains. Returns `true` if this set contains the specified element.
private IdHashKey	createKey(Object o)
public Iterator<E>	iterator() Implements abstract java.util.AbstractCollection.iterator. Implements java.util.Set.iterator, java.util.Collection.iterator. Returns an iterator over the elements in this set.
public boolean	remove(Object object to be removed from this set, if present o) Overrides java.util.AbstractCollection.remove. Implements java.util.Set.remove, java.util.Collection.remove. Removes the specified element from this set if it is present (optional operation).
public int	size() Implements abstract java.util.AbstractCollection.size. Implements java.util.Set.size, java.util.Collection.size. Returns the number of elements in this set (its cardinality).

Inherited from java.util.AbstractSet:: equals hashCode removeAll

id	back to summary
pack-priv Identicator id

inner	back to summary
pack-priv HashSet<E> inner

IdHashSet	back to summary
private IdHashSet(HashSet<E> inner, Identicator id)

IdHashSet	back to summary
public IdHashSet(Identicator id)

IdHashSet	back to summary
public IdHashSet(Collection<E> c, Identicator id)

IdHashSet	back to summary
public IdHashSet(int initialCapacity, float loadFactor, Identicator id)

IdHashSet	back to summary
public IdHashSet(int initialCapacity, Identicator id)

Method Detail

add back to summary

add	back to summary
public boolean add(Object o) Overrides java.util.AbstractCollection.add. Implements java.util.Set.add, java.util.Collection.add. Doc from java.util.Set.add. 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 `Objects.equals(e, 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. Parameters o:Object element to be added to this set Returns:boolean `true` if this set did not already contain the specified element

public boolean add(Object o)

Overrides java.util.AbstractCollection.add.

Implements java.util.Set.add, java.util.Collection.add.

Doc from java.util.Set.add.

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 Objects.equals(e, 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.

Parameters

o:Object: element to be added to this set

Returns:boolean

true if this set did not already contain the specified element

clear	back to summary
public void clear() Overrides java.util.AbstractCollection.clear. Implements java.util.Set.clear, java.util.Collection.clear. Doc from java.util.Set.clear. Removes all of the elements from this set (optional operation). The set will be empty after this call returns.

clear

back to summary

public void clear()

Overrides java.util.AbstractCollection.clear.

Implements java.util.Set.clear, java.util.Collection.clear.

Doc from java.util.Set.clear.

Removes all of the elements from this set (optional operation). The set will be empty after this call returns.

contains back to summary

contains	back to summary
public boolean contains(Object o) Overrides java.util.AbstractCollection.contains. Implements java.util.Set.contains, java.util.Collection.contains. Doc from java.util.Set.contains. Returns `true` if this set contains the specified element. More formally, returns `true` if and only if this set contains an element `e` such that `Objects.equals(o, e)`. Parameters o:Object element whose presence in this set is to be tested Returns:boolean `true` if this set contains the specified element

public boolean contains(Object o)

Overrides java.util.AbstractCollection.contains.

Implements java.util.Set.contains, java.util.Collection.contains.

Doc from java.util.Set.contains.

Returns true if this set contains the specified element. More formally, returns true if and only if this set contains an element e such that Objects.equals(o, e).

Parameters

o:Object: element whose presence in this set is to be tested

Returns:boolean

true if this set contains the specified element

createKey	back to summary
private IdHashKey createKey(Object o)

iterator	back to summary
public Iterator<E> iterator() Implements abstract java.util.AbstractCollection.iterator. Implements java.util.Set.iterator, java.util.Collection.iterator. Doc from java.util.Set.iterator. 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). Returns:Iterator<E> an iterator over the elements in this set

iterator

back to summary

public Iterator<E> iterator()

Implements abstract java.util.AbstractCollection.iterator.

Implements java.util.Set.iterator, java.util.Collection.iterator.

Doc from java.util.Set.iterator.

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).

Returns:Iterator<E>: an iterator over the elements in this set

remove back to summary

remove	back to summary
public boolean remove(Object o) Overrides java.util.AbstractCollection.remove. Implements java.util.Set.remove, java.util.Collection.remove. Doc from java.util.Set.remove. Removes the specified element from this set if it is present (optional operation). More formally, removes an element `e` such that `Objects.equals(o, e)`, if this set contains such an element. Returns `true` if this set contained the element (or equivalently, if this set changed as a result of the call). (This set will not contain the element once the call returns.) Parameters o:Object object to be removed from this set, if present Returns:boolean `true` if this set contained the specified element

public boolean remove(Object o)

Overrides java.util.AbstractCollection.remove.

Implements java.util.Set.remove, java.util.Collection.remove.

Doc from java.util.Set.remove.

Removes the specified element from this set if it is present (optional operation). More formally, removes an element e such that Objects.equals(o, e), if this set contains such an element. Returns true if this set contained the element (or equivalently, if this set changed as a result of the call). (This set will not contain the element once the call returns.)

Parameters

o:Object: object to be removed from this set, if present

Returns:boolean

true if this set contained the specified element

size back to summary

size	back to summary
public int size() Implements abstract java.util.AbstractCollection.size. Implements java.util.Set.size, java.util.Collection.size. Doc from java.util.Set.size. Returns the number of elements in this set (its cardinality). If this set contains more than `Integer.MAX_VALUE` elements, returns `Integer.MAX_VALUE`. Returns:int the number of elements in this set (its cardinality)

public int size()

Implements abstract java.util.AbstractCollection.size.

Implements java.util.Set.size, java.util.Collection.size.

Doc from java.util.Set.size.

Returns the number of elements in this set (its cardinality). If this set contains more than Integer.MAX_VALUE elements, returns Integer.MAX_VALUE.

Returns:int: the number of elements in this set (its cardinality)

public Class IdHashSet

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail