org.mdiutil.io

Class StreamGobbler

java.lang.Object

org.mdiutil.io.StreamGobbler

public class StreamGobbler
extends Object

A class which constantly consumes the input from an InputStream, and distribute the input lines to a listener.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	StreamGobbler.Listener A listener which listens to a StreamGobbler InputStream.

Constructor Summary

Constructors

Constructor and Description
StreamGobbler(InputStream in) Constructor with the default UTF-8 charset.
StreamGobbler(InputStream in, Charset charset) Constructor.
StreamGobbler(InputStream in, String charset) Constructor.

Method Summary

Modifier and Type	Method and Description
void	close() Close the Gobbler.
InputStream	getInputStream() Return the underlying InputStream.
StreamGobbler.Listener	getListener() Return the InputStream listener.
boolean	isClosed() Return true if the globbler is closed.
boolean	isQueued() Return true if the gobbler is queue.
boolean	isStarted() Return true if the globbler is started.
void	setListener(StreamGobbler.Listener listener) Set the InputStream listener.
void	setQueued(boolean isQueued) Set if the gobbler is queued.
void	setQueued(boolean isQueued, int delay) Set if the gobbler is queued.It will not do anything if the gobbler is started.
void	setQueued(boolean isQueued, int delay, int pollingRate) Set if the gobbler is queued.
void	start() Start the Gobbler.
void	stop() Stop the Gobbler.

Methods inherited from class java.lang.Object

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

Constructor Detail

StreamGobbler

public StreamGobbler(InputStream in)

Constructor with the default UTF-8 charset.

Parameters:

in - the InputStream

StreamGobbler

public StreamGobbler(InputStream in,
                     String charset)

Constructor.

Parameters:

in - the InputStream

charset - the charset name

StreamGobbler

public StreamGobbler(InputStream in,
                     Charset charset)

Constructor.

Parameters:

in - the InputStream

charset - the charset

Method Detail

setQueued

public void setQueued(boolean isQueued)

Set if the gobbler is queued. It will not do anything if the gobbler is started.

Parameters:

isQueued - true if the gobbler is queued

setQueued

public void setQueued(boolean isQueued,
                      int delay)

Set if the gobbler is queued.It will not do anything if the gobbler is started. The polling rate of the queue will be defaulted to 500 ms.

Parameters:

isQueued - true if the gobbler is queued

delay - the queueing delay

setQueued

public void setQueued(boolean isQueued,
                      int delay,
                      int pollingRate)

Set if the gobbler is queued. It will not do anything if the gobbler is already started.

Parameters:

isQueued - true if the gobbler is queued

delay - the queueing delay

pollingRate - the polling rate of the queue

isQueued

public boolean isQueued()

Return true if the gobbler is queue.

Returns:

true if the gobbler is queue

setListener

public void setListener(StreamGobbler.Listener listener)

Set the InputStream listener.

Parameters:

listener - the listener

getListener

public StreamGobbler.Listener getListener()

Return the InputStream listener.

Returns:

the listener

getInputStream

public InputStream getInputStream()

Return the underlying InputStream.

Returns:

the InputStream

isStarted

public boolean isStarted()

Return true if the globbler is started.

Returns:

true if the globbler is started

isClosed

public boolean isClosed()

Return true if the globbler is closed.

Returns:

true if the globbler is closed

start

public void start()

Start the Gobbler.

close

public void close()

Close the Gobbler. Note that the listener won't get any new line, but the underlying InputStream won't be closed.

stop

public void stop()

Stop the Gobbler. It will also make sure tha the underlying queue is closed.