Module org.sejda.io
Package org.sejda.io

Class MemoryMappedSeekableSource

java.lang.Object
org.sejda.io.BaseSeekableSource
org.sejda.io.MemoryMappedSeekableSource
All Implemented Interfaces:
Closeable, AutoCloseable, Channel, ReadableByteChannel, SeekableSource
public class MemoryMappedSeekableSource extends BaseSeekableSource
A SeekableSource implementation based on MappedByteBuffer. To overcome the int limit of the MappedByteBuffer, this source implement a pagination algorithm allowing to open files of any size. The size of the pages can be configured using the SeekableSources.MEMORY_MAPPED_PAGE_SIZE_PROPERTY system property.
Author:
Andrea Vacondio

  • Constructor Details

  • Method Details

    • position

      public long position()
      Returns:
      the current source position as a positive long

    • size

      public long size()
      Returns:
      The source size, measured in bytes

    • position

      public SeekableSource position(long position)
      Description copied from interface: SeekableSource
      Sets the source position. Setting the position to a value that is greater than the source's size is legal but does not change the size of the source. A later attempt to read bytes at such a position will immediately return an end-of-file indication.
      Parameters:
      position - a non-negative long for the new position
      Returns:
      this source

    • read

      public int read(ByteBuffer dst) throws IOException
      Throws:
      IOException

    • read

      public int read() throws IOException
      Description copied from interface: SeekableSource
      Reads a byte of data from this source. The byte is returned as an integer in the range 0 to 255 ( 0x00-0xff ).
      Returns:
      the next byte of data, or -1 if there is no more data.
      Throws:
      IOException

    • close

      public void close() throws IOException
      Specified by:
      close in interface AutoCloseable
      Specified by:
      close in interface Channel
      Specified by:
      close in interface Closeable
      Overrides:
      close in class BaseSeekableSource
      Throws:
      IOException

    • view

      public SeekableSource view(long startingPosition, long length) throws IOException
      Returns:
      a readable view of a portion of this SeekableSource. Reading from the view doesn't affect the SeekableSource position. Closing the SeekableSource makes all the views unreadable but closing the view has no effect on the SeekableSource. A view may or may not work on a thread bound copy of the SeekableSource so as a general rule it should not be created and handed to other threads.
      Throws:
      IOException - if something goes wrong while creating the view