net.pwall.util

Class ImmutableMap.ValueCollection<K,V>

java.lang.Object

net.pwall.util.ImmutableBase<A>

net.pwall.util.ImmutableCollectionBase<ImmutableMapEntry<K,V>,V>

net.pwall.util.ImmutableMap.ValueCollection<K,V>

Type Parameters:

K - the key type

V - the value type

All Implemented Interfaces:

Iterable<V>, Collection<V>

Enclosing class:

ImmutableMap<K,V>

public static class ImmutableMap.ValueCollection<K,V>
extends ImmutableCollectionBase<ImmutableMapEntry<K,V>,V>
implements Collection<V>

Implementation of the Collection interface to provide a view of the values in the ImmutableMap. It makes use of the same underlying array, but returns only the value portion of the ImmutableMapEntry.

Method Summary

Modifier and Type	Method and Description
boolean	contains(Object o) Test whether the collection contains an element equal to the specified object (which may be null).
V	get(int index) Get the value at the specified index.
Iterator<V>	iterator() Return an Iterator over the collection.
Object[]	toArray() Create a copy of the collection in an array.
<T> T[]	toArray(T[] a) Return a copy of the collection, either in the supplied array (if it fits) or in a new array of the specified type.

Methods inherited from class net.pwall.util.ImmutableCollectionBase

add, addAll, containsAll, remove, removeAll, retainAll, toString

Methods inherited from class net.pwall.util.ImmutableBase

clear, isEmpty, size

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Collection

add, addAll, clear, containsAll, equals, hashCode, isEmpty, parallelStream, remove, removeAll, removeIf, retainAll, size, spliterator, stream

Methods inherited from interface java.lang.Iterable

forEach

Method Detail

contains

public boolean contains(Object o)

Test whether the collection contains an element equal to the specified object (which may be null).

Specified by:

contains in interface Collection<V>

Parameters:

o - the value

Returns:

true if the collection contains the object

iterator

public Iterator<V> iterator()

Return an Iterator over the collection.

Specified by:

iterator in interface Iterable<V>

Specified by:

iterator in interface Collection<V>

Returns:

the Iterator

toArray

public Object[] toArray()

Create a copy of the collection in an array.

Specified by:

toArray in interface Collection<V>

Returns:

a copy of the values in the active portion of the array

toArray

public <T> T[] toArray(T[] a)

Return a copy of the collection, either in the supplied array (if it fits) or in a new array of the specified type.

Specified by:

toArray in interface Collection<V>

Type Parameters:

T - the type of the destination array items

Parameters:

a - the destination array

Returns:

a copy of the values in the active portion of the map array, in a new array if necessary

Throws:

ArrayStoreException - if the values in the map can't be stored in the destination array

get

public V get(int index)

Get the value at the specified index. This is not part of the standard Collection interface, but it allows iteration over the entries of a map without needing to instantiate an Iterator.
The function does not check the array index because the indexing operation on the array will do that anyway.

Parameters:

index - the index

Returns:

the element at that index

Throws:

IndexOutOfBoundsException - if the index is less than 0 or greater than the length of the list