TShortCharHashMap.TKeyView (Trove 3.0.3)

java.lang.Object
- gnu.trove.map.hash.TShortCharHashMap.TKeyView

All Implemented Interfaces:

TShortSet, TShortCollection

Enclosing class:

TShortCharHashMap
```
protected class TShortCharHashMap.TKeyView
extends java.lang.Object
implements TShortSet
```
a view onto the keys of the map.

Field Summary
- Fields inherited from interface gnu.trove.TShortCollection
  serialVersionUID

Constructor Summary

Constructors
Modifier Constructor Description

protected TKeyView()

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`add(short entry)`	Unsupported when operating upon a Key Set view of a TShortCharMap
`boolean`	`addAll(short[] array)`	Unsupported when operating upon a Key Set view of a TShortCharMap
`boolean`	`addAll(TShortCollection collection)`	Unsupported when operating upon a Key Set view of a TShortCharMap
`boolean`	`addAll(java.util.Collection<? extends java.lang.Short> collection)`	Unsupported when operating upon a Key Set view of a TShortCharMap
`void`	`clear()`	Empties the set.
`boolean`	`contains(short entry)`	Returns `true` if this set contains the specified element.
`boolean`	`containsAll(short[] array)`	Tests the set to determine if all of the elements in `array` are present.
`boolean`	`containsAll(TShortCollection collection)`	Tests the set to determine if all of the elements in `TShortCollection` are present.
`boolean`	`containsAll(java.util.Collection<?> collection)`	Tests the set to determine if all of the elements in `collection` are present.
`boolean`	`equals(java.lang.Object other)`	Compares the specified object with this set for equality.
`boolean`	`forEach(TShortProcedure procedure)`	Executes `procedure` for each element in the set.
`short`	`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.
`TShortIterator`	`iterator()`	Creates an iterator over the values of the set.
`boolean`	`remove(short entry)`	Removes `entry` from the set.
`boolean`	`removeAll(short[] array)`	Removes all of the elements in `array` from the set.
`boolean`	`removeAll(TShortCollection collection)`	Removes all of the elements in `TShortCollection` from the set.
`boolean`	`removeAll(java.util.Collection<?> collection)`	Removes all of the elements in `collection` from the set.
`boolean`	`retainAll(short[] array)`	Removes any values in the set which are not contained in `array`.
`boolean`	`retainAll(TShortCollection collection)`	Removes any values in the set which are not contained in `TShortCollection`.
`boolean`	`retainAll(java.util.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).
`short[]`	`toArray()`	Returns an array containing all of the elements in this set.
`short[]`	`toArray(short[] dest)`	Returns an array containing elements in this set.
`java.lang.String`	`toString()`

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

- Constructor Detail
  - TKeyView
```
protected TKeyView()
```
- Method Detail
  - iterator
```
public TShortIterator iterator()
```
    Creates an iterator over the values of the set. The iterator supports element deletion.
    
    Specified by:
    
    iterator in interface TShortCollection
    
    Specified by:
    
    iterator in interface TShortSet
    
    Returns:
    
    an TShortIterator value
  - getNoEntryValue
```
public short 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 TShortCollection
    
    Specified by:
    
    getNoEntryValue in interface TShortSet
    
    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 TShortCollection
    
    Specified by:
    
    size in interface TShortSet
    
    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 TShortCollection
    
    Specified by:
    
    isEmpty in interface TShortSet
    
    Returns:
    
    true if this set contains no elements
  - contains
```
public boolean contains(short entry)
```
    Returns true if this set contains the specified element.
    
    Specified by:
    
    contains in interface TShortCollection
    
    Specified by:
    
    contains in interface TShortSet
    
    Parameters:
    
    entry - an short value
    
    Returns:
    
    true if the set contains the specified element.
  - toArray
```
public short[] 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 TShortCollection
    
    Specified by:
    
    toArray in interface TShortSet
    
    Returns:
    
    an array containing all the elements in this set
  - toArray
```
public short[] toArray(short[] 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 TShortSet.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 TShortCollection
    
    Specified by:
    
    toArray in interface TShortSet
    
    Parameters:
    
    dest - the array into which the elements of this set are to be stored.
    
    Returns:
    
    an short[] containing all the elements in this set
  - add
```
public boolean add(short entry)
```
    Unsupported when operating upon a Key Set view of a TShortCharMap
    Inserts a value into the set.
    
    Specified by:
    
    add in interface TShortCollection
    
    Specified by:
    
    add in interface TShortSet
    
    Parameters:
    
    entry - a short value
    
    Returns:
    
    true if the set was modified by the add operation
  - remove
```
public boolean remove(short entry)
```
    Removes entry from the set.
    
    Specified by:
    
    remove in interface TShortCollection
    
    Specified by:
    
    remove in interface TShortSet
    
    Parameters:
    
    entry - an short value
    
    Returns:
    
    true if the set was modified by the remove operation.
  - containsAll
```
public boolean containsAll(java.util.Collection<?> collection)
```
    Tests the set to determine if all of the elements in collection are present.
    
    Specified by:
    
    containsAll in interface TShortCollection
    
    Specified by:
    
    containsAll in interface TShortSet
    
    Parameters:
    
    collection - a Collection value
    
    Returns:
    
    true if all elements were present in the set.
  - containsAll
```
public boolean containsAll(TShortCollection collection)
```
    Tests the set to determine if all of the elements in TShortCollection are present.
    
    Specified by:
    
    containsAll in interface TShortCollection
    
    Specified by:
    
    containsAll in interface TShortSet
    
    Parameters:
    
    collection - a TShortCollection value
    
    Returns:
    
    true if all elements were present in the set.
  - containsAll
```
public boolean containsAll(short[] array)
```
    Tests the set to determine if all of the elements in array are present.
    
    Specified by:
    
    containsAll in interface TShortCollection
    
    Specified by:
    
    containsAll in interface TShortSet
    
    Parameters:
    
    array - as array of short primitives.
    
    Returns:
    
    true if all elements were present in the set.
  - addAll
```
public boolean addAll(java.util.Collection<? extends java.lang.Short> collection)
```
    Unsupported when operating upon a Key Set view of a TShortCharMap
    Adds all of the elements in collection to the set.
    
    Specified by:
    
    addAll in interface TShortCollection
    
    Specified by:
    
    addAll in interface TShortSet
    
    Parameters:
    
    collection - a Collection value
    
    Returns:
    
    true if the set was modified by the add all operation.
  - addAll
```
public boolean addAll(TShortCollection collection)
```
    Unsupported when operating upon a Key Set view of a TShortCharMap
    Adds all of the elements in the TShortCollection to the set.
    
    Specified by:
    
    addAll in interface TShortCollection
    
    Specified by:
    
    addAll in interface TShortSet
    
    Parameters:
    
    collection - a TShortCollection value
    
    Returns:
    
    true if the set was modified by the add all operation.
  - addAll
```
public boolean addAll(short[] array)
```
    Unsupported when operating upon a Key Set view of a TShortCharMap
    Adds all of the elements in the array to the set.
    
    Specified by:
    
    addAll in interface TShortCollection
    
    Specified by:
    
    addAll in interface TShortSet
    
    Parameters:
    
    array - a array of short primitives.
    
    Returns:
    
    true if the set was modified by the add all operation.
  - retainAll
```
public boolean retainAll(java.util.Collection<?> collection)
```
    Removes any values in the set which are not contained in collection.
    
    Specified by:
    
    retainAll in interface TShortCollection
    
    Specified by:
    
    retainAll in interface TShortSet
    
    Parameters:
    
    collection - a Collection value
    
    Returns:
    
    true if the set was modified by the retain all operation
  - retainAll
```
public boolean retainAll(TShortCollection collection)
```
    Removes any values in the set which are not contained in TShortCollection.
    
    Specified by:
    
    retainAll in interface TShortCollection
    
    Specified by:
    
    retainAll in interface TShortSet
    
    Parameters:
    
    collection - a TShortCollection value
    
    Returns:
    
    true if the set was modified by the retain all operation
  - retainAll
```
public boolean retainAll(short[] array)
```
    Removes any values in the set which are not contained in array.
    
    Specified by:
    
    retainAll in interface TShortCollection
    
    Specified by:
    
    retainAll in interface TShortSet
    
    Parameters:
    
    array - an array of short primitives.
    
    Returns:
    
    true if the set was modified by the retain all operation
  - removeAll
```
public boolean removeAll(java.util.Collection<?> collection)
```
    Removes all of the elements in collection from the set.
    
    Specified by:
    
    removeAll in interface TShortCollection
    
    Specified by:
    
    removeAll in interface TShortSet
    
    Parameters:
    
    collection - a Collection value
    
    Returns:
    
    true if the set was modified by the remove all operation.
  - removeAll
```
public boolean removeAll(TShortCollection collection)
```
    Removes all of the elements in TShortCollection from the set.
    
    Specified by:
    
    removeAll in interface TShortCollection
    
    Specified by:
    
    removeAll in interface TShortSet
    
    Parameters:
    
    collection - a TShortCollection value
    
    Returns:
    
    true if the set was modified by the remove all operation.
  - removeAll
```
public boolean removeAll(short[] array)
```
    Removes all of the elements in array from the set.
    
    Specified by:
    
    removeAll in interface TShortCollection
    
    Specified by:
    
    removeAll in interface TShortSet
    
    Parameters:
    
    array - an array of short 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 TShortCollection
    
    Specified by:
    
    clear in interface TShortSet
  - forEach
```
public boolean forEach(TShortProcedure procedure)
```
    Executes procedure for each element in the set.
    
    Specified by:
    
    forEach in interface TShortCollection
    
    Specified by:
    
    forEach in interface TShortSet
    
    Parameters:
    
    procedure - a TShortProcedure value
    
    Returns:
    
    false if the loop over the set terminated because the procedure returned false for some value.
  - equals
```
public boolean equals(java.lang.Object other)
```
    Description copied from interface: TShortSet
    
    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 TShortCollection
    
    Specified by:
    
    equals in interface TShortSet
    
    Overrides:
    
    equals in class java.lang.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: TShortSet
    
    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 TShortCollection
    
    Specified by:
    
    hashCode in interface TShortSet
    
    Overrides:
    
    hashCode in class java.lang.Object
    
    Returns:
    
    the hash code value for this set
    
    See Also:
    
    Object.equals(Object), Set.equals(Object)
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class TShortCharHashMap.TKeyView

Field Summary

Fields inherited from interface gnu.trove.TShortCollection

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

TKeyView

Method Detail

iterator

getNoEntryValue

size

isEmpty

contains

toArray

toArray

add

remove

containsAll

containsAll

containsAll

addAll

addAll

addAll

retainAll

retainAll

retainAll

removeAll

removeAll

removeAll

clear

forEach

equals

hashCode

toString