com.ibm.workplace.wcm.api
Interface HistoryLogIterator

All Superinterfaces:

java.util.Iterator

public interface HistoryLogIterator
extends java.util.Iterator

HistoryLogIterator iterates over HistoryLogEntry objects.

All objects returned by the next() method are of type HistoryLogEntry. Note. This iterator does NOT support the remove() operation.

Method Summary

boolean	hasNext() Returns true if the iteration has more elements.
java.lang.Object	next() Returns the next element in the interation.
HistoryLogEntry	nextLogEntry() Returns the next HistoryLogEntry in the interation.
void	remove() This method is not implemented.

Method Detail

hasNext

boolean hasNext()

Returns true if the iteration has more elements. (In other words, returns true if next() would return an element rather than throwing an exception.)

Specified by:

hasNext in interface java.util.Iterator

Returns:

true if the iterator has more elements; false otherwise

next

java.lang.Object next()

Returns the next element in the interation. All objects returned from this iterator will be instances of HistoryLogEntry.

The common practice is to cast the object returned by next() to a HistoryLogEntry.

The hasNext() method should be called first to ensure there is a next element in the iteration, otherwise an exception may be thrown.

Specified by:

next in interface java.util.Iterator

Returns:

the next element in the iteration.

Throws:

java.util.NoSuchElementException - if the iteration has no more elements.

nextLogEntry

HistoryLogEntry nextLogEntry()

Returns the next HistoryLogEntry in the interation.

The hasNext() method should be called first to ensure there is a next element in the iteration, otherwise an exception may be thrown.

Returns:

the next HistoryLogEntry in the iteration.

Throws:

java.util.NoSuchElementException - if the iteration has no more elements.

remove

void remove()

This method is not implemented. Each call will result in an UnsupportedOperationException being thrown.

Specified by:

remove in interface java.util.Iterator

Throws:

java.lang.UnsupportedOperationException - each time the method is called