Overview Package Class Tree Deprecated Index Help PREV CLASS NEXT CLASS FRAMES NO FRAMES SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
com.ibm.workplace.wcm.api
Interface DocumentIdIterator
- All Superinterfaces:
- java.util.Iterator
public interface DocumentIdIterator- extends java.util.Iterator
DocumentIdIterator iterates over DocumentId objects.
All objects returned by the next() method are of type DocumentId. Note. This iterator does NOT support the remove() operation.
Method Summary int getCount()
Deprecated. Please use the following code instead. while (iter.hasNext()) count = count + 1;boolean hasNext()
Returns true if the iteration has more elements.java.lang.Object next()
Returns the next element in the interation.DocumentId nextId()
Returns the next DocumentId 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 DocumentId.
The common practice is to cast the object returned by next() to a DocumentId.
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.
nextId
DocumentId nextId()
- Returns the next DocumentId 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 DocumentId 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
getCount
int getCount()
- Deprecated. Please use the following code instead. while (iter.hasNext()) count = count + 1;
- Returns the number of elements in this Iterator. If this Iterator contains more than Integer.MAX_VALUE elements, returns Integer.MAX_VALUE.
- Returns:
- the number of elements in this Iterator.
Overview Package Class Tree Deprecated Index Help PREV CLASS NEXT CLASS FRAMES NO FRAMES SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD