Eclipse Platform
Release 3.1

org.eclipse.ui.console
Class IOConsoleOutputStream

java.lang.Object
  extended byjava.io.OutputStream
      extended byorg.eclipse.ui.console.IOConsoleOutputStream
Direct Known Subclasses:
MessageConsoleStream

public class IOConsoleOutputStream
extends OutputStream

OutputStream used to write to an IOConsole.

Clients are not intended to instantiate this class directly, instead use IOConsole.newOutputStream(). Clients are not intended to subclass this class.

Since:
3.1

Method Summary
 void close()
           
 void flush()
           
 Color getColor()
          Returns the color of this stream, or null if default.
 int getFontStyle()
          Returns the font style used to decorate data written to this stream.
 boolean isActivateOnWrite()
          Returns whether the console this stream is writing to will be activated when this stream is written to.
 boolean isClosed()
          Returns true if the stream has been closed
 void setActivateOnWrite(boolean activateOnWrite)
          Sets whether to activate the console this stream is writing to when this stream is written to.
 void setColor(Color newColor)
          Sets the color of this stream.
 void setEncoding(String encoding)
          Sets the character encoding used to interpret characters written to this steam.
 void setFontStyle(int newFontStyle)
          Sets the font style to be used to decorate data written to this stream.
 void write(byte[] b)
           
 void write(byte[] b, int off, int len)
           
 void write(int b)
           
 void write(String str)
          Writes a string to the attached console.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

getFontStyle

public int getFontStyle()
Returns the font style used to decorate data written to this stream.

Returns:
the font style used to decorate data written to this stream

setFontStyle

public void setFontStyle(int newFontStyle)
Sets the font style to be used to decorate data written to this stream.

Parameters:
newFontStyle - the font style to be used to decorate data written to this stream

isActivateOnWrite

public boolean isActivateOnWrite()
Returns whether the console this stream is writing to will be activated when this stream is written to.

Returns:
whether the console this stream is writing to will be activated when this stream is written to.

setActivateOnWrite

public void setActivateOnWrite(boolean activateOnWrite)
Sets whether to activate the console this stream is writing to when this stream is written to.

Parameters:
activateOnWrite - whether the console this stream is writing to will be activated when this stream is written to.

setColor

public void setColor(Color newColor)
Sets the color of this stream. Use null to indicate the default color.

Parameters:
newColor - color of this stream, or null

getColor

public Color getColor()
Returns the color of this stream, or null if default.

Returns:
the color of this stream, or null

isClosed

public boolean isClosed()
Returns true if the stream has been closed

Returns:
true is the stream has been closed, false otherwise.

close

public void close()
           throws IOException
Throws:
IOException

flush

public void flush()
           throws IOException
Throws:
IOException

write

public void write(byte[] b,
                  int off,
                  int len)
           throws IOException
Throws:
IOException

write

public void write(byte[] b)
           throws IOException
Throws:
IOException

write

public void write(int b)
           throws IOException
Throws:
IOException

write

public void write(String str)
           throws IOException
Writes a string to the attached console.

Parameters:
str - the string to write to the attached console.
Throws:
IOException - if the stream is closed.

setEncoding

public void setEncoding(String encoding)
Sets the character encoding used to interpret characters written to this steam.

Parameters:
encoding - endcoding identifier

Eclipse Platform
Release 3.1

Guidelines for using Eclipse APIs.

Copyright (c) IBM Corp. and others 2000, 2005. All rights reserved.