openlr.location.utils

Class LocationDataIterator

java.lang.Object

openlr.location.utils.LocationDataIterator

All Implemented Interfaces:

Iterator<Location>, ListIterator<Location>

public class LocationDataIterator
extends Object
implements ListIterator<Location>

Enables to iterate forward and backwards over a list of locations. The indexes start at 0 and thus end with size - 1. Initially the iterator points to no location.

OpenLR is a trade mark of TomTom International B.V.

email: software@openlr.org

Author:

TomTom International B.V.

Method Summary

Modifier and Type	Method and Description
void	add(Location e) Not supported by this iterator.
Location	current() This method delivers the location the iterator currently points to.
int	currentIndex() Gets the current location index.
boolean	hasNext() Checks if is next location available.
boolean	hasPrevious() Checks if is previous location available.
Location	next() Sets the pointer to the next location and delivers it back.
int	nextIndex()
Location	previous() Sets the pointer to the previous location and delivers it back.
int	previousIndex()
void	remove() Not supported by this iterator.
void	reset() Resets the iterator to the start position.
void	set(Location e) Not supported by this iterator.
Location	setCurrent(int newIndex) Sets the pointer to a specific location index.
int	size() Number of locations.

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

Method Detail

size

public final int size()

Number of locations.

Returns:

the int

currentIndex

public final int currentIndex()

Gets the current location index. This returns "-1" if the iterator is still in start position or was reset().

Returns:

the current location index

current

public final Location current()

This method delivers the location the iterator currently points to. If the iterator is still in start position or was reset() before this returns null.

Returns:

the current location

next

public final Location next()

Sets the pointer to the next location and delivers it back. Throws a NoSuchElementException if there is no next location available. Please see hasNext().

Specified by:

next in interface Iterator<Location>

Specified by:

next in interface ListIterator<Location>

Returns:

the next location

See Also:

hasNext()

previous

public final Location previous()

Sets the pointer to the previous location and delivers it back. Throws a NoSuchElementException if there is no previous location available. Please see hasPrevious().

Specified by:

previous in interface ListIterator<Location>

Returns:

the previous location

hasPrevious

public final boolean hasPrevious()

Checks if is previous location available.

Specified by:

hasPrevious in interface ListIterator<Location>

Returns:

true, if is previous location available

hasNext

public final boolean hasNext()

Checks if is next location available.

Specified by:

hasNext in interface Iterator<Location>

Specified by:

hasNext in interface ListIterator<Location>

Returns:

true, if is next location available

reset

public final void reset()

Resets the iterator to the start position. In this state no location is selected.

setCurrent

public final Location setCurrent(int newIndex)

Sets the pointer to a specific location index. Valid values are 0 to size() - 1.

Parameters:

newIndex - the new index

Returns:

the current location

See Also:

current()

remove

public final void remove()

Not supported by this iterator. Throws UnsupportedOperationException.

Specified by:

remove in interface Iterator<Location>

Specified by:

remove in interface ListIterator<Location>

nextIndex

public final int nextIndex()

Specified by:

nextIndex in interface ListIterator<Location>

previousIndex

public final int previousIndex()

Specified by:

previousIndex in interface ListIterator<Location>

set

public final void set(Location e)

Not supported by this iterator. Throws UnsupportedOperationException.

Specified by:

set in interface ListIterator<Location>

Parameters:

e - ignored

add

public final void add(Location e)

Not supported by this iterator. Throws UnsupportedOperationException.

Specified by:

add in interface ListIterator<Location>

Parameters:

e - ignored