Package com.itextpdf.io.source
Class MappedChannelRandomAccessSource
java.lang.Object
com.itextpdf.io.source.MappedChannelRandomAccessSource
- All Implemented Interfaces:
IRandomAccessSource
A RandomAccessSource that represents a memory mapped section of an underlying FileChannel.
This source can be closed and will automatically re-open as needed.
This class is an internal implementation detail of the
FileChannelRandomAccessSource
class and
shouldn't be used by general iText users.-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate final FileChannel
The underlying channelprivate final long
The number of bytes this source maps toprivate final long
The offset into the channel that this source maps toprivate ByteBufferRandomAccessSource
If the map is active, the actual map. -
Constructor Summary
ConstructorsConstructorDescriptionMappedChannelRandomAccessSource
(FileChannel channel, long offset, long length) Create a new source based on the channel. -
Method Summary
Modifier and TypeMethodDescriptionvoid
close()
Closes this source.int
get
(long position) Gets a byte at the specified positionint
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(package private) void
open()
Map the region of the channeltoString()
-
Field Details
-
channel
The underlying channel -
offset
private final long offsetThe offset into the channel that this source maps to -
length
private final long lengthThe number of bytes this source maps to -
source
If the map is active, the actual map. null other wise.
-
-
Constructor Details
-
MappedChannelRandomAccessSource
Create a new source based on the channel. Mapping will not occur until data is actually read.- Parameters:
channel
- the underlying channeloffset
- the offset of the maplength
- the length of the map
-
-
Method Details
-
open
Map the region of the channel- Throws:
IOException
- if there is a problem with creating the map
-
get
Gets a byte at the specified position- Specified by:
get
in interfaceIRandomAccessSource
- Parameters:
position
- byte position- Returns:
- the byte, or -1 if EOF is reached
- Throws:
IOException
- in case of any reading error.
-
get
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.- Specified by:
get
in interfaceIRandomAccessSource
- 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:
IOException
- in case of any I/O error.
-
length
public long length()Gets the length of the source- Specified by:
length
in interfaceIRandomAccessSource
- Returns:
- the length of this source
-
close
Closes this source. The underlying data structure or source (if any) will also be closed- Specified by:
close
in interfaceIRandomAccessSource
- Throws:
IOException
- in case of any reading error.
-
toString
-