com.sap.tc.mobile.cfs.pers.api.util
Interface ManagedIterator

All Superinterfaces:

java.util.Iterator

All Known Subinterfaces:

ManagedListIterator

public interface ManagedIterator
extends java.util.Iterator

ManagedIterator is an iterator with release() method. This release method should be called when the iterator is no longer needed. For example:

 final ManagedIterator iter = pm.getIterator(MyClass.class, false);
 try {
        while (iter.hasNext()) {
                final Object o = iter.next();
                // process o
        }
 } finally {
        iter.release();
 }
 // iter should NOT be referenced here anymore 
 

Notes:

• The iterator supports remove() method to remove object last returned by a call to next() (provided the object can be locked, otherwise you'll get an exception). Iterator behaviour is undefined if you remove objects while iterating in some other way than by using remove() method.
• It is undefined, what happens if you add a new object to the container while iterating. There is some undefined probability that it will be returned by the iterator.
• Changes made in parallel transactions don't affect the behaviour of the iterator (consistent reading).

Author:

d039184

Method Summary

boolean	hasNext()
java.lang.Object	next()
void	release() Release resources bound by the iterator.
void	remove()

Method Detail

release

void release()

Release resources bound by the iterator.

hasNext

boolean hasNext()

Specified by:

hasNext in interface java.util.Iterator

next

java.lang.Object next()

Specified by:

next in interface java.util.Iterator

remove

void remove()

Specified by:

remove in interface java.util.Iterator