com.frostphyr.avail.collections

Class CollectionUtils

java.lang.Object

com.frostphyr.avail.collections.CollectionUtils

public final class CollectionUtils
extends Object

A class containing various utility methods relating to the Java collection framework.

Since:

1.3

Method Summary

Methods

Modifier and Type	Method and Description
static <T> Iterator<T>	immutableIterator(Iterator<T> iterator) Returns an immutable view of the specified Iterator.
static <T> ListIterator<T>	immutableListIterator(ListIterator<T> iterator) Returns an immutable view of the specified ListIterator.

Methods inherited from class java.lang.Object

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

Method Detail

immutableIterator

public static <T> Iterator<T> immutableIterator(Iterator<T> iterator)

Returns an immutable view of the specified Iterator. The method that can modify the collection, Iterator.remove(), will throw an UnsupportedOperationException. Otherwise, it will defer to the specified Iterator.

Type Parameters:

T - the type of the Iterator's generic parameter

Parameters:

iterator - the Iterator to create an immutable view for

Returns:

an immutable view of the specified Iterator

immutableListIterator

public static <T> ListIterator<T> immutableListIterator(ListIterator<T> iterator)

Returns an immutable view of the specified ListIterator. The methods that can modify the collection will throw an UnsupportedOperationException. Otherwise, it will defer to the specified ListIterator.

The methods that can modify the collection and will throw an UnsupportedOperationException are:

• ListIterator.remove()
• ListIterator.set(Object)
• ListIterator.add(Object)

Type Parameters:

T - the type of the ListIterator's generic parameter

Parameters:

iterator - the ListIterator to create an immutable view for

Returns:

an immutable view of the specified ListIterator