info.aduna.concurrent.locks

Class LockingIteration<E,X extends Exception>

java.lang.Object

info.aduna.iteration.CloseableIterationBase<E,X>

info.aduna.iteration.IterationWrapper<E,X>

info.aduna.concurrent.locks.LockingIteration<E,X>

All Implemented Interfaces:

CloseableIteration<E,X>, Iteration<E,X>

public class LockingIteration<E,X extends Exception>
extends IterationWrapper<E,X>

An Iteration that holds on to a lock until the Iteration is closed. Upon closing, the underlying Iteration is closed before the lock is released. This iterator closes itself as soon as all elements have been read.

Field Summary

Fields inherited from class info.aduna.iteration.IterationWrapper

wrappedIter

Constructor Summary

Constructors

Constructor and Description
LockingIteration(Lock lock, Iteration<? extends E,X> iter) Creates a new LockingIteration.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	handleClose()
boolean	hasNext()
E	next()
void	remove()

Methods inherited from class info.aduna.iteration.CloseableIterationBase

close, isClosed

Methods inherited from class java.lang.Object

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

Constructor Detail

LockingIteration

public LockingIteration(Lock lock,
                Iteration<? extends E,X> iter)

Creates a new LockingIteration.

Parameters:

lock - The lock to release when the itererator is closed, must not be null.

iter - The underlying Iteration, must not be null.

Method Detail

hasNext

public boolean hasNext()
                throws X extends Exception

Specified by:

hasNext in interface Iteration<E,X extends Exception>

Overrides:

hasNext in class IterationWrapper<E,X extends Exception>

Throws:

X extends Exception

next

public E next()
       throws X extends Exception

Specified by:

next in interface Iteration<E,X extends Exception>

Overrides:

next in class IterationWrapper<E,X extends Exception>

Throws:

X extends Exception

remove

public void remove()
            throws X extends Exception

Specified by:

remove in interface Iteration<E,X extends Exception>

Overrides:

remove in class IterationWrapper<E,X extends Exception>

Throws:

X extends Exception

handleClose

protected void handleClose()
                    throws X extends Exception

Overrides:

handleClose in class IterationWrapper<E,X extends Exception>

Throws:

X extends Exception