Package com.intellij.execution.process

Class CapturingProcessHandler

java.lang.Object

com.intellij.openapi.util.UserDataHolderBase

com.intellij.execution.process.ProcessHandler

com.intellij.execution.process.BaseProcessHandler<java.lang.Process>

com.intellij.execution.process.BaseOSProcessHandler

com.intellij.execution.process.OSProcessHandler

com.intellij.execution.process.CapturingProcessHandler

All Implemented Interfaces:

TaskExecutor, UserDataHolder, UserDataHolderEx

Direct Known Subclasses:

CapturingAnsiEscapesAwareProcessHandler, CapturingProcessHandler.Silent

public class CapturingProcessHandler
extends OSProcessHandler

Utility class for running an external process and capturing its standard output and error streams.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CapturingProcessHandler.Silent

Nested classes/interfaces inherited from class com.intellij.execution.process.BaseOSProcessHandler

BaseOSProcessHandler.SimpleOutputReader

Field Summary

Fields inherited from class com.intellij.execution.process.BaseProcessHandler

myCharset, myCommandLine, myPresentableName, myProcess, myWaitFor

Fields inherited from class com.intellij.execution.process.ProcessHandler

SILENTLY_DESTROY_ON_CLOSE, TERMINATION_REQUESTED

Constructor Summary

Constructors

Constructor and Description
CapturingProcessHandler(GeneralCommandLine commandLine)
CapturingProcessHandler(java.lang.Process process) Deprecated. Use CapturingProcessHandler(Process, Charset, String) instead
CapturingProcessHandler(java.lang.Process process, java.nio.charset.Charset charset, java.lang.String commandLine) commandLine must not be empty (for correct thread attribution in the stacktrace)

Method Summary

Modifier and Type	Method and Description
protected CapturingProcessAdapter	createProcessAdapter(ProcessOutput processOutput)
java.nio.charset.Charset	getCharset()
ProcessOutput	runProcess()
ProcessOutput	runProcess(int timeoutInMilliseconds) Starts process with specified timeout
ProcessOutput	runProcess(int timeoutInMilliseconds, boolean destroyOnTimeout) Starts process with specified timeout
ProcessOutput	runProcessWithProgressIndicator(ProgressIndicator indicator)
ProcessOutput	runProcessWithProgressIndicator(ProgressIndicator indicator, int timeoutInMilliseconds)
ProcessOutput	runProcessWithProgressIndicator(ProgressIndicator indicator, int timeoutInMilliseconds, boolean destroyOnTimeout)

Methods inherited from class com.intellij.execution.process.OSProcessHandler

checkEdtAndReadAction, deleteFileOnTermination, doDestroyProcess, getDefaultModality, killProcessTree, onOSProcessTerminated, processCanBeKilledByOS, processHasSeparateErrorStream, readerOptions, setHasPty, setShouldDestroyProcessRecursively, shouldDestroyProcessRecursively, waitFor, waitFor

Methods inherited from class com.intellij.execution.process.BaseOSProcessHandler

createErrorDataReader, createOutputDataReader, createProcessErrReader, createProcessOutReader, executeOnPooledThread, executeTask, startNotify, toString

Methods inherited from class com.intellij.execution.process.BaseProcessHandler

closeStreams, destroyProcessImpl, detachIsDefault, detachProcessImpl, getCommandLine, getProcess, getProcessInput

Methods inherited from class com.intellij.execution.process.ProcessHandler

addProcessListener, addProcessListener, destroyProcess, detachProcess, getExitCode, isProcessTerminated, isProcessTerminating, isSilentlyDestroyOnClose, isStartNotified, notifyProcessDetached, notifyProcessTerminated, notifyTextAvailable, removeProcessListener

Methods inherited from class com.intellij.openapi.util.UserDataHolderBase

changeUserMap, clearUserData, clone, copyCopyableDataTo, copyUserDataTo, getCopyableUserData, getUserData, getUserDataString, getUserMap, isUserDataEmpty, putCopyableUserData, putUserData, putUserDataIfAbsent, replace, setUserMap

Methods inherited from class java.lang.Object

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

Constructor Detail

CapturingProcessHandler

public CapturingProcessHandler(GeneralCommandLine commandLine)
                        throws ExecutionException

Throws:

ExecutionException

CapturingProcessHandler

@Deprecated
public CapturingProcessHandler(java.lang.Process process)

Deprecated. Use CapturingProcessHandler(Process, Charset, String) instead

CapturingProcessHandler

public CapturingProcessHandler(java.lang.Process process,
                               java.nio.charset.Charset charset,
                               java.lang.String commandLine)

commandLine must not be empty (for correct thread attribution in the stacktrace)

Method Detail

createProcessAdapter

protected CapturingProcessAdapter createProcessAdapter(ProcessOutput processOutput)

getCharset

public java.nio.charset.Charset getCharset()

Overrides:

getCharset in class BaseProcessHandler<java.lang.Process>

runProcess

public ProcessOutput runProcess()

runProcess

public ProcessOutput runProcess(int timeoutInMilliseconds)

Starts process with specified timeout

Parameters:

timeoutInMilliseconds - non-positive means infinity

runProcess

public ProcessOutput runProcess(int timeoutInMilliseconds,
                                boolean destroyOnTimeout)

Starts process with specified timeout

Parameters:

timeoutInMilliseconds - non-positive means infinity

destroyOnTimeout - whether to kill the process after timeout passes

runProcessWithProgressIndicator

public ProcessOutput runProcessWithProgressIndicator(ProgressIndicator indicator)

runProcessWithProgressIndicator

public ProcessOutput runProcessWithProgressIndicator(ProgressIndicator indicator,
                                                     int timeoutInMilliseconds)

runProcessWithProgressIndicator

public ProcessOutput runProcessWithProgressIndicator(ProgressIndicator indicator,
                                                     int timeoutInMilliseconds,
                                                     boolean destroyOnTimeout)