TIntHashSetDecorator

java.lang.Object
- java.util.AbstractCollection<E>
- - java.util.AbstractSet<Integer>
  - - gnu.trove.decorator.TIntHashSetDecorator

All Implemented Interfaces:

Iterable<Integer>, Collection<Integer>, Set<Integer>
```
public class TIntHashSetDecorator
extends AbstractSet<Integer>
implements Set<Integer>
```
Wrapper class to make a TIntHashSet conform to the java.util.Set API. This class simply decorates an underlying TIntHashSet and translates the Object-based APIs into their Trove primitive analogs.

Note that wrapping and unwrapping primitive values is extremely inefficient. If possible, users of this class should override the appropriate methods in this class and use a table of canonical values.

Created: Tue Sep 24 22:08:17 PDT 2002

Field Summary

Fields

Modifier and Type	Field and Description
`protected TIntHashSet`	`_set` the wrapped primitive set

Constructor Summary

Constructors

Constructor and Description
`TIntHashSetDecorator(TIntHashSet set)` Creates a wrapper that decorates the specified primitive set.

Method Summary

All Methods

Instance Methods

Concrete Methods
Modifier and Type	Method and Description
`boolean`	`add(Integer value)` Inserts a value into the set.
`void`	`clear()` Empties the set.
`TIntHashSetDecorator`	`clone()` Clones the underlying trove collection and returns the clone wrapped in a new decorator instance.
`boolean`	`equals(Object other)` Compares this set with another set for equality of their stored entries.
`TIntHashSet`	`getSet()` Returns a reference to the set wrapped by this decorator.
`boolean`	`isEmpty()` Indicates whether set has any entries.
`Iterator<Integer>`	`iterator()` Creates an iterator over the values of the set.
`boolean`	`remove(Object value)` Deletes a value from the set.
`int`	`size()` Returns the number of entries in the set.
`protected int`	`unwrap(Object value)` Unwraps a value
`protected Integer`	`wrap(int k)` Wraps a value

Methods inherited from class java.util.AbstractSet
hashCode, removeAll

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

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

Methods inherited from interface java.util.Set
addAll, contains, containsAll, hashCode, removeAll, retainAll, spliterator, toArray, toArray

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

Methods inherited from interface java.lang.Iterable
forEach

- Field Detail
  - _set
```
protected TIntHashSet _set
```
    the wrapped primitive set
- Constructor Detail
  - TIntHashSetDecorator
```
public TIntHashSetDecorator(TIntHashSet set)
```
    Creates a wrapper that decorates the specified primitive set.
- Method Detail
  - getSet
```
public TIntHashSet getSet()
```
    Returns a reference to the set wrapped by this decorator.
  - clone
```
public TIntHashSetDecorator clone()
```
    Clones the underlying trove collection and returns the clone wrapped in a new decorator instance. This is a shallow clone except where primitives are concerned.
    
    Overrides:
    
    clone in class Object
    
    Returns:
    
    a copy of the receiver
  - add
```
public boolean add(Integer value)
```
    Inserts a value into the set.
    
    Specified by:
    
    add in interface Collection<Integer>
    
    Specified by:
    
    add in interface Set<Integer>
    
    Overrides:
    
    add in class AbstractCollection<Integer>
    
    Parameters:
    
    value - true if the set was modified by the insertion
  - equals
```
public boolean equals(Object other)
```
    Compares this set with another set for equality of their stored entries.
    
    Specified by:
    
    equals in interface Collection<Integer>
    
    Specified by:
    
    equals in interface Set<Integer>
    
    Overrides:
    
    equals in class AbstractSet<Integer>
    
    Parameters:
    
    other - an Object value
    
    Returns:
    
    true if the sets are identical
  - clear
```
public void clear()
```
    Empties the set.
  - remove
```
public boolean remove(Object value)
```
    Deletes a value from the set.
    
    Specified by:
    
    remove in interface Collection<Integer>
    
    Specified by:
    
    remove in interface Set<Integer>
    
    Overrides:
    
    remove in class AbstractCollection<Integer>
    
    Parameters:
    
    value - an Object value
    
    Returns:
    
    true if the set was modified
  - iterator
```
public Iterator<Integer> iterator()
```
    Creates an iterator over the values of the set.
    
    Specified by:
    
    iterator in interface Iterable<Integer>
    
    Specified by:
    
    iterator in interface Collection<Integer>
    
    Specified by:
    
    iterator in interface Set<Integer>
    
    Specified by:
    
    iterator in class AbstractCollection<Integer>
    
    Returns:
    
    an iterator with support for removals in the underlying set
  - size
```
public int size()
```
    Returns the number of entries in the set.
    
    Specified by:
    
    size in interface Collection<Integer>
    
    Specified by:
    
    size in interface Set<Integer>
    
    Specified by:
    
    size in class AbstractCollection<Integer>
    
    Returns:
    
    the set's size.
  - isEmpty
```
public boolean isEmpty()
```
    Indicates whether set has any entries.
    
    Specified by:
    
    isEmpty in interface Collection<Integer>
    
    Specified by:
    
    isEmpty in interface Set<Integer>
    
    Overrides:
    
    isEmpty in class AbstractCollection<Integer>
    
    Returns:
    
    true if the set is empty
  - wrap
```
protected Integer wrap(int k)
```
    Wraps a value
    
    Parameters:
    
    k - value in the underlying set
    
    Returns:
    
    an Object representation of the value
  - unwrap
```
protected int unwrap(Object value)
```
    Unwraps a value
    
    Parameters:
    
    value - wrapped value
    
    Returns:
    
    an unwrapped representation of the value

Class TIntHashSetDecorator

Field Summary

Fields

Constructor Summary

Constructors

Method Summary

Methods inherited from class java.util.AbstractSet

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

Field Detail

_set

Constructor Detail

TIntHashSetDecorator

Method Detail

getSet

clone

add

equals

clear

remove

iterator

size

isEmpty

wrap

unwrap