de.mrapp.android.tabswitcher.iterator

Class AbstractItemIterator

java.lang.Object

de.mrapp.android.tabswitcher.iterator.AbstractItemIterator

All Implemented Interfaces:

java.util.Iterator<AbstractItem>

Direct Known Subclasses:

AbstractTabSwitcherLayout.InitialItemIterator, ArrayItemIterator, ItemIterator

public abstract class AbstractItemIterator
extends java.lang.Object
implements java.util.Iterator<AbstractItem>

An abstract base class for all iterators, which allow to iterate items of the type AbstractItem.

Since:

0.1.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractItemIterator.AbstractBuilder<BuilderType extends AbstractItemIterator.AbstractBuilder<?,ProductType>,ProductType extends AbstractItemIterator> An abstract base class of all builders, which allows to configure and create instances of the class AbstractItemIterator.

Constructor Summary

Constructors

Constructor and Description
AbstractItemIterator()

Method Summary

Modifier and Type	Method and Description
AbstractItem	first() Returns the first item.
abstract int	getCount() The method, which is invoked on subclasses in order to retrieve the total number of available items.
abstract AbstractItem	getItem(int index) The method, which is invoked on subclasses in order to retrieve the item, which corresponds to a specific index.
boolean	hasNext()
protected void	initialize(boolean reverse, int start) Initializes the iterator.
AbstractItem	next()
AbstractItem	peek() Returns the next item.
AbstractItem	previous() Returns the previous item.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Iterator

forEachRemaining, remove

Constructor Detail

AbstractItemIterator

public AbstractItemIterator()

Method Detail

getCount

public abstract int getCount()

The method, which is invoked on subclasses in order to retrieve the total number of available items.

Returns:

The total number of available items as an Integer value

getItem

public abstract AbstractItem getItem(int index)

The method, which is invoked on subclasses in order to retrieve the item, which corresponds to a specific index.

Parameters:

index - The index of the item, which should be returned, as an Integer value

Returns:

The item, which corresponds to the given index, as an instance of the class AbstractItem. The item may not be null

initialize

protected final void initialize(boolean reverse,
                                int start)

Initializes the iterator.

Parameters:

reverse - True, if the items should be iterated in reverse order, false otherwise

start - The index of the first item, which should be iterated, as an Integer value or -1, if all items should be iterated

first

public final AbstractItem first()

Returns the first item. Calling this method does not alter the current position of the iterator.

Returns:

The first item as an instance of the class AbstractItem or null, if no items are available

previous

public final AbstractItem previous()

Returns the previous item. Calling this method does not alter the current position of the iterator.

Returns:

The previous item as an instance of the class AbstractItem or null, if no previous item is available

peek

public final AbstractItem peek()

Returns the next item. Calling this method does not alter the current position of the iterator.

Returns:

The next item as an instance of the class AbstractItem or null, if no next item is available

hasNext

public final boolean hasNext()

Specified by:

hasNext in interface java.util.Iterator<AbstractItem>

next

public final AbstractItem next()

Specified by:

next in interface java.util.Iterator<AbstractItem>