com.thoughtworks.go.plugin.api.task

Interface Console

public interface Console

Used to write information of a task run, out to the build log.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	Console.SecureEnvVarSpecifier Used to specify which environment variables are secure and shouldn't be printed literally.

Method Summary

Modifier and Type	Method and Description
void	printEnvironment(Map<String,String> environment, Console.SecureEnvVarSpecifier secureEnvVarSpecifier) Print details about the environment specified in the argument into the build log.
void	printLine(String line) Print a line out to the build log.
void	readErrorOf(InputStream in) Setup the console to read the input stream as standard error.
void	readOutputOf(InputStream in) Setup the console to read the input stream as standard output.

Method Detail

printLine

void printLine(String line)

Print a line out to the build log.

Parameters:

line - Line to write.

readErrorOf

void readErrorOf(InputStream in)

Setup the console to read the input stream as standard error.

This is used to connect the output of a process, to the build log. This is usually used as: console.readErrorOf(process.getErrorStream());

where the "process" object is of type Process.

Parameters:

in - The input stream to read as standard error.

readOutputOf

void readOutputOf(InputStream in)

Setup the console to read the input stream as standard output.

This is used to connect the output of a process, to the build log. This is usually used as: console.readOutputOf(process.getInputStream());

where the "process" object is of type Process.

Parameters:

in - The input stream to read as standard output.

printEnvironment

void printEnvironment(Map<String,String> environment,
                      Console.SecureEnvVarSpecifier secureEnvVarSpecifier)

Print details about the environment specified in the argument into the build log.

Parameters:

environment - Environment to print details of.

secureEnvVarSpecifier - Console.SecureEnvVarSpecifier