Package com.intellij.execution.process

Class ColoredProcessHandler

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.KillableProcessHandler

com.intellij.execution.process.ColoredProcessHandler

All Implemented Interfaces:

KillableProcess, AnsiEscapeDecoder.ColoredTextAcceptor, TaskExecutor, UserDataHolder, UserDataHolderEx

Direct Known Subclasses:

KillableColoredProcessHandler

public class ColoredProcessHandler
extends KillableProcessHandler
implements AnsiEscapeDecoder.ColoredTextAcceptor

This process handler supports ANSI coloring.

Although it supports the feature, it is turned off by default for compatibility reasons. To turn it on either call KillableProcessHandler.setShouldKillProcessSoftly(boolean), or extend from KillableColoredProcessHandler.

Nested Class Summary

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

OSProcessHandler.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
ColoredProcessHandler(GeneralCommandLine commandLine)
ColoredProcessHandler(java.lang.Process process, java.lang.String commandLine) commandLine must not be not empty (for correct thread attribution in the stacktrace)
ColoredProcessHandler(java.lang.Process process, java.lang.String commandLine, java.nio.charset.Charset charset) commandLine must not be not empty (for correct thread attribution in the stacktrace)
ColoredProcessHandler(java.lang.Process process, java.lang.String commandLine, java.nio.charset.Charset charset, java.util.Set<? extends java.io.File> filesToDelete) commandLine must not be not empty (for correct thread attribution in the stacktrace)

Method Summary

Modifier and Type	Method and Description
void	addColoredTextListener(AnsiEscapeDecoder.ColoredTextAcceptor listener) Deprecated. use ProcessHandler.addProcessListener(ProcessListener) instead and listen for ProcessListener.onTextAvailable(ProcessEvent, Key) events
void	coloredTextAvailable(java.lang.String text, Key attributes) Override this method to handle colored text lines.
protected void	notifyColoredListeners(java.lang.String text, Key attributes) Deprecated. the method is kept for backward compatibility only
void	notifyTextAvailable(java.lang.String text, Key outputType)

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

canKillProcess, destroyProcessGracefully, destroyProcessImpl, doDestroyProcess, killProcess, mediate, notifyProcessTerminated, setShouldKillProcessSoftly, setShouldKillProcessSoftlyWithWinP, shouldKillProcessSoftly

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

checkEdtAndReadAction, deleteFileOnTermination, 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, detachIsDefault, detachProcessImpl, getCharset, getCommandLine, getProcess, getProcessInput

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

addProcessListener, addProcessListener, destroyProcess, detachProcess, getExitCode, isProcessTerminated, isProcessTerminating, isSilentlyDestroyOnClose, isStartNotified, notifyProcessDetached, 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

ColoredProcessHandler

public ColoredProcessHandler(GeneralCommandLine commandLine)
                      throws ExecutionException

Throws:

ExecutionException

ColoredProcessHandler

public ColoredProcessHandler(java.lang.Process process,
                             java.lang.String commandLine)

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

ColoredProcessHandler

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

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

ColoredProcessHandler

public ColoredProcessHandler(java.lang.Process process,
                             java.lang.String commandLine,
                             java.nio.charset.Charset charset,
                             java.util.Set<? extends java.io.File> filesToDelete)

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

Method Detail

notifyTextAvailable

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

Overrides:

notifyTextAvailable in class ProcessHandler

coloredTextAvailable

public void coloredTextAvailable(java.lang.String text,
                                 Key attributes)

Override this method to handle colored text lines. Overrides should call super.coloredTextAvailable() if they want to pass lines to registered listeners To receive chunks of data instead of fragments inherit your class from ColoredChunksAcceptor interface and override coloredChunksAvailable method.

Specified by:

coloredTextAvailable in interface AnsiEscapeDecoder.ColoredTextAcceptor

notifyColoredListeners

@Deprecated
protected void notifyColoredListeners(java.lang.String text,
                                      Key attributes)

Deprecated. the method is kept for backward compatibility only

addColoredTextListener

@Deprecated
public void addColoredTextListener(AnsiEscapeDecoder.ColoredTextAcceptor listener)

Deprecated. use ProcessHandler.addProcessListener(ProcessListener) instead and listen for ProcessListener.onTextAvailable(ProcessEvent, Key) events