TShortCharHashMap.TValueView (Trove 3.0.3)

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

All Implemented Interfaces:

TCharCollection

Enclosing class:

TShortCharHashMap
```
protected class TShortCharHashMap.TValueView
extends java.lang.Object
implements TCharCollection
```
a view onto the values of the map.

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

Constructor Summary

Constructors
Modifier Constructor and Description

protected TValueView()

Constructors
Modifier	Constructor and Description
`protected`	`TValueView()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`add(char entry)` Inserts a value into the collection.
`boolean`	`addAll(char[] array)` Adds all of the elements in the `array` to the collection.
`boolean`	`addAll(java.util.Collection<? extends java.lang.Character> collection)` Adds all of the elements in `collection` to the collection.
`boolean`	`addAll(TCharCollection collection)` Adds all of the elements in the `TCharCollection` to the collection.
`void`	`clear()` Empties the collection.
`boolean`	`contains(char entry)` Returns `true` if this collection contains the specified element.
`boolean`	`containsAll(char[] array)` Tests the collection to determine if all of the elements in `array` are present.
`boolean`	`containsAll(java.util.Collection<?> collection)` Tests the collection to determine if all of the elements in `collection` are present.
`boolean`	`containsAll(TCharCollection collection)` Tests the collection to determine if all of the elements in `TCharCollection` are present.
`boolean`	`forEach(TCharProcedure procedure)` Executes `procedure` for each element in the collection.
`char`	`getNoEntryValue()` Returns the value that is used to represent null.
`boolean`	`isEmpty()` Returns `true` if this collection contains no elements.
`TCharIterator`	`iterator()` Creates an iterator over the values of the collection.
`boolean`	`remove(char entry)` Removes `entry` from the collection.
`boolean`	`removeAll(char[] array)` Removes all of the elements in `array` from the collection.
`boolean`	`removeAll(java.util.Collection<?> collection)` Removes all of the elements in `collection` from the collection.
`boolean`	`removeAll(TCharCollection collection)` Removes all of the elements in `TCharCollection` from the collection.
`boolean`	`retainAll(char[] array)` Removes any values in the collection which are not contained in `array`.
`boolean`	`retainAll(java.util.Collection<?> collection)` Removes any values in the collection which are not contained in `collection`.
`boolean`	`retainAll(TCharCollection collection)` Removes any values in the collection which are not contained in `TCharCollection`.
`int`	`size()` Returns the number of elements in this collection (its cardinality).
`char[]`	`toArray()` Returns an array containing all of the elements in this collection.
`char[]`	`toArray(char[] dest)` Returns an array containing elements in this collection.
`java.lang.String`	`toString()`

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

Methods inherited from interface gnu.trove.TCharCollection
equals, hashCode

- Constructor Detail
  - TValueView
```
protected TValueView()
```
- Method Detail
  - iterator
```
public TCharIterator iterator()
```
    Creates an iterator over the values of the collection. The iterator supports element deletion.
    
    Specified by:
    
    iterator in interface TCharCollection
    
    Returns:
    
    an TCharIterator value
  - getNoEntryValue
```
public char 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 TCharCollection
    
    Returns:
    
    the value that represents null
  - size
```
public int size()
```
    Returns the number of elements in this collection (its cardinality). If this collection contains more than Integer.MAX_VALUE elements, returns Integer.MAX_VALUE.
    
    Specified by:
    
    size in interface TCharCollection
    
    Returns:
    
    the number of elements in this collection (its cardinality)
  - isEmpty
```
public boolean isEmpty()
```
    Returns true if this collection contains no elements.
    
    Specified by:
    
    isEmpty in interface TCharCollection
    
    Returns:
    
    true if this collection contains no elements
  - contains
```
public boolean contains(char entry)
```
    Returns true if this collection contains the specified element.
    
    Specified by:
    
    contains in interface TCharCollection
    
    Parameters:
    
    entry - an char value
    
    Returns:
    
    true if the collection contains the specified element.
  - toArray
```
public char[] toArray()
```
    Returns an array containing all of the elements in this collection. If this collection 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 collection. (In other words, this method must allocate a new array even if this collection 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 TCharCollection
    
    Returns:
    
    an array containing all the elements in this collection
  - toArray
```
public char[] toArray(char[] dest)
```
    Returns an array containing elements in this collection.
    If this collection fits in the specified array with room to spare (i.e., the array has more elements than this collection), the element in the array immediately following the end of the collection is collection to TCharCollection.getNoEntryValue(). (This is useful in determining the length of this collection only if the caller knows that this collection does not contain any elements representing null.)
    If the native array is smaller than the collection size, the array will be filled with elements in Iterator order until it is full and exclude the remainder.
    If this collection 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 TCharCollection
    
    Parameters:
    
    dest - the array into which the elements of this collection are to be stored.
    
    Returns:
    
    an char[] containing all the elements in this collection
  - add
```
public boolean add(char entry)
```
    Description copied from interface: TCharCollection
    
    Inserts a value into the collection.
    
    Specified by:
    
    add in interface TCharCollection
    
    Parameters:
    
    entry - a char value
    
    Returns:
    
    true if the collection was modified by the add operation
  - remove
```
public boolean remove(char entry)
```
    Removes entry from the collection.
    
    Specified by:
    
    remove in interface TCharCollection
    
    Parameters:
    
    entry - an char value
    
    Returns:
    
    true if the collection was modified by the remove operation.
  - containsAll
```
public boolean containsAll(java.util.Collection<?> collection)
```
    Tests the collection to determine if all of the elements in collection are present.
    
    Specified by:
    
    containsAll in interface TCharCollection
    
    Parameters:
    
    collection - a Collection value
    
    Returns:
    
    true if all elements were present in the collection.
  - containsAll
```
public boolean containsAll(TCharCollection collection)
```
    Tests the collection to determine if all of the elements in TCharCollection are present.
    
    Specified by:
    
    containsAll in interface TCharCollection
    
    Parameters:
    
    collection - a TCharCollection value
    
    Returns:
    
    true if all elements were present in the collection.
  - containsAll
```
public boolean containsAll(char[] array)
```
    Tests the collection to determine if all of the elements in array are present.
    
    Specified by:
    
    containsAll in interface TCharCollection
    
    Parameters:
    
    array - as array of char primitives.
    
    Returns:
    
    true if all elements were present in the collection.
  - addAll
```
public boolean addAll(java.util.Collection<? extends java.lang.Character> collection)
```
    Adds all of the elements in collection to the collection.
    
    Specified by:
    
    addAll in interface TCharCollection
    
    Parameters:
    
    collection - a Collection value
    
    Returns:
    
    true if the collection was modified by the add all operation.
  - addAll
```
public boolean addAll(TCharCollection collection)
```
    Adds all of the elements in the TCharCollection to the collection.
    
    Specified by:
    
    addAll in interface TCharCollection
    
    Parameters:
    
    collection - a TCharCollection value
    
    Returns:
    
    true if the collection was modified by the add all operation.
  - addAll
```
public boolean addAll(char[] array)
```
    Adds all of the elements in the array to the collection.
    
    Specified by:
    
    addAll in interface TCharCollection
    
    Parameters:
    
    array - a array of char primitives.
    
    Returns:
    
    true if the collection was modified by the add all operation.
  - retainAll
```
public boolean retainAll(java.util.Collection<?> collection)
```
    Removes any values in the collection which are not contained in collection.
    
    Specified by:
    
    retainAll in interface TCharCollection
    
    Parameters:
    
    collection - a Collection value
    
    Returns:
    
    true if the collection was modified by the retain all operation
  - retainAll
```
public boolean retainAll(TCharCollection collection)
```
    Removes any values in the collection which are not contained in TCharCollection.
    
    Specified by:
    
    retainAll in interface TCharCollection
    
    Parameters:
    
    collection - a TCharCollection value
    
    Returns:
    
    true if the collection was modified by the retain all operation
  - retainAll
```
public boolean retainAll(char[] array)
```
    Removes any values in the collection which are not contained in array.
    
    Specified by:
    
    retainAll in interface TCharCollection
    
    Parameters:
    
    array - an array of char primitives.
    
    Returns:
    
    true if the collection was modified by the retain all operation
  - removeAll
```
public boolean removeAll(java.util.Collection<?> collection)
```
    Removes all of the elements in collection from the collection.
    
    Specified by:
    
    removeAll in interface TCharCollection
    
    Parameters:
    
    collection - a Collection value
    
    Returns:
    
    true if the collection was modified by the remove all operation.
  - removeAll
```
public boolean removeAll(TCharCollection collection)
```
    Removes all of the elements in TCharCollection from the collection.
    
    Specified by:
    
    removeAll in interface TCharCollection
    
    Parameters:
    
    collection - a TCharCollection value
    
    Returns:
    
    true if the collection was modified by the remove all operation.
  - removeAll
```
public boolean removeAll(char[] array)
```
    Removes all of the elements in array from the collection.
    
    Specified by:
    
    removeAll in interface TCharCollection
    
    Parameters:
    
    array - an array of char primitives.
    
    Returns:
    
    true if the collection was modified by the remove all operation.
  - clear
```
public void clear()
```
    Empties the collection.
    
    Specified by:
    
    clear in interface TCharCollection
  - forEach
```
public boolean forEach(TCharProcedure procedure)
```
    Executes procedure for each element in the collection.
    
    Specified by:
    
    forEach in interface TCharCollection
    
    Parameters:
    
    procedure - a TCharProcedure value
    
    Returns:
    
    false if the loop over the collection terminated because the procedure returned false for some value.
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class TShortCharHashMap.TValueView

Field Summary

Fields inherited from interface gnu.trove.TCharCollection

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface gnu.trove.TCharCollection

Constructor Detail

TValueView

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

toString