bak.pcj.adapter
Class ListIteratorToIntListIteratorAdapter

java.lang.Object
  bak.pcj.adapter.ListIteratorToIntListIteratorAdapter

All Implemented Interfaces:

IntIterator, IntListIterator

public class ListIteratorToIntListIteratorAdapter

extends Object

implements IntListIterator

This class represents adaptions of Java Collections Framework list iterators to primitive list iterators over int values.

Adapters from JCF collections to primitive collections will fail if the JCF collection contains null values or values of the wrong class. However, adapters are not fast failing in the case that the underlying collection should contain illegal values. To implement fast failure would require every operation to check every element of the underlying collection before doing anything. Instead validation methods are provided. They can be called using the assertion facility in the client code:

      CollectionToIntCollectionAdapter s;
      ...
      assert s.validate();
  

or by letting the adapter throw an exception on illegal values:

      CollectionToIntCollectionAdapter s;
      ...
      s.evalidate();  // Throws an exception on illegal values
  

Either way, validation must be invoked directly by the client code.

Since:

1.0

Field Summary

protected ListIterator

iterator The underlying iterator.

Constructor Summary

ListIteratorToIntListIteratorAdapter(ListIterator iterator)
Creates a new adaption of a list iterator to a primitive list iterator over int values.

Method Summary

void	add(int v) Adds a specified element to the list at this iterator's current position.
boolean	hasNext() Indicates whether more int values can be returned by this iterator.
boolean	hasPrevious() Indicates whether more int values can be returned by this iterator by calling previous().
int	next() Returns the next int value of this iterator.
int	nextIndex() Returns the index of the element that would be returned by a call to next().
int	previous() Returns the previous int value of this iterator.
int	previousIndex() Returns the index of the element that would be returned by a call to previous().
void	remove() Removes the last int value returned from the underlying collection.
void	set(int v) Sets the last element returned to a specified value.

Methods inherited from class java.lang.Object

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

Field Detail

iterator

protected ListIterator iterator

The underlying iterator.

Constructor Detail

ListIteratorToIntListIteratorAdapter

public ListIteratorToIntListIteratorAdapter(ListIterator iterator)

Creates a new adaption of a list iterator to a primitive list iterator over int values.

Parameters:

iterator - the iterator to adapt to a primitive iterator.

Throws:

NullPointerException - if iterator is null.

Method Detail

add

public void add(int v)

Description copied from interface: IntListIterator

Adds a specified element to the list at this iterator's current position.

Specified by:

add in interface IntListIterator

Parameters:

v - the element to add.

hasNext

public boolean hasNext()

Description copied from interface: IntIterator

Indicates whether more int values can be returned by this iterator.

Specified by:

hasNext in interface IntIterator

Returns:

true if more int values can be returned by this iterator; returns false otherwise.

See Also:

IntIterator.next()

hasPrevious

public boolean hasPrevious()

Description copied from interface: IntListIterator

Indicates whether more int values can be returned by this iterator by calling previous().

Specified by:

hasPrevious in interface IntListIterator

Returns:

true if more int values can be returned by this iterator in backwards direction; returns false otherwise.

See Also:

IntListIterator.previous()

next

public int next()

Description copied from interface: IntIterator

Returns the next int value of this iterator.

Specified by:

next in interface IntIterator

Returns:

the next int value of this iterator.

See Also:

IntIterator.hasNext()

nextIndex

public int nextIndex()

Description copied from interface: IntListIterator

Returns the index of the element that would be returned by a call to next().

Specified by:

nextIndex in interface IntListIterator

Returns:

the index of the element that would be returned by a call to next().

See Also:

IntIterator.next()

previous

public int previous()

Description copied from interface: IntListIterator

Returns the previous int value of this iterator.

Specified by:

previous in interface IntListIterator

Returns:

the previous int value of this iterator.

See Also:

IntListIterator.hasPrevious()

previousIndex

public int previousIndex()

Description copied from interface: IntListIterator

Returns the index of the element that would be returned by a call to previous().

Specified by:

previousIndex in interface IntListIterator

Returns:

the index of the element that would be returned by a call to previous(); if no more elements are available in backwards direction, -1 is returned.

See Also:

IntListIterator.previous()

remove

public void remove()

Description copied from interface: IntIterator

Removes the last int value returned from the underlying collection.

Specified by:

remove in interface IntIterator

set

public void set(int v)

Description copied from interface: IntListIterator

Sets the last element returned to a specified value.

Specified by:

set in interface IntListIterator

Parameters:

v - the new value of the element.