Package org.opencastproject.util

Class StreamConsumer

java.lang.Object

org.opencastproject.util.StreamConsumer

All Implemented Interfaces:

Runnable

public class StreamConsumer
extends Object
implements Runnable

A StreamConsumer helps to asynchronously consume a text input stream line by line. The consumer guarantees the closing of the stream.

Constructor Summary

Constructors

Constructor	Description
StreamConsumer(com.entwinemedia.fn.Fn<String,Boolean> consumer)	Create a new stream consumer.

Method Summary

Modifier and Type	Method	Description
void	consume(InputStream stream)	Start consuming stream.
void	run()
void	stopConsuming()	Forcibly stop consuming the stream.
void	waitUntilFinished()	Wait until the stream has been fully consumed.
void	waitUntilRunning()	Wait for the executing thread to run.

Methods inherited from class java.lang.Object

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

Constructor Details

StreamConsumer

public StreamConsumer(com.entwinemedia.fn.Fn<String,Boolean> consumer)

Create a new stream consumer.

Parameters:

consumer - a predicate function that may stop reading further lines by returning false

Method Details

run

public void run()

Specified by:

run in interface Runnable

waitUntilRunning

public void waitUntilRunning()

Wait for the executing thread to run.

waitUntilFinished

public void waitUntilFinished()

Wait until the stream has been fully consumed.

stopConsuming

public void stopConsuming()

Forcibly stop consuming the stream.

consume

public void consume(InputStream stream)

Start consuming stream. It is guaranteed that the stream gets closed.