speiger.src.collections.chars.utils

Class CharIterators

java.lang.Object

speiger.src.collections.chars.utils.CharIterators

public class CharIterators
extends java.lang.Object

A Helper class for Iterators

Field Summary

Fields

Modifier and Type	Field and Description
static speiger.src.collections.chars.utils.CharIterators.EmptyIterator	EMPTY Empty Iterator Reference

Constructor Summary

Constructors

Constructor and Description
CharIterators()

Method Summary

Modifier and Type	Method and Description
static speiger.src.collections.chars.utils.CharIterators.EmptyIterator	emptyIterator() Returns a Immutable EmptyIterator instance that is automatically casted.
static CharBidirectionalIterator	invert(CharBidirectionalIterator it) Inverter function for Bidirectional Iterators
static CharListIterator	invert(CharListIterator it) Inverter function for List Iterators
static CharBidirectionalIterator	unmodifiable(CharBidirectionalIterator iterator) Returns a Immutable Iterator instance based on the instance given.
static CharIterator	unmodifiable(CharIterator iterator) Returns a Immutable Iterator instance based on the instance given.
static CharListIterator	unmodifiable(CharListIterator iterator) Returns a Immutable ListIterator instance based on the instance given.
static int	unwrap(char[] a, CharIterator i) A Primitive iterator variant of the CharIterators unwrap function Iterates over a iterator and inserts the values into the array and returns the amount that was inserted
static int	unwrap(char[] a, CharIterator i, int offset) A Primitive iterator variant of the CharIterators unwrap function Iterates over a iterator and inserts the values into the array and returns the amount that was inserted
static int	unwrap(char[] a, CharIterator i, int offset, int max) A Primitive iterator variant of the CharIterators unwrap function Iterates over a iterator and inserts the values into the array and returns the amount that was inserted
static int	unwrap(char[] a, java.util.Iterator<? extends java.lang.Character> i) Iterates over a iterator and inserts the values into the array and returns the amount that was inserted
static int	unwrap(char[] a, java.util.Iterator<? extends java.lang.Character> i, int offset) Iterates over a iterator and inserts the values into the array and returns the amount that was inserted
static int	unwrap(char[] a, java.util.Iterator<? extends java.lang.Character> i, int offset, int max) Iterates over a iterator and inserts the values into the array and returns the amount that was inserted
static int	unwrap(java.lang.Character[] a, CharIterator i) A Function to convert a Primitive Iterator to a Object array.
static int	unwrap(java.lang.Character[] a, CharIterator i, int offset) A Function to convert a Primitive Iterator to a Object array.
static int	unwrap(java.lang.Character[] a, CharIterator i, int offset, int max) A Function to convert a Primitive Iterator to a Object array.
static speiger.src.collections.chars.utils.CharIterators.ArrayIterator	wrap(char[] a) Returns a Array Wrapping iterator
static speiger.src.collections.chars.utils.CharIterators.ArrayIterator	wrap(char[] a, int start, int end) Returns a Array Wrapping iterator
static CharIterator	wrap(java.util.Iterator<java.lang.Character> iterator) Helper function to convert a Object Iterator into a Primitive 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.chars.utils.CharIterators.EmptyIterator EMPTY

Empty Iterator Reference

Constructor Detail

CharIterators

public CharIterators()

Method Detail

emptyIterator

public static speiger.src.collections.chars.utils.CharIterators.EmptyIterator emptyIterator()

Returns a Immutable EmptyIterator instance that is automatically casted.

Returns:

an empty iterator

invert

public static CharBidirectionalIterator invert(CharBidirectionalIterator it)

Inverter function for Bidirectional Iterators

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 CharListIterator invert(CharListIterator it)

Inverter function for List Iterators

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 CharIterator unmodifiable(CharIterator iterator)

Returns a Immutable Iterator instance based on the instance given.

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 CharBidirectionalIterator unmodifiable(CharBidirectionalIterator iterator)

Returns a Immutable Iterator instance based on the instance given.

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 CharListIterator unmodifiable(CharListIterator iterator)

Returns a Immutable ListIterator instance based on the instance given.

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 CharIterator wrap(java.util.Iterator<java.lang.Character> iterator)

Helper function to convert a Object Iterator into a Primitive Iterator

Parameters:

iterator - that should be converted to a unboxing iterator

Returns:

a primitive iterator

wrap

public static speiger.src.collections.chars.utils.CharIterators.ArrayIterator wrap(char[] a)

Returns a Array Wrapping iterator

Parameters:

a - the array that should be wrapped

Returns:

a Iterator that is wrapping a array.

wrap

public static speiger.src.collections.chars.utils.CharIterators.ArrayIterator wrap(char[] a,
                                                                                   int start,
                                                                                   int end)

Returns a Array Wrapping iterator

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 int unwrap(char[] a,
                         java.util.Iterator<? extends java.lang.Character> i)

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

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 int unwrap(char[] a,
                         java.util.Iterator<? extends java.lang.Character> i,
                         int offset)

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

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 int unwrap(char[] a,
                         java.util.Iterator<? extends java.lang.Character> i,
                         int offset,
                         int max)

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

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 int unwrap(char[] a,
                         CharIterator i)

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

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 int unwrap(char[] a,
                         CharIterator i,
                         int offset)

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

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 int unwrap(char[] a,
                         CharIterator i,
                         int offset,
                         int max)

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

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 int unwrap(java.lang.Character[] a,
                         CharIterator i)

A Function to convert a Primitive Iterator to a Object array. Iterates over a iterator and inserts the values into the array and returns the amount that was inserted

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 int unwrap(java.lang.Character[] a,
                         CharIterator i,
                         int offset)

A Function to convert a Primitive Iterator to a Object array. Iterates over a iterator and inserts the values into the array and returns the amount that was inserted

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 int unwrap(java.lang.Character[] a,
                         CharIterator i,
                         int offset,
                         int max)

A Function to convert a Primitive Iterator to a Object array. Iterates over a iterator and inserts the values into the array and returns the amount that was inserted

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