net.jimblackler.Utils

Class YieldAdapterIterator<T>

java.lang.Object

net.jimblackler.Utils.YieldAdapterIterator<T>

All Implemented Interfaces:

java.util.Iterator<T>

public abstract class YieldAdapterIterator<T>
extends java.lang.Object
implements java.util.Iterator<T>

A version of a standard Iterator<> used by the yield adapter. The only addition is a dispose() function to clear resources manually when required.

Field Summary

Fields

Modifier and Type	Field and Description
protected IllegalActionException	messageIllegalAction

Constructor Summary

Constructors

Constructor and Description
YieldAdapterIterator()

Method Summary

Modifier and Type	Method and Description
abstract void	dispose() Because the Yield Adapter starts a separate thread for duration of the collection, this can be left open if the calling code only reads part of the collection.
IllegalActionException	getMessageIllegalAction()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Iterator

forEachRemaining, hasNext, next, remove

Field Detail

messageIllegalAction

protected IllegalActionException messageIllegalAction

Constructor Detail

YieldAdapterIterator

public YieldAdapterIterator()

Method Detail

dispose

public abstract void dispose()

Because the Yield Adapter starts a separate thread for duration of the collection, this can be left open if the calling code only reads part of the collection. If the iterator goes out of scope, when it is GCed its finalize() will close the collection thread. However garbage collection is sporadic and the VM will not trigger it simply because there is a lack of available threads. So, if a lot of partial reads are happening, it will be wise to manually close the iterator (which will clear the resources immediately).

getMessageIllegalAction

public IllegalActionException getMessageIllegalAction()