org.calrissian.mango.collect

Class AbstractCloseableIterable<T>

java.lang.Object

org.calrissian.mango.collect.AbstractCloseableIterable<T>

All Implemented Interfaces:

Closeable, AutoCloseable, Iterable<T>, CloseableIterable<T>

Direct Known Subclasses:

FluentCloseableIterable

public abstract class AbstractCloseableIterable<T>
extends Object
implements CloseableIterable<T>

This class represents a skeletal implementation of a CloseableIterable. The implementation will manage all operations concerned with checks regarding whether a resource has already been closed.

Implementations of this abstract class will have to implement the logic involved in actually closing and retrieving the Iterator from the Iterable.

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	closed

Constructor Summary

Constructors

Constructor and Description
AbstractCloseableIterable()

Method Summary

Modifier and Type	Method and Description
void	close()
void	closeQuietly() Unconditionally closes the iterator.
protected abstract void	doClose() Performes the logic to cleanup any held resources
Iterator<T>	iterator()
protected abstract Iterator<T>	retrieveIterator() Returns an iterator over a set of elements of type T.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

closed

protected boolean closed

Constructor Detail

AbstractCloseableIterable

public AbstractCloseableIterable()

Method Detail

doClose

protected abstract void doClose()
                         throws IOException

Performes the logic to cleanup any held resources

Throws:

IOException

retrieveIterator

protected abstract Iterator<T> retrieveIterator()

Returns an iterator over a set of elements of type T.

Returns:

an Iterator.

closeQuietly

public void closeQuietly()

Unconditionally closes the iterator.

Equivalent to Closeable.close(), except any exceptions will be ignored.

Specified by:

closeQuietly in interface CloseableIterable<T>

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException

iterator

public Iterator<T> iterator()

Specified by:

iterator in interface Iterable<T>