speiger.src.collections.objects.utils

Class ObjectIterators

java.lang.Object

speiger.src.collections.objects.utils.ObjectIterators

public class ObjectIterators
extends java.lang.Object

A Helper class for Iterators

Field Summary

Fields

Modifier and Type	Field and Description
static speiger.src.collections.objects.utils.ObjectIterators.EmptyIterator<?>	EMPTY Empty Iterator Reference

Constructor Summary

Constructors

Constructor and Description
ObjectIterators()

Method Summary

Modifier and Type	Method and Description
static <T> speiger.src.collections.objects.utils.ObjectIterators.EmptyIterator<T>	emptyIterator() Returns a Immutable EmptyIterator instance that is automatically casted.
static <T> ObjectBidirectionalIterator<T>	invert(ObjectBidirectionalIterator<T> it) Inverter function for Bidirectional Iterators
static <T> ObjectListIterator<T>	invert(ObjectListIterator<T> it) Inverter function for List Iterators
static <T> ObjectBidirectionalIterator<T>	unmodifiable(ObjectBidirectionalIterator<T> iterator) Returns a Immutable Iterator instance based on the instance given.
static <T> ObjectIterator<T>	unmodifiable(ObjectIterator<T> iterator) Returns a Immutable Iterator instance based on the instance given.
static <T> ObjectListIterator<T>	unmodifiable(ObjectListIterator<T> iterator) Returns a Immutable ListIterator instance based on the instance given.
static <T> int	unwrap(T[] a, java.util.Iterator<? extends T> i) Iterates over a iterator and inserts the values into the array and returns the amount that was inserted
static <T> int	unwrap(T[] a, java.util.Iterator<? extends T> i, int offset) Iterates over a iterator and inserts the values into the array and returns the amount that was inserted
static <T> int	unwrap(T[] a, java.util.Iterator<? extends T> i, int offset, int max) Iterates over a iterator and inserts the values into the array and returns the amount that was inserted
static <T> int	unwrap(T[] a, ObjectIterator<T> i) A Primitive iterator variant of the ObjectIterators unwrap function Iterates over a iterator and inserts the values into the array and returns the amount that was inserted
static <T> int	unwrap(T[] a, ObjectIterator<T> i, int offset) A Primitive iterator variant of the ObjectIterators unwrap function Iterates over a iterator and inserts the values into the array and returns the amount that was inserted
static <T> int	unwrap(T[] a, ObjectIterator<T> i, int offset, int max) A Primitive iterator variant of the ObjectIterators unwrap function Iterates over a iterator and inserts the values into the array and returns the amount that was inserted
static <T> speiger.src.collections.objects.utils.ObjectIterators.ArrayIterator<T>	wrap(T[] a) Returns a Array Wrapping iterator
static <T> speiger.src.collections.objects.utils.ObjectIterators.ArrayIterator<T>	wrap(T[] a, int start, int end) Returns a Array Wrapping iterator

Methods inherited from class java.lang.Object

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

Field Detail

EMPTY

public static final speiger.src.collections.objects.utils.ObjectIterators.EmptyIterator<?> EMPTY

Empty Iterator Reference

Constructor Detail

ObjectIterators

public ObjectIterators()

Method Detail

emptyIterator

public static <T> speiger.src.collections.objects.utils.ObjectIterators.EmptyIterator<T> emptyIterator()

Returns a Immutable EmptyIterator instance that is automatically casted.

Type Parameters:

T - the type of elements maintained by this Collection

Returns:

an empty iterator

invert

public static <T> ObjectBidirectionalIterator<T> invert(ObjectBidirectionalIterator<T> it)

Inverter function for Bidirectional Iterators

Type Parameters:

T - the type of elements maintained by this Collection

Parameters:

it - the iterator that should be inverted

Returns:

a Inverted Bidirectional Iterator. If it was inverted then it just gives back the original reference

invert

public static <T> ObjectListIterator<T> invert(ObjectListIterator<T> it)

Inverter function for List Iterators

Type Parameters:

T - the type of elements maintained by this Collection

Parameters:

it - the iterator that should be inverted

Returns:

a Inverted List Iterator. If it was inverted then it just gives back the original reference

unmodifiable

public static <T> ObjectIterator<T> unmodifiable(ObjectIterator<T> iterator)

Returns a Immutable Iterator instance based on the instance given.

Type Parameters:

T - the type of elements maintained by this Collection

Parameters:

iterator - that should be made immutable/unmodifyable

Returns:

a unmodifiable iterator wrapper. If the Iterator already a unmodifyable wrapper then it just returns itself.

unmodifiable

public static <T> ObjectBidirectionalIterator<T> unmodifiable(ObjectBidirectionalIterator<T> iterator)

Returns a Immutable Iterator instance based on the instance given.

Type Parameters:

T - the type of elements maintained by this Collection

Parameters:

iterator - that should be made immutable/unmodifyable

Returns:

a unmodifiable iterator wrapper. If the Iterator already a unmodifyable wrapper then it just returns itself.

unmodifiable

public static <T> ObjectListIterator<T> unmodifiable(ObjectListIterator<T> iterator)

Returns a Immutable ListIterator instance based on the instance given.

Type Parameters:

T - the type of elements maintained by this Collection

Parameters:

iterator - that should be made immutable/unmodifyable

Returns:

a unmodifiable listiterator wrapper. If the ListIterator already a unmodifyable wrapper then it just returns itself.

wrap

public static <T> speiger.src.collections.objects.utils.ObjectIterators.ArrayIterator<T> wrap(T[] a)

Returns a Array Wrapping iterator

Type Parameters:

T - the type of array that the operation should be applied

Parameters:

a - the array that should be wrapped

Returns:

a Iterator that is wrapping a array.

wrap

public static <T> speiger.src.collections.objects.utils.ObjectIterators.ArrayIterator<T> wrap(T[] a,
                                                                                              int start,
                                                                                              int end)

Returns a Array Wrapping iterator

Type Parameters:

T - the type of array that the operation should be applied

Parameters:

a - the array that should be wrapped.

start - the index to be started from.

end - the index that should be ended.

Returns:

a Iterator that is wrapping a array.

unwrap

public static <T> int unwrap(T[] a,
                             java.util.Iterator<? extends T> i)

Iterates over a iterator and inserts the values into the array and returns the amount that was inserted

Type Parameters:

T - the type of array that the operation should be applied

Parameters:

a - where the elements should be inserted

i - the source iterator

Returns:

the amount of elements that were inserted into the array.

unwrap

public static <T> int unwrap(T[] a,
                             java.util.Iterator<? extends T> i,
                             int offset)

Iterates over a iterator and inserts the values into the array and returns the amount that was inserted

Type Parameters:

T - the type of array that the operation should be applied

Parameters:

a - where the elements should be inserted

i - the source iterator

offset - the array offset where the start should be

Returns:

the amount of elements that were inserted into the array.

unwrap

public static <T> int unwrap(T[] a,
                             java.util.Iterator<? extends T> i,
                             int offset,
                             int max)

Iterates over a iterator and inserts the values into the array and returns the amount that was inserted

Type Parameters:

T - the type of array that the operation should be applied

Parameters:

a - where the elements should be inserted

i - the source iterator

offset - the array offset where the start should be

max - the maximum values that should be extracted from the source

Returns:

the amount of elements that were inserted into the array.

Throws:

java.lang.IllegalStateException - if max is smaller the 0 or if the maximum index is larger then the array

unwrap

public static <T> int unwrap(T[] a,
                             ObjectIterator<T> i)

A Primitive iterator variant of the ObjectIterators unwrap function Iterates over a iterator and inserts the values into the array and returns the amount that was inserted

Type Parameters:

T - the type of array that the operation should be applied

Parameters:

a - where the elements should be inserted

i - the source iterator

Returns:

the amount of elements that were inserted into the array.

unwrap

public static <T> int unwrap(T[] a,
                             ObjectIterator<T> i,
                             int offset)

A Primitive iterator variant of the ObjectIterators unwrap function Iterates over a iterator and inserts the values into the array and returns the amount that was inserted

Type Parameters:

T - the type of array that the operation should be applied

Parameters:

a - where the elements should be inserted

i - the source iterator

offset - the array offset where the start should be

Returns:

the amount of elements that were inserted into the array.

unwrap

public static <T> int unwrap(T[] a,
                             ObjectIterator<T> i,
                             int offset,
                             int max)

A Primitive iterator variant of the ObjectIterators unwrap function Iterates over a iterator and inserts the values into the array and returns the amount that was inserted

Type Parameters:

T - the type of array that the operation should be applied

Parameters:

a - where the elements should be inserted

i - the source iterator

offset - the array offset where the start should be

max - the maximum values that should be extracted from the source

Returns:

the amount of elements that were inserted into the array.

Throws:

java.lang.IllegalStateException - if max is smaller the 0 or if the maximum index is larger then the array