com.itextpdf.text.io

Class FileChannelRandomAccessSource

java.lang.Object

com.itextpdf.text.io.FileChannelRandomAccessSource

All Implemented Interfaces:

RandomAccessSource

public class FileChannelRandomAccessSource
extends Object
implements RandomAccessSource

A RandomAccessSource that is based on an underlying FileChannel. The entire channel will be mapped into memory for efficient reads.

Since:

5.3.5

Constructor Summary

Constructors

Constructor and Description
FileChannelRandomAccessSource(FileChannel channel) Constructs a new FileChannelRandomAccessSource based on the specified FileChannel.

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) Gets an array at the specified position.
long	length()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FileChannelRandomAccessSource

public FileChannelRandomAccessSource(FileChannel channel)
                              throws IOException

Constructs a new FileChannelRandomAccessSource based on the specified FileChannel. The entire source channel will be mapped into memory.

Parameters:

channel - the channel to use as the backing store

Throws:

IOException - if the channel cannot be opened or mapped

Method Detail

close

public void close()
           throws IOException

Closes this source. The underlying data structure or source (if any) will also be closed Cleans the mapped bytebuffers and closes the channel

Specified by:

close in interface RandomAccessSource

Throws:

IOException

get

public int get(long position)
        throws IOException

Gets a byte at the specified position

Specified by:

get in interface RandomAccessSource

Returns:

the byte, or -1 if EOF is reached

Throws:

IOException

get

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

Gets an array at the specified position. If the number of bytes requested cannot be read, the bytes that can be read will be placed in bytes and the number actually read will be returned.

Specified by:

get in interface RandomAccessSource

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

length

public long length()

Specified by:

length in interface RandomAccessSource

Returns:

the length of this source