Top Description Fields Constructors Methods
org.apache.pdfbox.io

public Class RandomAccessReadMemoryMappedFile

extends Object
implements RandomAccessRead
Class Inheritance
All Implemented Interfaces
org.apache.pdfbox.io.RandomAccessRead, java.io.Closeable, java.lang.AutoCloseable
Imports
java.io.File, .IOException, java.nio.ByteBuffer, java.nio.channels.FileChannel, java.nio.file.Path, .StandardOpenOption, java.util.EnumSet, .Optional, java.util.function.Consumer
An implementation of the RandomAccess interface backed by a memory mapped file channel. The whole file is mapped to memory and the max size is limited to Integer.MAX_VALUE.

Field Summary

Modifier and TypeField and Description
private final FileChannel
fileChannel

private ByteBuffer
mappedByteBuffer

private final long
size

private final Consumer<? super ByteBuffer>
unmapper

Constructor Summary

AccessConstructor and Description
public
RandomAccessReadMemoryMappedFile(String
the filename of the file to be read
filename)

Create a random access memory mapped file instance for the file with the given name.

public
RandomAccessReadMemoryMappedFile(File
the file to be read
file)

Create a random access memory mapped file instance for the given file.

public
RandomAccessReadMemoryMappedFile(Path
path of the file to be read.
path)

Create a random access memory mapped file instance using the given path.

private
RandomAccessReadMemoryMappedFile(RandomAccessReadMemoryMappedFile parent)

Method Summary

Modifier and TypeMethod and Description
private void
checkClosed()

Ensure that the RandomAccessReadMemoryMappedFile is not 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.
offset, int
The amount of data to attempt to read.
length)

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

Read a buffer of data.

public void
seek(long
The position to seek to.
position)

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

Seek to a position in the data.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

fileChannelback to summary
private final FileChannel fileChannel
mappedByteBufferback to summary
private ByteBuffer mappedByteBuffer
sizeback to summary
private final long size
unmapperback to summary
private final Consumer<? super ByteBuffer> unmapper

Constructor Detail

RandomAccessReadMemoryMappedFileback to summary
public RandomAccessReadMemoryMappedFile(String filename) throws IOException

Create a random access memory mapped file instance for the file with the given name.

Parameters
filename:String

the filename of the file to be read

Exceptions
IOException:
If there is an IO error opening the file.
RandomAccessReadMemoryMappedFileback to summary
public RandomAccessReadMemoryMappedFile(File file) throws IOException

Create a random access memory mapped file instance for the given file.

Parameters
file:File

the file to be read

Exceptions
IOException:
If there is an IO error opening the file.
RandomAccessReadMemoryMappedFileback to summary
public RandomAccessReadMemoryMappedFile(Path path) throws IOException

Create a random access memory mapped file instance using the given path.

Parameters
path:Path

path of the file to be read.

Exceptions
IOException:
If there is an IO error opening the file.
RandomAccessReadMemoryMappedFileback to summary
private RandomAccessReadMemoryMappedFile(RandomAccessReadMemoryMappedFile parent)

Method Detail

checkClosedback to summary
private void checkClosed() throws IOException

Ensure that the RandomAccessReadMemoryMappedFile is not closed

Exceptions
IOException:
If RandomAccessBuffer already closed
closeback 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
createViewback to summary
public RandomAccessReadView createView(long startPosition, long streamLength)

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
getPositionback 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
isClosedback 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
isEOFback 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.
lengthback 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.
readback 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.
readback to summary
public int read(byte[] b, int offset, int length) 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.

offset:int

Offset into the buffer to start writing.

length: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.
seekback to summary
public void seek(long position) 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
position:long

The position to seek to.

Annotations
@Override
Exceptions
IOException:
If there is an error while seeking.