Docs For Class Swift_CharacterStream

Class: Swift_CharacterStream

Class Details

[line 24]
An abstract means of reading and writing data in terms of characters as opposed to bytes.

Classes implementing this interface may use a subsystem which requires less memory than working with large strings of data.

Tags:

author:

Chris Corbyn

Class Methods

method flushContents [line 84]

void flushContents(
)

Empty the stream and reset the internal pointer.

Tags:

access:

public

[ Top ]

method importByteStream [line 44]

void importByteStream(
Swift_OutputByteStream
$os)

Overwrite this character stream using the byte sequence in the byte stream.

Tags:

access:

public

Parameters:

Swift_OutputByteStream

$os

output stream to read from

[ Top ]

method importString [line 51]

void importString(
string
$string)

Import a string a bytes into this CharacterStream, overwriting any existing data in the stream.

Tags:

access:

public

Parameters:

string

$string

[ Top ]

method read [line 59]

string read(
int
$length)

Read $length characters from the stream and move the internal pointer $length further into the stream.

Tags:

access:

public

Parameters:

int

$length

[ Top ]

method readBytes [line 67]

int[] readBytes(
int
$length)

Read $length characters from the stream and return a 1-dimensional array containing there octet values.

Tags:

access:

public

Parameters:

int

$length

[ Top ]

method setCharacterReaderFactory [line 37]

void setCharacterReaderFactory(
Swift_CharacterReaderFactory
$factory)

Set the CharacterReaderFactory for multi charset support.

Tags:

access:

public

Parameters:

Swift_CharacterReaderFactory

$factory

[ Top ]

method setCharacterSet [line 31]

void setCharacterSet(
string
$charset)

Set the character set used in this CharacterStream.

Tags:

access:

public

Parameters:

string

$charset

[ Top ]

method setPointer [line 79]

void setPointer(
int
$charOffset)

Move the internal pointer to $charOffset in the stream.

Tags:

access:

public

Parameters:

int

$charOffset

[ Top ]

method write [line 73]

void write(
string
$chars)

Write $chars to the end of the stream.

Tags:

access:

public

Parameters:

string

$chars

[ Top ]

Documentation generated on Mon, 05 Sep 2011 20:32:11 -0500 by phpDocumentor 1.4.3

Class: Swift_CharacterStream

Interface Overview

Author(s):

Methods

Class Details

Tags:

Class Methods

method flushContents [line 84]

Tags:

method importByteStream [line 44]

Tags:

Parameters:

method importString [line 51]

Tags:

Parameters:

method read [line 59]

Tags:

Parameters:

method readBytes [line 67]

Tags:

Parameters:

method setCharacterReaderFactory [line 37]

Tags:

Parameters:

method setCharacterSet [line 31]

Tags:

Parameters:

method setPointer [line 79]

Tags:

Parameters:

method write [line 73]

Tags:

Parameters: