read

Reads a chunk of data from the stream.

Reads and returns the specified number of characters, or fewer if the end of stream is reached. Throws a StreamNotOpenException if the stream is not open for reading.

Syntax

public byte[] read(long length)

Parameters

length – The maximum number of characters to be read into the chunk.

Returns

read returns a chunk of string data read from the stream, or a null value if the end of the stream has been reached.

Examples

Read – Reads in the biography file.

Author author = Author.findByPrimaryKey(authorID);
BigString text = author.getBiography();
text.openForRead();
int bufferLength = 1024;

string something = text.read(bufferLength); //null if EOF
while (something != null)
{
    something = text.read(bufferLength);
}
text.close();