org.conqat.lib.commons.io

Class StreamReaderThread

java.lang.Object

java.lang.Thread

org.conqat.lib.commons.io.StreamReaderThread

All Implemented Interfaces:

java.lang.Runnable

public class StreamReaderThread
extends java.lang.Thread

A thread to drain an input stream. Storing the content is optional. If an exception occurs during draining, the exceptions message is appended to the content and the exception is also made available via getException(). So if the caller wants to ensure that the content is really complete, he not only has to wait for the end of the thread via join, but also check this method.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Thread

java.lang.Thread.State, java.lang.Thread.UncaughtExceptionHandler

Field Summary

Fields inherited from class java.lang.Thread

MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY

Constructor Summary

Constructors

Constructor and Description
StreamReaderThread(java.io.InputStream input) Create a new reader that reads the content of this stream in its own thread.
StreamReaderThread(java.io.InputStream input, java.nio.charset.Charset charset) Create a new reader that reads the content of this stream in its own thread.
StreamReaderThread(java.io.InputStream input, java.nio.charset.Charset charset, boolean storeContent) Create a new reader that reads the content of this stream in its own thread.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getContent() Returns the content read from the stream.
java.io.IOException	getException() If everything went ok during reading from the stream, this returns null.
void	run() Reads content from the stream as long as the stream is not empty.

Methods inherited from class java.lang.Thread

activeCount, checkAccess, clone, countStackFrames, currentThread, destroy, dumpStack, enumerate, getAllStackTraces, getContextClassLoader, getDefaultUncaughtExceptionHandler, getId, getName, getPriority, getStackTrace, getState, getThreadGroup, getUncaughtExceptionHandler, holdsLock, interrupt, interrupted, isAlive, isDaemon, isInterrupted, join, join, join, resume, setContextClassLoader, setDaemon, setDefaultUncaughtExceptionHandler, setName, setPriority, setUncaughtExceptionHandler, sleep, sleep, start, stop, stop, suspend, toString, yield

Methods inherited from class java.lang.Object

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

Constructor Detail

StreamReaderThread

public StreamReaderThread(java.io.InputStream input)

Create a new reader that reads the content of this stream in its own thread. => This call is non-blocking.

This constructor causes the content to be stored.

Parameters:

input - Stream to read from. This stream is not automatically closed, but must be closed by the caller (if this is intended).

StreamReaderThread

public StreamReaderThread(java.io.InputStream input,
                          java.nio.charset.Charset charset)

Create a new reader that reads the content of this stream in its own thread. => This call is non-blocking.

This constructor causes the content to be stored.

Parameters:

input - Stream to read from. This stream is not automatically closed, but must be closed by the caller (if this is intended).

charset - Character set to be used to convert the stream into a string.

StreamReaderThread

public StreamReaderThread(java.io.InputStream input,
                          java.nio.charset.Charset charset,
                          boolean storeContent)

Create a new reader that reads the content of this stream in its own thread. => This call is non-blocking

Parameters:

input - Stream to read from. This stream is not automatically closed, but must be closed by the caller (if this is intended).

Method Detail

run

public void run()

Reads content from the stream as long as the stream is not empty.

Specified by:

run in interface java.lang.Runnable

Overrides:

run in class java.lang.Thread

getContent

public java.lang.String getContent()

Returns the content read from the stream.

getException

public java.io.IOException getException()

If everything went ok during reading from the stream, this returns null. Otherwise the exception can be found here.