Apache PDFBox 3.0.4 · org.apache.pdfbox.io.RandomAccessReadView

Modifier and Type	Field and Description
private final boolean	closeInput
private long	currentPosition
private RandomAccessRead	randomAccessRead
private final long	startPosition
private final long	streamLength

Access	Constructor and Description
public	RandomAccessReadView(RandomAccessRead the underlying random access read randomAccessRead, long start position within the underlying random access read startPosition, long stream length streamLength) Constructor.
public	RandomAccessReadView(RandomAccessRead the underlying random access read randomAccessRead, long start position within the underlying random access read startPosition, long stream length streamLength, boolean close the underlying random access read when closing the view if set to true closeInput) Constructor.

Method Summary

Modifier and Type	Method and Description
private void	checkClosed() Ensure that that the view isn't closed.
public void	close() Implements java.io.Closeable.close. Closes this stream and releases any system resources associated with it.
public RandomAccessReadView	createView(long start position within the underlying random access read startPosition, long stream length streamLength) Implements org.apache.pdfbox.io.RandomAccessRead.createView. Creates a random access read view starting at the given position with the given length.
public long	getPosition() Implements org.apache.pdfbox.io.RandomAccessRead.getPosition. Returns offset of next byte to be returned by a read method.
public boolean	isClosed() Implements org.apache.pdfbox.io.RandomAccessRead.isClosed. Returns true if this source has been closed.
public boolean	isEOF() Implements org.apache.pdfbox.io.RandomAccessRead.isEOF. A simple test to see if we are at the end of the data.
public long	length() Implements org.apache.pdfbox.io.RandomAccessRead.length. The total number of bytes that are available.
public int	read() Implements org.apache.pdfbox.io.RandomAccessRead.read. Read a single byte of data.
public int	read(byte[] The buffer to write the data to. b, int Offset into the buffer to start writing. off, int The amount of data to attempt to read. len) Implements org.apache.pdfbox.io.RandomAccessRead.read. Read a buffer of data.
private void	restorePosition() Restore the current position within the underlying random access read.
public void	rewind(int the number of bytes to be seeked backwards bytes) Overrides default org.apache.pdfbox.io.RandomAccessRead.rewind. Seek backwards the given number of bytes.
public void	seek(final long The position to seek to. newOffset) Implements org.apache.pdfbox.io.RandomAccessRead.seek. Seek to a position in the data.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

closeInput	back to summary
private final boolean closeInput

currentPosition	back to summary
private long currentPosition

randomAccessRead	back to summary
private RandomAccessRead randomAccessRead

startPosition	back to summary
private final long startPosition

streamLength	back to summary
private final long streamLength

RandomAccessReadView	back to summary
public RandomAccessReadView(RandomAccessRead randomAccessRead, long startPosition, long streamLength) Constructor. Parameters randomAccessRead:RandomAccessRead the underlying random access read startPosition:long start position within the underlying random access read streamLength:long stream length

RandomAccessReadView	back to summary
public RandomAccessReadView(RandomAccessRead randomAccessRead, long startPosition, long streamLength, boolean closeInput) Constructor. Parameters randomAccessRead:RandomAccessRead the underlying random access read startPosition:long start position within the underlying random access read streamLength:long stream length closeInput:boolean close the underlying random access read when closing the view if set to true

Method Detail

checkClosed	back to summary
private void checkClosed() throws IOException Ensure that that the view isn't closed. Exceptions IOException: If RandomAccessReadView already closed

checkClosed

back to summary

private void checkClosed() throws IOException

Ensure that that the view isn't closed.

Exceptions

IOException:: If RandomAccessReadView already closed

close back to summary

close	back to summary
public void close() throws IOException Implements java.io.Closeable.close. Doc from java.io.Closeable.close. Closes this stream and releases any system resources associated with it. If the stream is already closed then invoking this method has no effect. As noted in `AutoCloseable#close()`, cases where the close may fail require careful attention. It is strongly advised to relinquish the underlying resources and to internally mark the `Closeable` as closed, prior to throwing the `IOException`. Annotations @Override Exceptions IOException: if an I/O error occurs

public void close() throws IOException

Implements java.io.Closeable.close.

Doc from java.io.Closeable.close.

Closes this stream and releases any system resources associated with it. If the stream is already closed then invoking this method has no effect.

As noted in AutoCloseable#close(), cases where the close may fail require careful attention. It is strongly advised to relinquish the underlying resources and to internally mark the Closeable as closed, prior to throwing the IOException.

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs

createView	back to summary
public RandomAccessReadView createView(long startPosition, long streamLength) throws IOException Implements org.apache.pdfbox.io.RandomAccessRead.createView. Doc from org.apache.pdfbox.io.RandomAccessRead.createView. Creates a random access read view starting at the given position with the given length. Parameters startPosition:long start position within the underlying random access read streamLength:long stream length Returns:RandomAccessReadView the random access read view Annotations @Override Exceptions IOException: if something went wrong when creating the view for the RandomAccessRead

createView

back to summary

public RandomAccessReadView createView(long startPosition, long streamLength) throws IOException

Implements org.apache.pdfbox.io.RandomAccessRead.createView.

Doc from org.apache.pdfbox.io.RandomAccessRead.createView.

Creates a random access read view starting at the given position with the given length.

Parameters

startPosition:long: start position within the underlying random access read
streamLength:long: stream length

Returns:RandomAccessReadView

the random access read view

Annotations

@Override

Exceptions

IOException:: if something went wrong when creating the view for the RandomAccessRead

getPosition back to summary

getPosition	back to summary
public long getPosition() throws IOException Implements org.apache.pdfbox.io.RandomAccessRead.getPosition. Doc from org.apache.pdfbox.io.RandomAccessRead.getPosition. Returns offset of next byte to be returned by a read method. Returns:long offset of next byte which will be returned with next `read()` (if no more bytes are left it returns a value >= length of source) Annotations @Override Exceptions IOException: If there was an error while getting the current position

public long getPosition() throws IOException

Implements org.apache.pdfbox.io.RandomAccessRead.getPosition.

Doc from org.apache.pdfbox.io.RandomAccessRead.getPosition.

Returns offset of next byte to be returned by a read method.

Returns:long

offset of next byte which will be returned with next read() (if no more bytes are left it returns a value >= length of source)

Annotations

@Override

Exceptions

IOException:: If there was an error while getting the current position

isClosed	back to summary
public boolean isClosed() Implements org.apache.pdfbox.io.RandomAccessRead.isClosed. Doc from org.apache.pdfbox.io.RandomAccessRead.isClosed. Returns true if this source has been closed. Returns:boolean true if the source has been closed Annotations @Override

isClosed

back to summary

public boolean isClosed()

Implements org.apache.pdfbox.io.RandomAccessRead.isClosed.

Doc from org.apache.pdfbox.io.RandomAccessRead.isClosed.

Returns true if this source has been closed.

Returns:boolean

true if the source has been closed

Annotations

@Override

isEOF	back to summary
public boolean isEOF() throws IOException Implements org.apache.pdfbox.io.RandomAccessRead.isEOF. Doc from org.apache.pdfbox.io.RandomAccessRead.isEOF. A simple test to see if we are at the end of the data. Returns:boolean true if we are at the end of the data. Annotations @Override Exceptions IOException: If there is an error reading the next byte.

isEOF

back to summary

public boolean isEOF() throws IOException

Implements org.apache.pdfbox.io.RandomAccessRead.isEOF.

Doc from org.apache.pdfbox.io.RandomAccessRead.isEOF.

A simple test to see if we are at the end of the data.

Returns:boolean

true if we are at the end of the data.

Annotations

@Override

Exceptions

IOException:: If there is an error reading the next byte.

length	back to summary
public long length() throws IOException Implements org.apache.pdfbox.io.RandomAccessRead.length. Doc from org.apache.pdfbox.io.RandomAccessRead.length. The total number of bytes that are available. Returns:long The number of bytes available. Annotations @Override Exceptions IOException: If there is an IO error while determining the length of the data stream.

length

back to summary

public long length() throws IOException

Implements org.apache.pdfbox.io.RandomAccessRead.length.

Doc from org.apache.pdfbox.io.RandomAccessRead.length.

The total number of bytes that are available.

Returns:long

The number of bytes available.

Annotations

@Override

Exceptions

IOException:: If there is an IO error while determining the length of the data stream.

read	back to summary
public int read() throws IOException Implements org.apache.pdfbox.io.RandomAccessRead.read. Doc from org.apache.pdfbox.io.RandomAccessRead.read. Read a single byte of data. Returns:int The byte of data that is being read. Annotations @Override Exceptions IOException: If there is an error while reading the data.

read

back to summary

public int read() throws IOException

Implements org.apache.pdfbox.io.RandomAccessRead.read.

Doc from org.apache.pdfbox.io.RandomAccessRead.read.

Read a single byte of data.

Returns:int

The byte of data that is being read.

Annotations

@Override

Exceptions

IOException:: If there is an error while reading the data.

read	back to summary
public int read(byte[] b, int off, int len) throws IOException Implements org.apache.pdfbox.io.RandomAccessRead.read. Doc from org.apache.pdfbox.io.RandomAccessRead.read. Read a buffer of data. Parameters b:byte[] The buffer to write the data to. off:int Offset into the buffer to start writing. len:int The amount of data to attempt to read. Returns:int The number of bytes that were actually read. Annotations @Override Exceptions IOException: If there was an error while reading the data.

read

back to summary

public int read(byte[] b, int off, int len) throws IOException

Implements org.apache.pdfbox.io.RandomAccessRead.read.

Doc from org.apache.pdfbox.io.RandomAccessRead.read.

Read a buffer of data.

Parameters

b:byte[]: The buffer to write the data to.
off:int: Offset into the buffer to start writing.
len:int: The amount of data to attempt to read.

Returns:int

The number of bytes that were actually read.

Annotations

@Override

Exceptions

IOException:: If there was an error while reading the data.

restorePosition	back to summary
private void restorePosition() throws IOException Restore the current position within the underlying random access read.

rewind	back to summary
public void rewind(int bytes) throws IOException Overrides default org.apache.pdfbox.io.RandomAccessRead.rewind. Doc from org.apache.pdfbox.io.RandomAccessRead.rewind. Seek backwards the given number of bytes. Parameters bytes:int the number of bytes to be seeked backwards Annotations @Override Exceptions IOException: If there is an error while seeking

rewind

back to summary

public void rewind(int bytes) throws IOException

Overrides default org.apache.pdfbox.io.RandomAccessRead.rewind.

Doc from org.apache.pdfbox.io.RandomAccessRead.rewind.

Seek backwards the given number of bytes.

Parameters

bytes:int: the number of bytes to be seeked backwards

Annotations

@Override

Exceptions

IOException:: If there is an error while seeking

seek	back to summary
public void seek(final long newOffset) throws IOException Implements org.apache.pdfbox.io.RandomAccessRead.seek. Doc from org.apache.pdfbox.io.RandomAccessRead.seek. Seek to a position in the data. Parameters newOffset:long The position to seek to. Annotations @Override Exceptions IOException: If there is an error while seeking.

seek

back to summary

public void seek(final long newOffset) throws IOException

Implements org.apache.pdfbox.io.RandomAccessRead.seek.

Doc from org.apache.pdfbox.io.RandomAccessRead.seek.

Seek to a position in the data.

Parameters