Package com.itextpdf.io.source

Class RAFRandomAccessSource

  • All Implemented Interfaces:
    IRandomAccessSource
    class RAFRandomAccessSource
extends java.lang.Object
implements IRandomAccessSource
    A RandomAccessSource that uses a RandomAccessFile as it's source Note: Unlike most of the RandomAccessSource implementations, this class is not thread safe

    • Field Summary

      Fields 
      Modifier and Type Field Description
      private long length
      The length of the underling RAF.
      private java.io.RandomAccessFile raf
      The source

    • Constructor Summary

      Constructors 
      Constructor Description
      RAFRandomAccessSource​(java.io.RandomAccessFile raf)
      Creates this object

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void close()
      Closes the underlying RandomAccessFile
      int get​(long position)
      Gets a byte at the specified position
      int 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

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • raf

        private final java.io.RandomAccessFile raf
        The source

      • length

        private final long length
        The length of the underling RAF. Note that the length is cached at construction time to avoid the possibility of IOExceptions when reading the length.

    • Constructor Detail

      • RAFRandomAccessSource

        public RAFRandomAccessSource​(java.io.RandomAccessFile raf)
                      throws java.io.IOException
        Creates this object
        Parameters:
        raf - the source for this RandomAccessSource
        Throws:
        java.io.IOException - if the RAF can't be read

    • Method Detail

      • get

        public int get​(long position)
        throws java.io.IOException
        Gets a byte at the specified position
        Specified by:
        get in interface IRandomAccessSource
        Parameters:
        position - byte position
        Returns:
        the byte, or -1 if EOF is reached
        Throws:
        java.io.IOException - in case of any reading error.

      • get

        public int get​(long position,
               byte[] bytes,
               int off,
               int len)
        throws java.io.IOException
        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 interface IRandomAccessSource
        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:
        java.io.IOException - in case of any I/O error.

      • length

        public long length()
        Gets the length of the source Note: the length is determined when the RAFRandomAccessSource is constructed. If the file length changes after construction, that change will not be reflected in this call.
        Specified by:
        length in interface IRandomAccessSource
        Returns:
        the length of this source

      • close

        public void close()
           throws java.io.IOException
        Closes the underlying RandomAccessFile
        Specified by:
        close in interface IRandomAccessSource
        Throws:
        java.io.IOException - in case of any reading error.