Package gnu.trove.map.hash

# Class TLongLongHashMap.TKeyView

java.lang.Object
gnu.trove.map.hash.TLongLongHashMap.TKeyView

All Implemented Interfaces:
  `TLongSet`, `TLongCollection`

Enclosing class:
  `TLongLongHashMap`

protected class TLongLongHashMap.TKeyView extends Object implements TLongSet
a view onto the keys of the map.

## Field Summary

### Fields inherited from interface gnu.trove.TLongCollection

`serialVersionUID`

## Constructor Summary

Constructors
Modifier
Constructor
Description
`protected`
`TKeyView()`

## Method Summary

Modifier and Type
Method
Description
`boolean`
`add(long entry)`
Unsupported when operating upon a Key Set view of a TLongLongMap
`boolean`
`addAll(long[] array)`
Unsupported when operating upon a Key Set view of a TLongLongMap
`boolean`
`addAll(TLongCollection collection)`
Unsupported when operating upon a Key Set view of a TLongLongMap
`boolean`
`addAll(Collection<? extends Long> collection)`
Unsupported when operating upon a Key Set view of a TLongLongMap
`void`
`clear()`
Empties the set.
`boolean`
`contains(long entry)`
Returns `true` if this set contains the specified element.
`boolean`
`containsAll(long[] array)`
Tests the set to determine if all of the elements in `array` are present.
`boolean`
`containsAll(TLongCollection collection)`
Tests the set to determine if all of the elements in `TLongCollection` are present.
`boolean`
`containsAll(Collection<?> collection)`
Tests the set to determine if all of the elements in `collection` are present.
`boolean`
`equals(Object other)`
Compares the specified object with this set for equality.
`boolean`
`forEach(TLongProcedure procedure)`
Executes `procedure` for each element in the set.
`long`
`getNoEntryValue()`
Returns the value that is used to represent null.
`int`
`hashCode()`
Returns the hash code value for this set.
`boolean`
`isEmpty()`
Returns `true` if this set contains no elements.
`TLongIterator`
`iterator()`
Creates an iterator over the values of the set.
`boolean`
`remove(long entry)`
Removes `entry` from the set.
`boolean`
`removeAll(long[] array)`
Removes all of the elements in `array` from the set.
`boolean`
`removeAll(TLongCollection collection)`
Removes all of the elements in `TLongCollection` from the set.
`boolean`
`removeAll(Collection<?> collection)`
Removes all of the elements in `collection` from the set.
`boolean`
`retainAll(long[] array)`
Removes any values in the set which are not contained in `array`.
`boolean`
`retainAll(TLongCollection collection)`
Removes any values in the set which are not contained in `TLongCollection`.
`boolean`
`retainAll(Collection<?> collection)`
Removes any values in the set which are not contained in `collection`.
`int`
`size()`
Returns the number of elements in this set (its cardinality).
`long[]`
`toArray()`
Returns an array containing all of the elements in this set.
`long[]`
`toArray(long[] dest)`
Returns an array containing elements in this set.
`String`
`toString()`

### Methods inherited from class java.lang.Object

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

## Constructor Details

### TKeyView

protected TKeyView()

## Method Details

### iterator

public TLongIterator iterator()
Creates an iterator over the values of the set. The iterator supports element deletion.

Specified by:
  `iterator` in interface `TLongCollection`
Specified by:
  `iterator` in interface `TLongSet`
Returns:
  an `TLongIterator` value

### getNoEntryValue

public long getNoEntryValue()
Returns the value that is used to represent null. The default value is generally zero, but can be changed during construction of the collection.

Specified by:
  `getNoEntryValue` in interface `TLongCollection`
Specified by:
  `getNoEntryValue` in interface `TLongSet`
Returns:
  the value that represents null

### size

public int 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`.

Specified by:
  `size` in interface `TLongCollection`
Specified by:
  `size` in interface `TLongSet`
Returns:
  the number of elements in this set (its cardinality)

### isEmpty

public boolean isEmpty()
Returns `true` if this set contains no elements.

Specified by:
  `isEmpty` in interface `TLongCollection`
Specified by:
  `isEmpty` in interface `TLongSet`
Returns:
  `true` if this set contains no elements

### contains

public boolean contains(long entry)
Returns `true` if this set contains the specified element.

Specified by:
  `contains` in interface `TLongCollection`
Specified by:
  `contains` in interface `TLongSet`
Parameters:
  `entry` - an `long` value
Returns:
  true if the set contains the specified element.

### toArray

public long[] toArray()
Returns an array containing all of the elements in this set. If this set makes any guarantees as to what order its elements are returned by its iterator, this method must return the elements in the same order.

The returned array will be "safe" in that no references to it are maintained by this set. (In other words, this method must allocate a new array even if this set is backed by an array). The caller is thus free to modify the returned array.

This method acts as bridge between array-based and collection-based APIs.

Specified by:
  `toArray` in interface `TLongCollection`
Specified by:
  `toArray` in interface `TLongSet`
Returns:
  an array containing all the elements in this set

### toArray

public long[] toArray(long[] dest)
Returns an array containing elements in this set.

If this set fits in the specified array with room to spare (i.e., the array has more elements than this set), the element in the array immediately following the end of the set is set to ``TLongSet.getNoEntryValue()``. (This is useful in determining the length of this set only if the caller knows that this set does not contain any elements representing null.)

If the native array is smaller than the set size, the array will be filled with elements in Iterator order until it is full and exclude the remainder.

If this set makes any guarantees as to what order its elements are returned by its iterator, this method must return the elements in the same order.

Specified by:
  `toArray` in interface `TLongCollection`
Specified by:
  `toArray` in interface `TLongSet`
Parameters:
  `dest` - the array into which the elements of this set are to be stored.
Returns:
  an `long[]` containing all the elements in this set

### add

public boolean add(long entry)
Unsupported when operating upon a Key Set view of a TLongLongMap

Inserts a value into the set.

Specified by:
  `add` in interface `TLongCollection`
Specified by:
  `add` in interface `TLongSet`
Parameters:
  `entry` - a `long` value
Returns:
  true if the set was modified by the add operation

### remove

public boolean remove(long entry)
Removes `entry` from the set.

Specified by:
  `remove` in interface `TLongCollection`
Specified by:
  `remove` in interface `TLongSet`
Parameters:
  `entry` - an `long` value
Returns:
  true if the set was modified by the remove operation.

### containsAll

public boolean containsAll(Collection<?> collection)
Tests the set to determine if all of the elements in `collection` are present.

Specified by:
  `containsAll` in interface `TLongCollection`
Specified by:
  `containsAll` in interface `TLongSet`
Parameters:
  `collection` - a `Collection` value
Returns:
  true if all elements were present in the set.

### containsAll

public boolean containsAll(TLongCollection collection)
Tests the set to determine if all of the elements in `TLongCollection` are present.

Specified by:
  `containsAll` in interface `TLongCollection`
Specified by:
  `containsAll` in interface `TLongSet`
Parameters:
  `collection` - a `TLongCollection` value
Returns:
  true if all elements were present in the set.

### containsAll

public boolean containsAll(long[] array)
Tests the set to determine if all of the elements in `array` are present.

Specified by:
  `containsAll` in interface `TLongCollection`
Specified by:
  `containsAll` in interface `TLongSet`
Parameters:
  `array` - as `array` of long primitives.
Returns:
  true if all elements were present in the set.

### addAll

public boolean addAll(Collection<? extends Long> collection)
Unsupported when operating upon a Key Set view of a TLongLongMap

Adds all of the elements in `collection` to the set.

Specified by:
  `addAll` in interface `TLongCollection`
Specified by:
  `addAll` in interface `TLongSet`
Parameters:
  `collection` - a `Collection` value
Returns:
  true if the set was modified by the add all operation.

### addAll

public boolean addAll(TLongCollection collection)
Unsupported when operating upon a Key Set view of a TLongLongMap

Adds all of the elements in the `TLongCollection` to the set.

Specified by:
  `addAll` in interface `TLongCollection`
Specified by:
  `addAll` in interface `TLongSet`
Parameters:
  `collection` - a `TLongCollection` value
Returns:
  true if the set was modified by the add all operation.

### addAll

public boolean addAll(long[] array)
Unsupported when operating upon a Key Set view of a TLongLongMap

Adds all of the elements in the `array` to the set.

Specified by:
  `addAll` in interface `TLongCollection`
Specified by:
  `addAll` in interface `TLongSet`
Parameters:
  `array` - a `array` of long primitives.
Returns:
  true if the set was modified by the add all operation.

### retainAll

public boolean retainAll(Collection<?> collection)
Removes any values in the set which are not contained in `collection`.

Specified by:
  `retainAll` in interface `TLongCollection`
Specified by:
  `retainAll` in interface `TLongSet`
Parameters:
  `collection` - a `Collection` value
Returns:
  true if the set was modified by the retain all operation

### retainAll

public boolean retainAll(TLongCollection collection)
Removes any values in the set which are not contained in `TLongCollection`.

Specified by:
  `retainAll` in interface `TLongCollection`
Specified by:
  `retainAll` in interface `TLongSet`
Parameters:
  `collection` - a `TLongCollection` value
Returns:
  true if the set was modified by the retain all operation

### retainAll

public boolean retainAll(long[] array)
Removes any values in the set which are not contained in `array`.

Specified by:
  `retainAll` in interface `TLongCollection`
Specified by:
  `retainAll` in interface `TLongSet`
Parameters:
  `array` - an `array` of long primitives.
Returns:
  true if the set was modified by the retain all operation

### removeAll

public boolean removeAll(Collection<?> collection)
Removes all of the elements in `collection` from the set.

Specified by:
  `removeAll` in interface `TLongCollection`
Specified by:
  `removeAll` in interface `TLongSet`
Parameters:
  `collection` - a `Collection` value
Returns:
  true if the set was modified by the remove all operation.

### removeAll

public boolean removeAll(TLongCollection collection)
Removes all of the elements in `TLongCollection` from the set.

Specified by:
  `removeAll` in interface `TLongCollection`
Specified by:
  `removeAll` in interface `TLongSet`
Parameters:
  `collection` - a `TLongCollection` value
Returns:
  true if the set was modified by the remove all operation.

### removeAll

public boolean removeAll(long[] array)
Removes all of the elements in `array` from the set.

Specified by:
  `removeAll` in interface `TLongCollection`
Specified by:
  `removeAll` in interface `TLongSet`
Parameters:
  `array` - an `array` of long primitives.
Returns:
  true if the set was modified by the remove all operation.

### clear

public void clear()
Empties the set.

Specified by:
  `clear` in interface `TLongCollection`
Specified by:
  `clear` in interface `TLongSet`

### forEach

public boolean forEach(TLongProcedure procedure)
Executes `procedure` for each element in the set.

Specified by:
  `forEach` in interface `TLongCollection`
Specified by:
  `forEach` in interface `TLongSet`
Parameters:
  `procedure` - a `TLongProcedure` value
Returns:
  false if the loop over the set terminated because the procedure returned false for some value.

### equals

public boolean equals(Object other)
Description copied from interface: `TLongSet`
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 `TLongCollection`
Specified by:
  `equals` in interface `TLongSet`
Overrides:
  `equals` in class `Object`
Parameters:
  `other` - object to be compared for equality with this set
Returns:
  `true` if the specified object is equal to this set

### hashCode

public int hashCode()
Description copied from interface: `TLongSet`
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. 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 `Object.hashCode()`.

Specified by:
  `hashCode` in interface `TLongCollection`
Specified by:
  `hashCode` in interface `TLongSet`
Overrides:
  `hashCode` in class `Object`
Returns:
  the hash code value for this set
See Also:
  - `Object.equals(Object)`
  - `Set.equals(Object)`

### toString

public String toString()

Overrides:
  `toString` in class `Object`