Overview | Module | Use | Devguide | Index

Methods' Summary | Methods' Details | Attributes' Summary | Attributes' Details

:: com :: sun :: star :: io ::
interface XTextInputStream
  Base Hierarchy
      ::com::sun::star::uno::XInterface
       |
       +-XInputStream
          |
          +-XTextInputStream
Description Interface to read strings from a stream. This interfaces allows to read strings seperated by delimiters and to read lines. The character encoding to be used can be set by setEncoding() . Default encoding is "utf8".

Methods' Summary
readLine | reads text until a line break (CR, LF, or CR/LF) or EOF is found and returns it as string (without CR, LF).
readString | reads text until one of the given delimiter characters or EOF is found and returns it as string (without delimiter).
isEOF | Returns the EOF status.
setEncoding | sets character encoding.

Methods' Details
readLine
string readLine() | raises( | IOException );
Description reads text until a line break (CR, LF, or CR/LF) or EOF is found and returns it as string (without CR, LF). The read characters are converted according to the encoding defined by setEncoding . If EOF is already reached before calling this method an empty string is returned. See also setEncoding See also isEOF
readString
string readString( | [in] sequence< char > [in] boolean raises( | Delimiters, bRemoveDelimiter ) IOException );
Description reads text until one of the given delimiter characters or EOF is found and returns it as string (without delimiter). Important: CR/LF is not used as default delimiter! So if no delimiter is defined or none of the delimiters is found, the stream will be read to EOF. The read characters are converted according to the encoding defined by setEncoding . If EOF is already reached before calling this method an empty string is returned. See also setEncoding See also isEOF
isEOF
boolean isEOF() | raises( | IOException );
Description Returns the EOF status. This method has to be used to detect if the end of the stream is reached. Important: This cannot be detected by asking for an empty string because that can be a valid return value of readLine() (if the line is empty) and readString() (if a delimiter is directly followed by the next one). Returns true , if the end of file is reached, so that no next string can be read. false otherwise
setEncoding
void setEncoding( | [in] string | Encoding );
Description sets character encoding. Parameter Encoding sets the character encoding that should be used. The character encoding names refer to the document http://www.iana.org/assignments/character-sets. Which character sets are supported depends on the implementation.

Top of Page

Copyright © 2003 Sun Microsystems, Inc.