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.
void	setListener(StreamGobbler.Listener listener) Set the InputStream listener.
void	start() Start 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

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

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.