com.sapportals.wcm.repository.service.discussion
Interface IDiscussionItemListIterator

[contained in: com.sap.km.cm.repository.service.par - km.shared.repository.service.app.discussion_api.jar]

public interface IDiscussionItemListIterator

An iterator for IDiscussionItemList that allows the programmer to traverse the list in either direction, modify the list during iteration, and obtain the iterator's current position in the list.
A list iterator has no current element; its cursor position always lies between the element that would be returned by a call to previous() and the element that would be returned by a call to next(). In a list of length n, there are n+1 valid index values, from 0 to n, inclusive.

Method Summary

void	add(IDiscussionItem discussionItem) Inserts the specified discussion item into the list.
boolean	hasNext() Returns true if this list iterator has more discussion items when traversing the list in the forward direction.
boolean	hasPrevious() Returns true if this list iterator has more discussion items when traversing the list in the reverse direction.
IDiscussionItem	next() Returns the next discussion item in the list.
int	nextIndex() Returns the index of the discussion item that would be returned by a subsequent call to next.
IDiscussionItem	previous() Returns the previous discussion item in the list.
int	previousIndex() Returns the index of the discussion item that would be returned by a subsequent call to previous.
void	remove() Removes from the list the last discussion item that was returned by next or previous.
void	set(IDiscussionItem discussionItem) Replaces the last discussion item returned by next or previous with the specified discussion item.

Method Detail

hasNext

public boolean hasNext()

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

Returns:

true, if the list iterator has more discussion items when traversing the list in the forward direction

next

public IDiscussionItem next()

Returns the next discussion item 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.)

Returns:

an IDiscussionItem, it is the next discussion item in the list

Throws:

NoSuchElementException - if the iteration has no next element

hasPrevious

public boolean hasPrevious()

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

Returns:

true, if the list iterator has more discussion items when traversing the list in the reverse direction

Throws:

NoSuchElementException - if the iteration has no previous element

previous

public IDiscussionItem previous()

Returns the previous discussion item 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.)

Returns:

an IDiscussionItem, it is the previous discussion item in the list

Throws:

NoSuchElementException - if the iteration has no previous element

nextIndex

public int nextIndex()

Returns the index of the discussion item that would be returned by a subsequent call to next. (Returns list size if the list iterator is at the end of the list.)

Returns:

the index of the discussion item that would be returned by a subsequent call to next, or list size if list iterator is at end of list

previousIndex

public int previousIndex()

Returns the index of the discussion item that would be returned by a subsequent call to previous. (Returns -1 if the list iterator is at the beginning of the list.)

Returns:

the index of the discussion item that would be returned by a subsequent call to previous, or -1 if list iterator is at beginning of list

remove

public void remove()

Removes from the list the last discussion item that was returned by next or previous. This call can only be made once per call to next or previous. It can be made only if IDiscussionListIterator.add has not been called after the last call to next or previous.

Throws:

java.lang.UnsupportedOperationException - if the remove operation is not supported by this list iterator

java.lang.IllegalStateException - if neither next nor previous have been called, or remove or add have been called after the last call to next or previous

set

public void set(IDiscussionItem discussionItem)

Replaces the last discussion item returned by next or previous with the specified discussion item. This call can be made only if neither DiscussionItemListIterator.remove nor DiscussionItemListIterator.add have been called after the last call to next or previous.

Parameters:

discussionItem - the discussion item with which to replace the last discussion item returned by next or previous

Throws:

java.lang.UnsupportedOperationException - if the set operation is not supported by this list iterator

ClassCastException - if the class of the specified discussion item prevents it from being added to this list

java.lang.IllegalArgumentException - if some aspect of the specified discussion item prevents it from being added to this list

java.lang.IllegalStateException - if neither next nor previous have been called, or remove or add have been called after the last call to next or previous

add

public void add(IDiscussionItem discussionItem)

Inserts the specified discussion item into the list. The discussion item is inserted immediately before the next discussion item that would be returned by next, if any, and after the next discussion item that would be returned by previous, if any. (If the list contains no discussion items, the new discussion item becomes the sole discussion item on the list.) The new discussion item is inserted before the implicit cursor: a subsequent call to next would be unaffected, and a subsequent call to previous would return the new discussion item. (This call increases by one the value that would be returned by a call to nextIndex or previousIndex.)

Parameters:

discussionItem - the discussion item to insert

Throws:

java.lang.UnsupportedOperationException - if the add method is not supported by this list iterator

ClassCastException - if the class of the specified discussion item prevents it from being added to this list

java.lang.IllegalArgumentException - if some aspect of this discussion item prevents it from being added to this list