Class SailClosingIteration<T, X extends Exception>

java.lang.Object

org.eclipse.rdf4j.common.iteration.AbstractCloseableIteration<T,X>

org.eclipse.rdf4j.common.iteration.IterationWrapper<T,X>

org.eclipse.rdf4j.sail.base.SailClosingIteration<T,X>

All Implemented Interfaces:

AutoCloseable, CloseableIteration<T,X>, Iteration<T,X>

abstract class SailClosingIteration<T, X extends Exception>
extends IterationWrapper<T,X>

An Iteration that holds on to a SailClosable 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

Modifier and Type	Field	Description
private final SailClosable[]	closes	The lock to release when the Iteration is closed.

Fields inherited from class IterationWrapper

wrappedIter

Constructor Summary

Constructors

Constructor	Description
SailClosingIteration(CloseableIteration<? extends T, X> iter, SailClosable... closes)	Creates a new Iteration that automatically closes the given SailClosables.

Method Summary

Modifier and Type	Method	Description
protected void	handleClose()	Closes this Iteration and also closes the wrapped Iteration if it is a CloseableIteration.
protected abstract void	handleSailException(SailException e)	Handler for exceptions generated by the closure of the SailClosable array given to this object.
boolean	hasNext()	Checks whether the wrapped Iteration contains more elements, closing this Iteration when this is not the case.
static <E> SailClosingIteration<E, SailException>	makeClosable(CloseableIteration<? extends E, SailException> iter, SailClosable... closes)	Creates a new Iteration that automatically closes the given SailClosables.
T	next()	Returns the next element from the wrapped Iteration.
void	remove()	Removes the last element that has been returned from the wrapped Iteration.

Methods inherited from class AbstractCloseableIteration

close, isClosed

Methods inherited from class Object

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

Methods inherited from interface CloseableIteration

stream

Field Details

closes

private final SailClosable[] closes

The lock to release when the Iteration is closed.

Constructor Details

SailClosingIteration

public SailClosingIteration(CloseableIteration<? extends T, X> iter,
 SailClosable... closes)

Creates a new Iteration that automatically closes the given SailClosables.

Parameters:

iter - The underlying Iteration, must not be null.

closes - The SailClosables to SailClosable.close() when the itererator is closed.

Method Details

makeClosable

public static <E>
SailClosingIteration<E, SailException> makeClosable(CloseableIteration<? extends E, SailException> iter,
 SailClosable... closes)

Creates a new Iteration that automatically closes the given SailClosables.

Parameters:

iter - The underlying Iteration, must not be null.

closes - The SailClosables to SailClosable.close() when the itererator is closed.

Returns:

a CloseableIteration that closes the given SailClosable

hasNext

public boolean hasNext()
                throws X

Description copied from class: IterationWrapper

Checks whether the wrapped Iteration contains more elements, closing this Iteration when this is not the case.

Specified by:

hasNext in interface Iteration<T, X extends Exception>

Overrides:

hasNext in class IterationWrapper<T, X extends Exception>

Returns:

true if the wrapped Iteration contains more elements, false otherwise.

Throws:

X

next

public T next()
       throws X

Description copied from class: IterationWrapper

Returns the next element from the wrapped Iteration.

Specified by:

next in interface Iteration<T, X extends Exception>

Overrides:

next in class IterationWrapper<T, X extends Exception>

Returns:

the next element in the iteration.

Throws:

X

remove

public void remove()
            throws X

Description copied from class: IterationWrapper

Removes the last element that has been returned from the wrapped Iteration.

Specified by:

remove in interface Iteration<T, X extends Exception>

Overrides:

remove in class IterationWrapper<T, X extends Exception>

Throws:

X

handleClose

protected void handleClose()
                    throws X

Description copied from class: IterationWrapper

Closes this Iteration and also closes the wrapped Iteration if it is a CloseableIteration.

Overrides:

handleClose in class IterationWrapper<T, X extends Exception>

Throws:

X

handleSailException

protected abstract void handleSailException(SailException e)
                                     throws X

Handler for exceptions generated by the closure of the SailClosable array given to this object.
This method is called after all of the SailClosable objects have had close called on them.

Parameters:

e - The SailException to handle.

Throws:

X - Instances of this generic-typed exception in response to the given SailException if the handler decides to propagate the exception.