Package com.intellij.execution.process

Class ProcessHandler

java.lang.Object

com.intellij.openapi.util.UserDataHolderBase

com.intellij.execution.process.ProcessHandler

All Implemented Interfaces:

UserDataHolder, UserDataHolderEx

Direct Known Subclasses:

BaseProcessHandler, BuildProcessHandler, DefaultDebugProcessHandler, NopProcessHandler, PyAttachToProcessCommandLineState.PyRemoteDebugProcessHandler, PyConsoleDebugProcessHandler, RemoteDebugProcessHandler

public abstract class ProcessHandler
extends UserDataHolderBase

Field Summary

Fields

Modifier and Type	Field and Description
static Key<java.lang.Boolean>	SILENTLY_DESTROY_ON_CLOSE Deprecated.
static Key<java.lang.Boolean>	TERMINATION_REQUESTED

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ProcessHandler()

Method Summary

Modifier and Type	Method and Description
void	addProcessListener(ProcessListener listener)
void	addProcessListener(ProcessListener listener, Disposable parentDisposable)
void	destroyProcess() Destroys the process if isStartNotified() returns true, or postpones the action until startNotify() is called.
protected abstract void	destroyProcessImpl() Performs process destruction.
abstract boolean	detachIsDefault()
void	detachProcess() Detaches the process if isStartNotified() returns true, or postpones the action until startNotify() is called.
protected abstract void	detachProcessImpl() Performs detaching process.
java.lang.Integer	getExitCode()
abstract java.io.OutputStream	getProcessInput()
boolean	isProcessTerminated()
boolean	isProcessTerminating()
boolean	isSilentlyDestroyOnClose()
boolean	isStartNotified()
protected void	notifyProcessDetached()
protected void	notifyProcessTerminated(int exitCode)
void	notifyTextAvailable(java.lang.String text, Key outputType)
void	removeProcessListener(ProcessListener listener)
void	startNotify()
boolean	waitFor() Wait for process execution.
boolean	waitFor(long timeoutInMilliseconds)

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, toString, wait, wait, wait

Field Detail

SILENTLY_DESTROY_ON_CLOSE

@Deprecated
public static final Key<java.lang.Boolean> SILENTLY_DESTROY_ON_CLOSE

Deprecated.

todo: replace with an overridable method [nik]

TERMINATION_REQUESTED

public static final Key<java.lang.Boolean> TERMINATION_REQUESTED

Constructor Detail

ProcessHandler

protected ProcessHandler()

Method Detail

startNotify

public void startNotify()

destroyProcessImpl

protected abstract void destroyProcessImpl()

Performs process destruction.

This is an internal implementation of destroyProcess(). All sub-classes must implement this method and perform the destruction in this method. This method is called from destroyProcess() and it can be in any thread including the event dispatcher thread. You should avoid doing any expensive operation directly in this method. Instead, you may post the work to background thread and return without waiting for it. If the performed destruction led to process termination, notifyProcessTerminated(int) must be called in any thread (not necessary from this method).

detachProcessImpl

protected abstract void detachProcessImpl()

Performs detaching process.

This is an internal implementation of detachProcess(). All sub-classes must implement this method and perform the detaching in this method. This method is called from detachProcess() and it can be in any thread including the event dispatcher thread. You should avoid doing any expensive operation directly in this method. Instead, you may post the work to background thread and return without waiting for it. If the performed detaching is completed, notifyProcessTerminated(int) must be called in any thread (not necessary from this method).

detachIsDefault

public abstract boolean detachIsDefault()

waitFor

public boolean waitFor()

Wait for process execution.

Returns:

true if target process has actually ended; false if we stopped watching the process execution and don't know if it has completed.

waitFor

public boolean waitFor(long timeoutInMilliseconds)

destroyProcess

public void destroyProcess()

Destroys the process if isStartNotified() returns true, or postpones the action until startNotify() is called.

It changes the process handler's state and isProcessTerminating() becomes true. This method may return without waiting for the process termination. Upon the completion of the process termination, isProcessTerminated() becomes true.

detachProcess

public void detachProcess()

Detaches the process if isStartNotified() returns true, or postpones the action until startNotify() is called.

It changes the process handler's state and isProcessTerminating() becomes true. This method may return without waiting for detaching the process. Upon the completion of the detaching, isProcessTerminated() becomes true.

isProcessTerminated

public boolean isProcessTerminated()

isProcessTerminating

public boolean isProcessTerminating()

getExitCode

public java.lang.Integer getExitCode()

Returns:

exit code if the process has already finished, null otherwise

addProcessListener

public void addProcessListener(ProcessListener listener)

addProcessListener

public void addProcessListener(ProcessListener listener,
                               Disposable parentDisposable)

removeProcessListener

public void removeProcessListener(ProcessListener listener)

notifyProcessDetached

protected void notifyProcessDetached()

notifyProcessTerminated

protected void notifyProcessTerminated(int exitCode)

notifyTextAvailable

public void notifyTextAvailable(java.lang.String text,
                                Key outputType)

getProcessInput

public abstract java.io.OutputStream getProcessInput()

isStartNotified

public boolean isStartNotified()

isSilentlyDestroyOnClose

public boolean isSilentlyDestroyOnClose()