net.pwall.util

Class ImmutableCollection<T>

java.lang.Object

net.pwall.util.ImmutableBase<A>

net.pwall.util.ImmutableCollectionBase<T,T>

net.pwall.util.ImmutableCollection<T>

Type Parameters:

T - the collection element type

All Implemented Interfaces:

Iterable<T>, Collection<T>

Direct Known Subclasses:

ImmutableList, ImmutableSet

public class ImmutableCollection<T>
extends ImmutableCollectionBase<T,T>
implements Collection<T>

Immutable implementation of Collection.

Author:

Peter Wall

Constructor Summary

Constructors

Constructor and Description
ImmutableCollection(Collection<T> collection) Construct an ImmutableCollection from another Collection (helps with deserializing).
ImmutableCollection(T[] array) Construct an ImmutableCollection with the given array (using the entire array).
ImmutableCollection(T[] array, int length) Construct an ImmutableCollection with the given array and length.

Method Summary

Modifier and Type	Method and Description
boolean	contains(Object o) Test whether the collection contains an object equal to the specified value (which may be null).
static <TT> boolean	contains(TT[] array, int length, Object o) Test whether a given array contains an object equal to the specified value (which may be null).
T	get(int index) Get the element at the specified index.
Iterator<T>	iterator() Return an Iterator over the collection.
Object[]	toArray() Create a copy of the underlying array.
<TT> TT[]	toArray(TT[] a) Return a copy of the underlying array, 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

Constructor Detail

ImmutableCollection

public ImmutableCollection(T[] array,
                           int length)

Construct an ImmutableCollection with the given array and length.

Parameters:

array - the array

length - the length (the number of array items to be considered part of the collection)

Throws:

IndexOutOfBoundsException - if the length is less than 0 or greater than the array length

ImmutableCollection

public ImmutableCollection(T[] array)

Construct an ImmutableCollection with the given array (using the entire array).

Parameters:

array - the array

ImmutableCollection

public ImmutableCollection(Collection<T> collection)

Construct an ImmutableCollection from another Collection (helps with deserializing).

Parameters:

collection - the other Collection

Method Detail

contains

public boolean contains(Object o)

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

Specified by:

contains in interface Collection<T>

Parameters:

o - the object

Returns:

true if the collection contains the object

iterator

public Iterator<T> iterator()

Return an Iterator over the collection.

Specified by:

iterator in interface Iterable<T>

Specified by:

iterator in interface Collection<T>

Returns:

the Iterator

toArray

public Object[] toArray()

Create a copy of the underlying array.

Specified by:

toArray in interface Collection<T>

Returns:

a copy of the active portion of the array

toArray

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

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

Specified by:

toArray in interface Collection<T>

Type Parameters:

TT - the type of the destination array items

Parameters:

a - the destination array

Returns:

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

Throws:

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

get

public T get(int index)

Get the element at the specified index. This is not part of the standard Collection interface, but it allows iteration over the members of a collection without needing to instantiate an Iterator. The function does not check the 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

contains

public static <TT> boolean contains(TT[] array,
                                    int length,
                                    Object o)

Test whether a given array contains an object equal to the specified value (which may be null).

Type Parameters:

TT - the type of the array items

Parameters:

array - the array

length - the number of elements in the array to be examined

o - the object

Returns:

true if the collection contains the object