Package com.intellij.util.io

Class BaseDataReader

java.lang.Object

com.intellij.util.io.BaseDataReader

Direct Known Subclasses:

BaseOutputReader, BinaryOutputReader

public abstract class BaseDataReader
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BaseDataReader.AdaptiveSleepingPolicy Deprecated. use one of default policies (recommended) or implement your own
static interface	BaseDataReader.SleepingPolicy

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	isStopped
protected BaseDataReader.SleepingPolicy	mySleepingPolicy
protected java.lang.Object	mySleepMonitor

Constructor Summary

Constructors

Constructor and Description
BaseDataReader(BaseDataReader.SleepingPolicy sleepingPolicy)

Method Summary

Modifier and Type	Method and Description
protected void	beforeSleeping(boolean hasJustReadSomething)
protected abstract void	close()
protected void	doRun()
protected abstract java.util.concurrent.Future<?>	executeOnPooledThread(java.lang.Runnable runnable)
protected void	flush()
protected boolean	readAvailable() Please don't override this method as the BaseOSProcessProcessHandler assumes that it can be two reading modes: blocking and non-blocking.
protected boolean	readAvailableBlocking() Reader in a blocking mode blocks on IO read operation until data is received.
protected boolean	readAvailableNonBlocking() Non-blocking read returns the control back to the process handler when there is no data to read.
protected void	start() Deprecated. use start(String)
protected void	start(java.lang.String presentableName)
void	stop()
void	waitFor()
void	waitFor(long timeout, java.util.concurrent.TimeUnit unit)

Methods inherited from class java.lang.Object

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

Field Detail

mySleepingPolicy

protected final BaseDataReader.SleepingPolicy mySleepingPolicy

mySleepMonitor

protected final java.lang.Object mySleepMonitor

isStopped

protected volatile boolean isStopped

Constructor Detail

BaseDataReader

public BaseDataReader(BaseDataReader.SleepingPolicy sleepingPolicy)

Parameters:

sleepingPolicy - default is BaseDataReader.SleepingPolicy.NON_BLOCKING for the reasons described on BaseDataReader.SleepingPolicy which may be changed in future versions.

Method Detail

start

protected void start(java.lang.String presentableName)

readAvailable

protected boolean readAvailable()
                         throws java.io.IOException

Please don't override this method as the BaseOSProcessProcessHandler assumes that it can be two reading modes: blocking and non-blocking. Implement readAvailableBlocking() and readAvailableNonBlocking() instead. If the process handler assumes that reader handles the blocking mode, while it doesn't, it will result into premature stream close.

Returns:

true in case any data was read

Throws:

java.io.IOException - if an exception during IO happened

See Also:

BaseDataReader.SleepingPolicy

readAvailableNonBlocking

protected boolean readAvailableNonBlocking()
                                    throws java.io.IOException

Non-blocking read returns the control back to the process handler when there is no data to read.

Throws:

java.io.IOException

See Also:

BaseDataReader.SleepingPolicy.NON_BLOCKING

readAvailableBlocking

protected boolean readAvailableBlocking()
                                 throws java.io.IOException

Reader in a blocking mode blocks on IO read operation until data is received. It exits the method only after the stream is closed.

Throws:

java.io.IOException

See Also:

BaseDataReader.SleepingPolicy.BLOCKING

executeOnPooledThread

protected abstract java.util.concurrent.Future<?> executeOnPooledThread(java.lang.Runnable runnable)

doRun

protected void doRun()

flush

protected void flush()

beforeSleeping

protected void beforeSleeping(boolean hasJustReadSomething)

close

protected abstract void close()
                       throws java.io.IOException

Throws:

java.io.IOException

stop

public void stop()

waitFor

public void waitFor()
             throws java.lang.InterruptedException

Throws:

java.lang.InterruptedException

waitFor

public void waitFor(long timeout,
                    java.util.concurrent.TimeUnit unit)
             throws java.lang.InterruptedException,
                    java.util.concurrent.TimeoutException

Throws:

java.lang.InterruptedException

java.util.concurrent.TimeoutException

start

@Deprecated
protected void start()

Deprecated. use start(String)