|
Jive Forums API (5.5.20.2-oracle) Developer Javadocs | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.jivesoftware.forum.ForumMessageIterator
public abstract class ForumMessageIterator
An iterator for ForumMessages that allows backwards and forwards iteration, as well as setting an index into the Iteration.
Field Summary | |
---|---|
static ForumMessageIterator |
EMPTY_ITERATOR
The empty message iterator. |
Constructor Summary | |
---|---|
ForumMessageIterator()
|
Method Summary | |
---|---|
abstract boolean |
hasNext()
Returns true if this iterator has more messages when traversing the list in the forward direction. |
abstract boolean |
hasPrevious()
Returns true if this list iterator has more messages when traversing the list in the reverse direction. |
abstract java.lang.Object |
next()
Returns the next message in the list. |
abstract java.lang.Object |
previous()
Returns the previous element in the list. |
void |
remove()
This method of the Iterator interface is not supported due to security considerations. |
abstract void |
setIndex(long messageID)
Sets the index for the iteration to the specified message ID. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final ForumMessageIterator EMPTY_ITERATOR
Constructor Detail |
---|
public ForumMessageIterator()
Method Detail |
---|
public abstract boolean hasNext()
hasNext
in interface java.util.Iterator
public abstract java.lang.Object next()
next
in interface java.util.Iterator
java.util.NoSuchElementException
- if the iteration has no next element.public abstract boolean hasPrevious()
public abstract java.lang.Object previous()
java.util.NoSuchElementException
- if the iteration has no previous
element.public abstract void setIndex(long messageID)
Implementation note: a performance setting allows an optional short-term query cache so that object invalidations are delayed for a period of time. This can mean that trying to set the index for a newly created message can fail. Ensure that this performance setting is disabled, or refrain from calling this method with newly created messages.
java.util.NoSuchElementException
- if messageID is not a valid
element of the iteration.public void remove()
remove
in interface java.util.Iterator
java.lang.UnsupportedOperationException
- if this method is called.
|
Jive Forums Project Page | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |