IdentityHashSet (EclipseLink 2.6.3, "build v20160428-59c81c5" API Reference)

java.lang.Object
- java.util.AbstractCollection
- - org.eclipse.persistence.internal.helper.IdentityHashSet

All Implemented Interfaces:: Serializable, Cloneable, Iterable, Collection, Set

public class IdentityHashSet
extends AbstractCollection
implements Set, Cloneable, Serializable

See Also:: Serialized Form

Constructor Summary

Constructors
Constructor and Description
`IdentityHashSet()` Constructs a new `IdentityHashSet` with a default initial capacity of `32` and a loadfactor of `0.75`.
`IdentityHashSet(Collection c)` Constructs a new `IdentityHashSet` with the same contents as the given `Collection`.
`IdentityHashSet(int initialCapacity)` Constructs a new `IdentityHashSet` with the given initial capacity and a default loadFactor of `0.75`.
`IdentityHashSet(int initialCapacity, float loadFactor)` Constructs a new `IdentityHashSet` with the given initial capacity and the given loadFactor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`add(Object obj)` Adds the given object to this `IdentityHashSet`.
`void`	`clear()` Removes all of the objects from this `IdentityHashSet`.
`Object`	`clone()` Returns a shallow copy of this `IdentityHashSet` (the elements are not cloned).
`boolean`	`contains(Object obj)` Returns `true` if this `IdentityHashSet` contains the given object.
`boolean`	`isEmpty()`
`Iterator`	`iterator()` Get an iterator for this `IdentityHashSet`
`boolean`	`remove(Object obj)` Removes the given object from this `IdentityHashSet`, if present.
`boolean`	`removeAll(Collection c)` This implementation throws an `UnsupportedOperationException` because `removeAll` does not work correctly with reference equality testing.
`boolean`	`retainAll(Collection c)` This implementation throws an `UnsupportedOperationException`.
`int`	`size()`

Methods inherited from class java.util.AbstractCollection
addAll, containsAll, toArray, toArray, toString

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Set
addAll, containsAll, equals, hashCode, spliterator, toArray, toArray

Methods inherited from interface java.util.Collection
parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable
forEach

- Constructor Detail
  - IdentityHashSet
```
public IdentityHashSet(int initialCapacity,
                       float loadFactor)
```
    Constructs a new IdentityHashSet with the given initial capacity and the given loadFactor.
    
    Parameters:
    
    initialCapacity - the initial capacity of the IdentityHashSet.
    
    loadFactor - the loadFactor of the IdentityHashSet.
    
    Throws:
    
    IllegalArgumentException - if the initial capacity is less than zero, or if the loadFactor is nonpositive.
  - IdentityHashSet
```
public IdentityHashSet(int initialCapacity)
```
    Constructs a new IdentityHashSet with the given initial capacity and a default loadFactor of 0.75.
    
    Parameters:
    
    initialCapacity - the initial capacity of the IdentityHashSet.
    
    Throws:
    
    IllegalArgumentException - if the initial capacity is less than zero.
  - IdentityHashSet
```
public IdentityHashSet()
```
    Constructs a new IdentityHashSet with a default initial capacity of 32 and a loadfactor of 0.75.
  - IdentityHashSet
```
public IdentityHashSet(Collection c)
```
    Constructs a new IdentityHashSet with the same contents as the given Collection. The new IdentityHashSet is created with an initial capacity sufficient to hold the elements of the given Collection.
    
    Parameters:
    
    c - the Collection whose contents are to be placed in the new IdentityHashSet.
- Method Detail
  - size
```
public int size()
```
    Specified by:
    
    size in interface Collection
    
    Specified by:
    
    size in interface Set
    
    Specified by:
    
    size in class AbstractCollection
    
    Returns:
    
    the size of this IdentityHashSet.
  - isEmpty
```
public boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface Collection
    
    Specified by:
    
    isEmpty in interface Set
    
    Overrides:
    
    isEmpty in class AbstractCollection
    
    Returns:
    
    true if this IdentityHashSet is empty.
  - contains
```
public boolean contains(Object obj)
```
    Returns true if this IdentityHashSet contains the given object.
    
    Specified by:
    
    contains in interface Collection
    
    Specified by:
    
    contains in interface Set
    
    Overrides:
    
    contains in class AbstractCollection
    
    Parameters:
    
    obj - the object to find.
    
    Returns:
    
    true if this IdentityHashSet contains obj by reference.
  - add
```
public boolean add(Object obj)
```
    Adds the given object to this IdentityHashSet.
    
    Specified by:
    
    add in interface Collection
    
    Specified by:
    
    add in interface Set
    
    Overrides:
    
    add in class AbstractCollection
    
    Parameters:
    
    obj - object to add.
    
    Returns:
    
    true if this IdentityHashSet did not already contain obj.
    
    Throws:
    
    NullPointerException - if obj is null.
  - remove
```
public boolean remove(Object obj)
```
    Removes the given object from this IdentityHashSet, if present.
    
    Specified by:
    
    remove in interface Collection
    
    Specified by:
    
    remove in interface Set
    
    Overrides:
    
    remove in class AbstractCollection
    
    Parameters:
    
    obj - the object to be removed from this IdentityHashSet.
    
    Returns:
    
    true if this IdentityHashSet contained obj.
  - removeAll
```
public boolean removeAll(Collection c)
```
    This implementation throws an UnsupportedOperationException because removeAll does not work correctly with reference equality testing.
    
    Specified by:
    
    removeAll in interface Collection
    
    Specified by:
    
    removeAll in interface Set
    
    Overrides:
    
    removeAll in class AbstractCollection
  - retainAll
```
public boolean retainAll(Collection c)
```
    This implementation throws an UnsupportedOperationException. The Javadocs for AbstractCollection indicates that retainAll is an optional method.
    
    Specified by:
    
    retainAll in interface Collection
    
    Specified by:
    
    retainAll in interface Set
    
    Overrides:
    
    retainAll in class AbstractCollection
  - clear
```
public void clear()
```
    Removes all of the objects from this IdentityHashSet.
    
    Specified by:
    
    clear in interface Collection
    
    Specified by:
    
    clear in interface Set
    
    Overrides:
    
    clear in class AbstractCollection
  - clone
```
public Object clone()
```
    Returns a shallow copy of this IdentityHashSet (the elements are not cloned).
    
    Overrides:
    
    clone in class Object
    
    Returns:
    
    a shallow copy of this IdentityHashSet.
  - iterator
```
public Iterator iterator()
```
    Get an iterator for this IdentityHashSet
    
    Specified by:
    
    iterator in interface Iterable
    
    Specified by:
    
    iterator in interface Collection
    
    Specified by:
    
    iterator in interface Set
    
    Specified by:
    
    iterator in class AbstractCollection

Class IdentityHashSet

Constructor Summary

Method Summary

Methods inherited from class java.util.AbstractCollection

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Set

Methods inherited from interface java.util.Collection

Methods inherited from interface java.lang.Iterable

Constructor Detail

IdentityHashSet

IdentityHashSet

IdentityHashSet

IdentityHashSet

Method Detail

size

isEmpty

contains

add

remove

removeAll

retainAll

clear

clone

iterator