ot::io
class Writer  (abstract)

Depending on the configuration chosen, Unicode characters may be represented internally using 32-bit UCS-4 characters, 16-bit UTF-16 characters or 8-bit UTF-8 characters. See SystemCodeConverter for further information.

The Writer interface mirrors OutputStream, but deals in characters where OutputStream deals in bytes.

Multi-threaded considerations:

As shown on the inheritance graph, Writer derives from SynchronizedObject, which gives it the ability to protect its internal state from concurrent access from multiple threads. All public methods are synchronized for safe concurrent access.

m_rpLock

unit_type

Writer

 Writer()

Default constructor.

Writer

 Writer(SynchronizedObject* pLockObject)

Constructor taking a SynchronizedObject which will be used as the lock for synchronized functions.

Exceptions:

NullPointerException - if pLockObject is null

close

virtual void close()=0

Closes the character stream, flushing it first.

Multi-threaded considerations:

Synchronized for safe access from multiple concurrent threads.

flush

virtual void flush()

Flushes any output buffers before forcing the output to its final destination.

Exceptions:

IOException - if an I/O error occurs.

See also:

flushBuffers()

Multi-threaded considerations:

Synchronized for safe access from multiple concurrent threads.

flushBuffers

virtual void flushBuffers()

If this Writer maintains an output buffer, the buffer is emptied and written to the output destination without requesting the final destination to flush the output. The base class implementation does nothing.

See also:

flush()

Multi-threaded considerations:

Synchronized for safe access from multiple concurrent threads.

getLock

RefPtr< SynchronizedObject > getLock() const

Returns a reference to the SynchronizedObject used for controlling access to synchronized methods.

write

virtual void write(CharType c)

Writes the single CharType character c. Depending on the native OpenTop encoding, a single CharType character may not represent a complete Unicode character. In this case the value may be stored internally until sufficient CharType values have been written to recognize the Unicode character being written.

Parameters:

c - the value to write.

Exceptions:

IOException - if an I/O error occurs.

See also:

write(const Character& ch)

Multi-threaded considerations:

Synchronized for safe access from multiple concurrent threads.

write

virtual void write(const Character& ch)

Writes the Unicode character ch to the output stream. This is functionaly equaivalent to writing

   write(ch.data(), ch.length());

Parameters:

ch - the Unicode character to write.

Exceptions:

IOException - if an I/O error occurs.

See also:

write(CharType c)

Multi-threaded considerations:

Synchronized for safe access from multiple concurrent threads.

write

virtual void write(const String& str)

Writes the sequence of CharType characters contained in the String str.

Parameters:

str - the String to write.

Exceptions:

IOException - if an I/O error occurs.

Multi-threaded considerations:

Synchronized for safe access from multiple concurrent threads.

write

virtual void write(const CharType* pStr,
                   size_t len)=0

Writes an array of CharType characters.

Parameters:

pStr - a pointer to the first CharType character in the array
len - the number of CharType characters to write

Exceptions:

IOException - if an I/O error occurs.

Multi-threaded considerations:

Synchronized for safe access from multiple concurrent threads.