Package org.eclipse.ui.console
Class MessageConsoleStream
- java.lang.Object
-
- java.io.OutputStream
-
- org.eclipse.ui.console.IOConsoleOutputStream
-
- org.eclipse.ui.console.MessageConsoleStream
-
- All Implemented Interfaces:
Closeable
,Flushable
,AutoCloseable
public class MessageConsoleStream extends IOConsoleOutputStream
Used to write messages to a message console. A message console may have more than one stream connected to it. Each stream may be displayed in a different color.Instances are created via a
MessageConsole
.Clients should avoid writing large amounts of output to this stream in the UI thread. The console needs to process the output in the UI thread and if the client hogs the UI thread writing output to the console, the console will not be able to process the output.
Since 3.1, this class extends
IOConsoleOutputStream
.- Since:
- 3.0
- Restriction:
- This class is not intended to be subclassed by clients.
- Restriction:
- This class is not intended to be instantiated by clients.
-
-
Constructor Summary
Constructors Constructor Description MessageConsoleStream(MessageConsole console)
Constructs a new stream connected to the given console with workbench default encoding.MessageConsoleStream(MessageConsole console, Charset charset)
Constructs a new stream connected to the given console.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description MessageConsole
getConsole()
Returns the console this stream is connected to.void
print(String message)
Appends the specified message to this stream.void
println()
Appends a line separator string to this stream.void
println(String message)
Appends the specified message to this stream, followed by a line separator string.-
Methods inherited from class org.eclipse.ui.console.IOConsoleOutputStream
close, flush, getColor, getFontStyle, isActivateOnWrite, isClosed, setActivateOnWrite, setCharset, setColor, setEncoding, setFontStyle, write, write, write, write, write, write, write
-
Methods inherited from class java.io.OutputStream
nullOutputStream
-
-
-
-
Constructor Detail
-
MessageConsoleStream
public MessageConsoleStream(MessageConsole console)
Constructs a new stream connected to the given console with workbench default encoding.- Parameters:
console
- the console to write messages to
-
MessageConsoleStream
public MessageConsoleStream(MessageConsole console, Charset charset)
Constructs a new stream connected to the given console.- Parameters:
console
- the console to write messages tocharset
- encoding used to write to console- Since:
- 3.7
-
-
Method Detail
-
print
public void print(String message)
Appends the specified message to this stream.- Parameters:
message
- message to append
-
println
public void println()
Appends a line separator string to this stream.
-
println
public void println(String message)
Appends the specified message to this stream, followed by a line separator string.- Parameters:
message
- message to print
-
getConsole
public MessageConsole getConsole()
Returns the console this stream is connected to.- Returns:
- the console this stream is connected to
-
-