com.ibm.workplace.wcm.api
Interface DocumentIterator

All Superinterfaces:

java.util.Iterator

public interface DocumentIterator

extends java.util.Iterator

DocumentIterator iterates over Document objects.

All objects returned by the next() method are of type Document. 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.
com.ibm.workplace.wcm.api.Document	nextDocument() Returns the next Document in the interation.
void	remove() This method is not implemented.

Method Detail

hasNext

public 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

public java.lang.Object next()

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

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

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.

nextDocument

public com.ibm.workplace.wcm.api.Document nextDocument()

Returns the next Document 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 Document in the iteration.

Throws:

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

remove

public 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