com.sapportals.wcm.service.relation

Interface IRelationListIterator

public interface IRelationListIterator

An iterator for IRelation s in a IRelationList .

Method Summary

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

Method Detail

hasNext

boolean hasNext()

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

Returns:

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

next

IRelation next()

Returns the next element 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:

the next element in the list.

Throws:

NoSuchElementException - if the iteration has no next element.

hasPrevious

boolean hasPrevious()

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

Returns:

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

previous

IRelation previous()

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.)

Returns:

the previous element in the list.

Throws:

NoSuchElementException - if the iteration has no previous element.

nextIndex

int nextIndex()

Returns the index of the element 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 element that would be returned by a subsequent call to next() , or list size if list iterator is at end of list.

previousIndex

int previousIndex()

Returns the index of the element 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 element that would be returned by a subsequent call to previous() , or -1 if list iterator is at beginning of list.

remove

void remove()

Removes from the list the last element 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 add(IRelation) has not been called after the last call to next() or previous .

Throws:

IllegalStateException - neither next() nor previous() have been called, or remove() or add() have been called after the last call to next() or previous()

set

void set(IRelation relation)

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

Parameters:

relation - the element with which to replace the last element returned by next() or previous() .

Throws:

IllegalArgumentException - if some aspect of the specified element prevents it from being added to this list.

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

void add(IRelation relation)

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

Parameters:

relation - the element to insert.

Throws:

IllegalArgumentException - if some aspect of the specified element prevents it from being added to this list.

Access Rights

This class can be accessed from:

SC	DC	Public Part	ACH
[sap.com] KMC-CM	[sap.com] tc/km/frwk	api	EP-KM-CM
[sap.com] KMC-WPC	[sap.com] tc/kmc/wpc/wpcfacade	api	EP-PIN-WPC-WCM