com.itextpdf.io.source

Interface IRandomAccessSource

All Known Implementing Classes:

FileChannelRandomAccessSource, GetBufferedRandomAccessSource, IndependentRandomAccessSource, PdfTokenizer.ReusableRandomAccessSource, ThreadSafeRandomAccessSource, WindowRandomAccessSource

public interface IRandomAccessSource

Represents an abstract source that bytes can be read from. This class forms the foundation for all byte input in iText. Implementations do not keep track of a current 'position', but rather provide absolute get methods. Tracking position should be handled in classes that use RandomAccessSource internally (via composition).

Method Summary

Modifier and Type	Method and Description
void	close() Closes this source.
int	get(long position) Gets a byte at the specified position
int	get(long position, byte[] bytes, int off, int len) Read an array of bytes of specified length from the specified position of source to the buffer applying the offset.
long	length() Gets the length of the source

Method Detail

get

int get(long position)
 throws IOException

Gets a byte at the specified position

Parameters:

position - byte position

Returns:

the byte, or -1 if EOF is reached

Throws:

IOException - in case of any reading error.

get

int get(long position,
        byte[] bytes,
        int off,
        int len)
 throws IOException

Read an array of bytes of specified length from the specified position of source to the buffer applying the offset. If the number of bytes requested cannot be read, all the possible bytes will be read to the buffer, and the number of actually read bytes will be returned.

Parameters:

position - the position in the RandomAccessSource to read from

bytes - output buffer

off - offset into the output buffer where results will be placed

len - the number of bytes to read

Returns:

the number of bytes actually read, or -1 if the file is at EOF

Throws:

IOException - in case of any I/O error.

length

long length()

Gets the length of the source

Returns:

the length of this source

close

void close()
    throws IOException

Closes this source. The underlying data structure or source (if any) will also be closed

Throws:

IOException - in case of any reading error.