com.plumtree.openfoundation.io
Class XPOutputStreamWriter

java.lang.Object
  com.plumtree.openfoundation.io.XPWriter
      com.plumtree.openfoundation.io.XPOutputStreamWriter

Direct Known Subclasses:

XPFileWriter

public class XPOutputStreamWriter

extends XPWriter

XPOutputStreamWriter is a wrapper over java.io.OutputStreamWriter or System.IO.StreamWriter.

Field Summary

Fields inherited from class com.plumtree.openfoundation.io.XPWriter

writer

Constructor Summary

XPOutputStreamWriter(java.io.OutputStream outputStream)
Creates a new XPOutputStreamWriter object that wraps the OutputStream.

XPOutputStreamWriter(java.io.OutputStream outputStream, java.lang.String encoding)
Creates a new XPOutputStreamWriter object that wraps the OutputStream.

XPOutputStreamWriter(java.io.OutputStreamWriter outputStreamWriter)
Creates a new XPOutputStreamWriter object that wraps the OutputStreamWriter.

XPOutputStreamWriter(XPOutputStream xpOutputStream)
Creates a new XPOutputStreamWriter object that wraps the OutputStream.

Method Summary

void	Close() Close the stream.
void	Flush() Flush the stream.
java.io.OutputStreamWriter	GetUnderlyingObject() Returns the platform specific object that this class wraps.
void	Write(char[] buffer) Write an array of characters.
void	Write(int b) Write a single character.
void	Write(java.lang.String buffer) Write a string.
void	Write(java.lang.String buffer, int offset, int count) Write a portion of a string.

Methods inherited from class com.plumtree.openfoundation.io.XPWriter

NullWriter, WriteLine, WriteLine, WriteLine, WriteLine, WriteLine

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

XPOutputStreamWriter

public XPOutputStreamWriter(java.io.OutputStreamWriter outputStreamWriter)

Creates a new XPOutputStreamWriter object that wraps the OutputStreamWriter.

Parameters:

outputStreamWriter - An instance of OutputStreamWriter

XPOutputStreamWriter

public XPOutputStreamWriter(java.io.OutputStream outputStream)

Creates a new XPOutputStreamWriter object that wraps the OutputStream.

Parameters:

outputStream - An instance of OutputStreamWriter

XPOutputStreamWriter

public XPOutputStreamWriter(XPOutputStream xpOutputStream)

Creates a new XPOutputStreamWriter object that wraps the OutputStream.

Parameters:

xpOutputStream - An instance of XPOutputStreamWriter

XPOutputStreamWriter

public XPOutputStreamWriter(java.io.OutputStream outputStream,
                            java.lang.String encoding)

Creates a new XPOutputStreamWriter object that wraps the OutputStream.

Parameters:

outputStream - an instance of OutputStreamWriter

encoding - the name of a supported charset

Method Detail

Close

public void Close()

Close the stream.

Overrides:

Close in class XPWriter

Throws:

XPIOException - An instance of XPIOException

Flush

public void Flush()

Flush the stream.

Overrides:

Flush in class XPWriter

Throws:

XPIOException - An instance of XPIOException

Write

public void Write(int b)

Write a single character.

Overrides:

Write in class XPWriter

Parameters:

b - int representing character to write.

Throws:

XPIOException - An instance of XPIOException

Write

public void Write(char[] buffer)

Write an array of characters.

Overrides:

Write in class XPWriter

Parameters:

buffer - Buffer of characters

Throws:

XPIOException - An instance of XPIOException

Write

public void Write(java.lang.String buffer)

Write a string.

Overrides:

Write in class XPWriter

Parameters:

buffer - A string

Throws:

XPIOException - An instance of XPIOException

Write

public void Write(java.lang.String buffer,
                  int offset,
                  int count)

Write a portion of a string.

Overrides:

Write in class XPWriter

Parameters:

buffer - A String

offset - Offset from which to start writing characters

count - Number of characters to write

Throws:

XPIOException - An instance of XPIOException

GetUnderlyingObject

public java.io.OutputStreamWriter GetUnderlyingObject()

Returns the platform specific object that this class wraps.

Returns:

An instance of OutputStreamWriter class