com.metamx.common.guava

Class ResourceClosingYielder<OutType>

java.lang.Object

com.metamx.common.guava.ResourceClosingYielder<OutType>

All Implemented Interfaces:

Yielder<OutType>, Closeable, AutoCloseable

public class ResourceClosingYielder<OutType>
extends Object
implements Yielder<OutType>

Constructor Summary

Constructors

Constructor and Description
ResourceClosingYielder(Yielder<OutType> baseYielder, Closeable closeable)

Method Summary

Methods

Modifier and Type	Method and Description
void	close()
OutType	get() Gets the object currently held by this Yielder.
boolean	isDone() Returns true if this is the last Yielder in the chain.
Yielder<OutType>	next(OutType initValue) Gets the next Yielder in the chain.

Methods inherited from class java.lang.Object

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

Constructor Detail

ResourceClosingYielder

public ResourceClosingYielder(Yielder<OutType> baseYielder,
                      Closeable closeable)

Method Detail

get

public OutType get()

Description copied from interface: Yielder

Gets the object currently held by this Yielder. Can be called multiple times as long as next() is not called. Once next() is called on this Yielder object, all further operations on this object are undefined.

Specified by:

get in interface Yielder<OutType>

Returns:

the currently yielded object, null if done

next

public Yielder<OutType> next(OutType initValue)

Description copied from interface: Yielder

Gets the next Yielder in the chain. The argument is used as the accumulator value to pass along to start the accumulation until the next yield() call or iteration completes. Once next() is called on this Yielder object, all further operations on this object are undefined.

Specified by:

next in interface Yielder<OutType>

Parameters:

initValue - the initial value to pass along to start the accumulation until the next yield() call or iteration completes.

Returns:

the next Yielder in the chain, or undefined if done

isDone

public boolean isDone()

Description copied from interface: Yielder

Returns true if this is the last Yielder in the chain. A Yielder that isDone() may return anything from both get() and next(), there is no contract and depending on those return values will likely lead to bugs. It will probably break your code to call next() on a Yielder that is done and expect something good from it. Once next() is called on this Yielder object, all further operations on this object are undefined.

Specified by:

isDone in interface Yielder<OutType>

Returns:

true if this is the last Yielder in the chain, false otherwise

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException