Class WindowRandomAccessSource

java.lang.Object
com.itextpdf.text.io.WindowRandomAccessSource
All Implemented Interfaces:
RandomAccessSource
public class WindowRandomAccessSource extends Object implements RandomAccessSource
A RandomAccessSource that wraps another RandomAccessSouce and provides a window of it at a specific offset and over a specific length. Position 0 becomes the offset position in the underlying source.
Since:
5.3.5

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    private final long
    length
    The length
    private final long
    offset
    The amount to offset the source by
    private final RandomAccessSource
    source
    The source

  • Constructor Summary

    Constructors
    Constructor
    Description
    WindowRandomAccessSource(RandomAccessSource source, long offset)
    Constructs a new OffsetRandomAccessSource that extends to the end of the underlying source
    WindowRandomAccessSource(RandomAccessSource source, long offset, long length)
    Constructs a new OffsetRandomAccessSource with an explicit length

  • Method Summary

    Modifier and Type
    Method
    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()
    Note that the length will be adjusted to read from the corrected location in the underlying source

    Methods inherited from class Object

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

  • Field Details

    • source

      private final RandomAccessSource source
      The source

    • offset

      private final long offset
      The amount to offset the source by

    • length

      private final long length
      The length

  • Constructor Details

    • WindowRandomAccessSource

      public WindowRandomAccessSource(RandomAccessSource source, long offset)
      Constructs a new OffsetRandomAccessSource that extends to the end of the underlying source
      Parameters:
      source - the source
      offset - the amount of the offset to use

    • WindowRandomAccessSource

      public WindowRandomAccessSource(RandomAccessSource source, long offset, long length)
      Constructs a new OffsetRandomAccessSource with an explicit length
      Parameters:
      source - the source
      offset - the amount of the offset to use
      length - the number of bytes to be included in this RAS

  • Method Details

    • get

      public int get(long position) throws IOException
      Gets a byte at the specified position Note that the position will be adjusted to read from the corrected location in the underlying source
      Specified by:
      get in interface RandomAccessSource
      Parameters:
      position -
      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. Note that the position will be adjusted to read from the corrected location in the underlying source
      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()
      Note that the length will be adjusted to read from the corrected location in the underlying source
      Specified by:
      length in interface RandomAccessSource
      Returns:
      the length of this source

    • close

      public void close() throws IOException
      Closes this source. The underlying data structure or source (if any) will also be closed
      Specified by:
      close in interface RandomAccessSource
      Throws:
      IOException