Package com.intellij.util.io

Class BaseOutputReader

java.lang.Object

com.intellij.util.io.BaseDataReader

com.intellij.util.io.BaseOutputReader

Direct Known Subclasses:

BaseOSProcessHandler.SimpleOutputReader

public abstract class BaseOutputReader
extends BaseDataReader

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BaseOutputReader.Options See #BaseOutputReader(Reader, Options), BaseDataReader.readAvailable(), BaseDataReader.SleepingPolicy and processInput(char[], java.lang.StringBuilder, int) for reference.

Nested classes/interfaces inherited from class com.intellij.util.io.BaseDataReader

BaseDataReader.AdaptiveSleepingPolicy, BaseDataReader.SleepingPolicy

Field Summary

Fields

Modifier and Type	Field and Description
protected java.io.Reader	myReader

Fields inherited from class com.intellij.util.io.BaseDataReader

isStopped, mySleepingPolicy, mySleepMonitor

Constructor Summary

Constructors

Constructor and Description
BaseOutputReader(java.io.InputStream inputStream, java.nio.charset.Charset charset)
BaseOutputReader(java.io.InputStream inputStream, java.nio.charset.Charset charset, BaseOutputReader.Options options)
BaseOutputReader(java.io.Reader reader)
BaseOutputReader(java.io.Reader reader, BaseDataReader.SleepingPolicy policy) Deprecated. use BaseOutputReader(Reader, Options)
BaseOutputReader(java.io.Reader reader, BaseOutputReader.Options options)

Method Summary

Modifier and Type	Method and Description
protected void	close()
protected void	flush()
protected abstract void	onTextAvailable(java.lang.String text)
protected boolean	readAvailableBlocking() Reads data with blocking.
protected boolean	readAvailableNonBlocking() Reads as much data as possible without blocking.

Methods inherited from class com.intellij.util.io.BaseDataReader

beforeSleeping, doRun, executeOnPooledThread, readAvailable, start, start, stop, waitFor, waitFor

Methods inherited from class java.lang.Object

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

Field Detail

myReader

protected final java.io.Reader myReader

Constructor Detail

BaseOutputReader

public BaseOutputReader(java.io.InputStream inputStream,
                        java.nio.charset.Charset charset)

BaseOutputReader

public BaseOutputReader(java.io.InputStream inputStream,
                        java.nio.charset.Charset charset,
                        BaseOutputReader.Options options)

BaseOutputReader

public BaseOutputReader(java.io.Reader reader)

BaseOutputReader

public BaseOutputReader(java.io.Reader reader,
                        BaseOutputReader.Options options)

BaseOutputReader

@Deprecated
public BaseOutputReader(java.io.Reader reader,
                        BaseDataReader.SleepingPolicy policy)

Deprecated. use BaseOutputReader(Reader, Options)

Method Detail

readAvailableNonBlocking

protected final boolean readAvailableNonBlocking()
                                          throws java.io.IOException

Reads as much data as possible without blocking. Relies on InputStream.ready method. When in doubt, take a look at readAvailableBlocking().

Overrides:

readAvailableNonBlocking in class BaseDataReader

Returns:

true if non-zero amount of data has been read

Throws:

java.io.IOException - If an I/O error occurs

See Also:

BaseDataReader.SleepingPolicy.NON_BLOCKING

readAvailableBlocking

protected final boolean readAvailableBlocking()
                                       throws java.io.IOException

Reads data with blocking. Should be used in case when Reader.ready() method always returns false for your input stream. Should be used if we want to make our reader exit when the end of a stream is reached. Could be used if we prefer IO-blocking over CPU sleeping.

Overrides:

readAvailableBlocking in class BaseDataReader

Returns:

true if non-zero amount of data has been read, false if end of the stream is reached

Throws:

java.io.IOException - If an I/O error occurs

See Also:

BaseDataReader.SleepingPolicy.BLOCKING

flush

protected void flush()

Overrides:

flush in class BaseDataReader

close

protected void close()
              throws java.io.IOException

Specified by:

close in class BaseDataReader

Throws:

java.io.IOException

onTextAvailable

protected abstract void onTextAvailable(java.lang.String text)