Package com.drew.lang

Class ByteArrayReader

java.lang.Object
com.drew.lang.RandomAccessReader
com.drew.lang.ByteArrayReader
public class ByteArrayReader extends RandomAccessReader
Provides methods to read specific values from a byte array, with a consistent, checked exception structure for issues.

By default, the reader operates with Motorola byte order (big endianness). This can be changed by calling setMotorolaByteOrder(boolean).

Author:
Drew Noakes https://drewnoakes.com

  • Constructor Details

    • ByteArrayReader

      public ByteArrayReader(byte[] buffer)

    • ByteArrayReader

      public ByteArrayReader(byte[] buffer, int baseOffset)

  • Method Details

    • toUnshiftedOffset

      public int toUnshiftedOffset(int localOffset)
      Specified by:
      toUnshiftedOffset in class RandomAccessReader

    • getLength

      public long getLength()
      Description copied from class: RandomAccessReader
      Returns the length of the data source in bytes.

      This is a simple operation for implementations (such as RandomAccessFileReader and ByteArrayReader) that have the entire data source available.

      Users of this method must be aware that sequentially accessed implementations such as RandomAccessStreamReader will have to read and buffer the entire data source in order to determine the length.

      Specified by:
      getLength in class RandomAccessReader
      Returns:
      the length of the data source, in bytes.

    • getByte

      public byte getByte(int index) throws IOException
      Description copied from class: RandomAccessReader
      Gets the byte value at the specified byte index.

      Implementations should not perform any bounds checking in this method. That should be performed in validateIndex and isValidIndex.

      Specified by:
      getByte in class RandomAccessReader
      Parameters:
      index - The index from which to read the byte
      Returns:
      The read byte value
      Throws:
      BufferBoundsException - if the requested byte is beyond the end of the underlying data source
      IOException - if the byte is unable to be read

    • getBytes

      public byte[] getBytes(int index, int count) throws IOException
      Description copied from class: RandomAccessReader
      Returns the required number of bytes from the specified index from the underlying source.
      Specified by:
      getBytes in class RandomAccessReader
      Parameters:
      index - The index from which the bytes begins in the underlying source
      count - The number of bytes to be returned
      Returns:
      The requested bytes
      Throws:
      BufferBoundsException - if the requested bytes extend beyond the end of the underlying data source
      IOException - if the byte is unable to be read