com.jivesoftware.forum.proxy
Class ForumMessageIteratorProxy

java.lang.Object
  com.jivesoftware.forum.ForumMessageIterator
      com.jivesoftware.forum.proxy.ForumMessageIteratorProxy

All Implemented Interfaces:

java.util.Iterator

public class ForumMessageIteratorProxy
extends ForumMessageIterator

Field Summary

Fields inherited from class com.jivesoftware.forum.ForumMessageIterator

EMPTY_ITERATOR

Constructor Summary

ForumMessageIteratorProxy(ForumMessageIterator iterator, AuthToken authToken, Permissions permissions)

Method Summary

boolean	hasNext() Returns true if this iterator has more messages when traversing the list in the forward direction.
boolean	hasPrevious() Returns true if this list iterator has more messages when traversing the list in the reverse direction.
java.lang.Object	next() Returns the next message in the list.
java.lang.Object	previous() Returns the previous element in the list.
void	setIndex(long messageID) Sets the index for the iteration to the specified message ID.

Methods inherited from class com.jivesoftware.forum.ForumMessageIterator

remove

Methods inherited from class java.lang.Object

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

Constructor Detail

ForumMessageIteratorProxy

public ForumMessageIteratorProxy(ForumMessageIterator iterator,
                                 AuthToken authToken,
                                 Permissions permissions)

Method Detail

hasNext

public boolean hasNext()

Description copied from class: ForumMessageIterator

Returns true if this iterator has more messages when traversing the list in the forward direction. (In other words, returns true if next would return a message rather than throwing an exception.)

Specified by:

hasNext in interface java.util.Iterator

Specified by:

hasNext in class ForumMessageIterator

Returns:

true if the iterator has more messages when traversing the list in the forward direction.

next

public java.lang.Object next()

Description copied from class: ForumMessageIterator

Returns the next message in the list. This method may be called repeatedly to iterate through the list, or intermixed with calls to previous to go back and forth. (Note that alternating calls to next and previous will return the same element repeatedly.)

Specified by:

next in interface java.util.Iterator

Specified by:

next in class ForumMessageIterator

Returns:

the next thread in the list.

hasPrevious

public boolean hasPrevious()

Description copied from class: ForumMessageIterator

Returns true if this list iterator has more messages when traversing the list in the reverse direction. (In other words, returns true if previous would return a thread rather than throwing an exception.)

Specified by:

hasPrevious in class ForumMessageIterator

Returns:

true if the list iterator has more elements when traversing the list in the reverse direction.

previous

public java.lang.Object previous()

Description copied from class: ForumMessageIterator

Returns the previous element in the list. This method may be called repeatedly to iterate through the list backwards, or intermixed with calls to next to go back and forth. (Note that alternating calls to next and previous will return the same element repeatedly.)

Specified by:

previous in class ForumMessageIterator

Returns:

the previous element in the list.

setIndex

public void setIndex(long messageID)

Description copied from class: ForumMessageIterator

Sets the index for the iteration to the specified message ID.

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.

Specified by:

setIndex in class ForumMessageIterator