Package com.intellij.execution.process

Class ProcessOutputType

java.lang.Object

com.intellij.openapi.util.Key<java.lang.Object>

com.intellij.execution.process.ProcessOutputType

public class ProcessOutputType
extends Key<java.lang.Object>

Represents a stream (stdout/stderr/system) output type. It can be a base output type or a colored output type. Base stdout/stderr output types are constants: ProcessOutputTypes.STDOUT, ProcessOutputTypes.STDERR and ProcessOutputTypes.SYSTEM.
A colored stdout/stderr output type corresponds to an unique ANSI color attributes info passed as name constructor parameter, and base stream output type (stdout/stderr) - streamType parameter.

Use ConsoleViewContentType.getConsoleViewType(com.intellij.openapi.util.Key) to get TextAttributes for an instance of this class.

See Also:

ColoredOutputTypeRegistry, ConsoleViewContentType.registerNewConsoleViewType(com.intellij.openapi.util.Key, com.intellij.openapi.editor.colors.TextAttributesKey)

Field Summary

Fields

Modifier and Type	Field and Description
static ProcessOutputType	STDERR Base type for data from process standard error stream.
static ProcessOutputType	STDOUT Base type for data from process standard output stream.
static ProcessOutputType	SYSTEM

Constructor Summary

Constructors

Constructor and Description
ProcessOutputType(java.lang.String name, ProcessOutputType streamType)

Method Summary

Modifier and Type	Method and Description
ProcessOutputType	getBaseOutputType()
static java.lang.String	getKeyNameForLogging(Key<?> key)
boolean	isStderr()
static boolean	isStderr(Key<?> key)
boolean	isStdout()
static boolean	isStdout(Key<?> key)
static ProcessOutputType	tryCast(Key<?> key)

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

create, equals, findKeyByName, get, get, get, getKeyByIndex, getRequired, hashCode, isIn, set, set, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

SYSTEM

public static final ProcessOutputType SYSTEM

STDOUT

public static final ProcessOutputType STDOUT

Base type for data from process standard output stream.

Colored texts from stdout are represented by different instances of ProcessOutputType having ProcessOutputType.STDOUT base type:

 coloredStdoutType.getBaseOutputType() == ProcessOutputType.STDOUT

Thus to check whether a process output type is from stdout:

 ProcessOutputType.isStdout(key)

instead of

 ProcessOutputType.STDOUT.equals(key) or ProcessOutputType.STDOUT == key

STDERR

public static final ProcessOutputType STDERR

Base type for data from process standard error stream.

Colored texts from stderr are represented by different instances of ProcessOutputType having ProcessOutputType.STDERR base type:

 coloredStderrType.getBaseOutputType() == ProcessOutputType.STDERR

Thus to check whether a process output type is from stderr:

 ProcessOutputType.isStderr(key)

instead of

 ProcessOutputType.STDERR.equals(key) or ProcessOutputType.STDERR == key

Constructor Detail

ProcessOutputType

public ProcessOutputType(java.lang.String name,
                         ProcessOutputType streamType)

Method Detail

getBaseOutputType

public ProcessOutputType getBaseOutputType()

isStdout

public boolean isStdout()

isStderr

public boolean isStderr()

isStderr

public static boolean isStderr(Key<?> key)

isStdout

public static boolean isStdout(Key<?> key)

getKeyNameForLogging

public static java.lang.String getKeyNameForLogging(Key<?> key)

tryCast

public static ProcessOutputType tryCast(Key<?> key)