ilog.views.util.collections

Class IlvCollections

java.lang.Object

ilog.views.util.collections.IlvCollections

public class IlvCollections
extends Object

IlvCollections is a utility class that consists exclusively of static methods and variables that are of general use when dealing with collections.

Since:

JViews 5.5

Method Summary

Modifier and Type	Method and Description
static ConcurrentModificationException	concurrentModificationException(String message, Throwable cause) Returns a concurrent modification exception that has a cause.
static <E> Iterator<E>	emptyIterator() Returns an iterator that is always empty.
static <E> ListIterator<E>	emptyListIterator() Returns a list iterator that is always empty.
static <T> IlvUnaryPredicate<T>	falseUnaryPredicate() Returns a unary predicate that always evaluates to false.
static <E> Iterator<E>	oneElementIterator(E element) Returns an unmodifiable iterator that iterates only over the input element.
static <E> ListIterator<E>	oneElementListIterator(E element) Returns an unmodifiable iterator that iterates only over the input element.
static <E> ListIterator<E>	reversedIterator(List<E> list) Returns an iterator that traverses the specified list in reversed order.
static <E> ListIterator<E>	reversedIterator(ListIterator<E> ite) Returns an iterator with a reversed order of traversal.
static <T> T[]	toArray(Iterator<T> iter, Class<T> elementType, boolean copy) Returns an array that contains the elements produced by the given iterator, in order.
static <T> IlvUnaryPredicate<T>	trueUnaryPredicate() Returns a unary predicate that always evaluates to true.
static <E> Iterator<E>	unmodifiableIterator(Iterator<E> ite) Returns an unmodifiable version of the specified iterator.
static <E> ListIterator<E>	unmodifiableIterator(ListIterator<E> ite) Returns an unmodifiable version of the specified iterator.

Methods inherited from class java.lang.Object

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

Method Detail

unmodifiableIterator

public static <E> Iterator<E> unmodifiableIterator(Iterator<E> ite)

Returns an unmodifiable version of the specified iterator.

Parameters:

ite - The original iterator.

Returns:

A read-only iterator that traverses the same collection as the original iterator. If the remove method is called on the returned iterator, an UnsupportedOperationException is thrown.

unmodifiableIterator

public static <E> ListIterator<E> unmodifiableIterator(ListIterator<E> ite)

Returns an unmodifiable version of the specified iterator.

Parameters:

ite - The original iterator.

Returns:

A read-only iterator that traverses the same list as the original iterator. If the remove method is called on the returned iterator, an UnsupportedOperationException is thrown.

reversedIterator

public static <E> ListIterator<E> reversedIterator(ListIterator<E> ite)

Returns an iterator with a reversed order of traversal.

Parameters:

ite - The original iterator.

Returns:

An iterator with a reversed sequence compared to the original iterator. The current position of the original iterator is unchanged.

reversedIterator

public static <E> ListIterator<E> reversedIterator(List<E> list)

Returns an iterator that traverses the specified list in reversed order.

Parameters:

list - The considered list.

Returns:

An iterator that traverses the list in reversed order. The iterator is initially positioned at the end of the list, so that the first call to next() returns the last element of the list.

emptyIterator

public static <E> Iterator<E> emptyIterator()

Returns an iterator that is always empty.

emptyListIterator

public static <E> ListIterator<E> emptyListIterator()

Returns a list iterator that is always empty.

oneElementIterator

public static <E> Iterator<E> oneElementIterator(E element)

Returns an unmodifiable iterator that iterates only over the input element.

Parameters:

element - The element that occurs in the iterator.

Returns:

A read-only iterator that traverses a collection containing only the input element. If the remove method is called on the returned iterator, an UnsupportedOperationException is thrown.

Since:

JViews 8.0

oneElementListIterator

public static <E> ListIterator<E> oneElementListIterator(E element)

Returns an unmodifiable iterator that iterates only over the input element.

Parameters:

element - The element that occurs in the iterator.

Returns:

A read-only iterator that traverses a collection containing only the input element. If the remove, set or add method is called on the returned iterator, an UnsupportedOperationException is thrown.

Since:

JViews 8.0

toArray

public static <T> T[] toArray(Iterator<T> iter,
                              Class<T> elementType,
                              boolean copy)

Returns an array that contains the elements produced by the given iterator, in order.

Parameters:

iter - An iterator. It is moved to its end by this method.

elementType - The element type of the resulting array, if freshly allocated.

copy - If true, the resulting array will always be freshly allocated. If false, the resulting array may be shared with the data structure over which iter iterates.

Returns:

An array containg the elements that iter produces. If copy is false, it should not be written to.

Since:

JViews 8.7

trueUnaryPredicate

public static <T> IlvUnaryPredicate<T> trueUnaryPredicate()

Returns a unary predicate that always evaluates to true.

falseUnaryPredicate

public static <T> IlvUnaryPredicate<T> falseUnaryPredicate()

Returns a unary predicate that always evaluates to false.

concurrentModificationException

public static ConcurrentModificationException concurrentModificationException(String message,
                                                                              Throwable cause)

Returns a concurrent modification exception that has a cause.

Parameters:

message - The message of the exception.

cause - The cause, or null.

Since:

JViews 8.5