PDF4Java Reference Documentation
com.o2sol.pdf4java.core.io Package / MemoryStream Class / read Method
An array of bytes. When this method returns, the buffer contains the specified byte array with the values between offset and (offset + count - 1) replaced by the bytes read from the current source.
The zero-based byte offset in buffer at which to begin storing the data read from the current stream.
The maximum number of bytes to be read from the current stream.
Collapse All Expand All
In This Topic

read Method
In This Topic
Reads a sequence of bytes from the current stream and advances the position within the stream by the number of bytes read.
Syntax

    public int read(
       byte[] buffer,
       int offset,
       int count
    )

#### Parameters

buffer
  An array of bytes. When this method returns, the buffer contains the specified byte array with the values between offset and (offset + count - 1) replaced by the bytes read from the current source.
offset
  The zero-based byte offset in buffer at which to begin storing the data read from the current stream.
count
  The maximum number of bytes to be read from the current stream.

#### Return Value

The total number of bytes read into the buffer. This can be less than the number of bytes requested if that many bytes are not currently available, or zero (0) if the end of the stream has been reached.
Exceptions

Exception | Description
--- | ---
com.o2sol.pdf4java.core.exceptions.PDFIOException | When the stream is closed.
java.lang.IllegalArgumentException | When buffer is null or count is negative.
java.lang.IndexOutOfBoundsException | When offset is negative.

See Also

#### Reference

MemoryStream Class
MemoryStream Members

© 2025 O2 Solutions All Rights Reserved.

Send comments on this topic.