Package com.itextpdf.text.io
Class FileChannelRandomAccessSource
- java.lang.Object
-
- com.itextpdf.text.io.FileChannelRandomAccessSource
-
- All Implemented Interfaces:
RandomAccessSource
public class FileChannelRandomAccessSource extends java.lang.Object implements RandomAccessSource
A RandomAccessSource that is based on an underlyingFileChannel
. The entire channel will be mapped into memory for efficient reads.- Since:
- 5.3.5
-
-
Field Summary
Fields Modifier and Type Field Description private java.nio.channels.FileChannel
channel
The channel this source is based onprivate MappedChannelRandomAccessSource
source
Tracks the actual mapping
-
Constructor Summary
Constructors Constructor Description FileChannelRandomAccessSource(java.nio.channels.FileChannel channel)
Constructs a newFileChannelRandomAccessSource
based on the specified FileChannel.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
close()
Closes this source.int
get(long position)
Gets a byte at the specified positionint
get(long position, byte[] bytes, int off, int len)
Gets an array at the specified position.long
length()
-
-
-
Field Detail
-
channel
private final java.nio.channels.FileChannel channel
The channel this source is based on
-
source
private final MappedChannelRandomAccessSource source
Tracks the actual mapping
-
-
Constructor Detail
-
FileChannelRandomAccessSource
public FileChannelRandomAccessSource(java.nio.channels.FileChannel channel) throws java.io.IOException
Constructs a newFileChannelRandomAccessSource
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:
java.io.IOException
- if the channel cannot be opened or mapped
-
-
Method Detail
-
close
public void close() throws java.io.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 interfaceRandomAccessSource
- Throws:
java.io.IOException
-
get
public int get(long position) throws java.io.IOException
Gets a byte at the specified position- Specified by:
get
in interfaceRandomAccessSource
- Returns:
- the byte, or -1 if EOF is reached
- Throws:
java.io.IOException
-
get
public int get(long position, byte[] bytes, int off, int len) throws java.io.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 interfaceRandomAccessSource
- Parameters:
position
- the position in the RandomAccessSource to read frombytes
- output bufferoff
- offset into the output buffer where results will be placedlen
- the number of bytes to read- Returns:
- the number of bytes actually read, or -1 if the file is at EOF
- Throws:
java.io.IOException
-
length
public long length()
- Specified by:
length
in interfaceRandomAccessSource
- Returns:
- the length of this source
-
-