Class CompositeReadableBuffer

java.lang.Object
org.apache.qpid.proton.codec.CompositeReadableBuffer
All Implemented Interfaces:
ReadableBuffer

public class CompositeReadableBuffer extends Object implements ReadableBuffer
ReadableBuffer implementation whose content is made up of one or more byte arrays.
  • Constructor Details

    • CompositeReadableBuffer

      public CompositeReadableBuffer()
      Creates a default empty composite buffer
  • Method Details

    • getArrays

      public List<byte[]> getArrays()
    • getCurrentIndex

      public int getCurrentIndex()
    • getCurrentArrayPosition

      public int getCurrentArrayPosition()
      Gets the current position index in the current backing array, which represents the current buffer position. This value includes any buffer position movement, and resets when moving across array segments, so it only gives the starting offset for the first array if the buffer position is 0. Value may be out of array bounds if the the buffer currently has no content remaining.
      Returns:
      the position index in the current array representing the current buffer position.
    • hasArray

      public boolean hasArray()
      Description copied from interface: ReadableBuffer
      Returns true if this ReadableBuffer is backed by an array which can be accessed by the ReadableBuffer.array() and ReadableBuffer.arrayOffset() methods.
      Specified by:
      hasArray in interface ReadableBuffer
      Returns:
      true if the buffer is backed by a primitive array.
    • capacity

      public int capacity()
      Description copied from interface: ReadableBuffer
      Returns the capacity of the backing buffer of this ReadableBuffer
      Specified by:
      capacity in interface ReadableBuffer
      Returns:
      the capacity of the backing buffer of this ReadableBuffer
    • array

      public byte[] array()
      Description copied from interface: ReadableBuffer
      Returns the primitive array that backs this buffer if one exists and the buffer is not read-only. The caller should have checked the ReadableBuffer.hasArray() method before calling this method.
      Specified by:
      array in interface ReadableBuffer
      Returns:
      the array that backs this buffer is available.
    • arrayOffset

      public int arrayOffset()
      Description copied from interface: ReadableBuffer
      Returns the offset into the backing array of the first element in the buffer. The caller should have checked the ReadableBuffer.hasArray() method before calling this method.
      Specified by:
      arrayOffset in interface ReadableBuffer
      Returns:
      the offset into the backing array of the first element in the buffer.
    • get

      public byte get()
      Description copied from interface: ReadableBuffer
      Reads the byte at the current position and advances the position by 1.
      Specified by:
      get in interface ReadableBuffer
      Returns:
      the byte at the current position.
    • get

      public byte get(int index)
      Description copied from interface: ReadableBuffer
      Reads the byte at the given index, the buffer position is not affected.
      Specified by:
      get in interface ReadableBuffer
      Parameters:
      index - The index in the buffer from which to read the byte.
      Returns:
      the byte value stored at the target index.
    • getInt

      public int getInt()
      Description copied from interface: ReadableBuffer
      Reads four bytes from the buffer and returns them as an integer value. The buffer position is advanced by four byes.
      Specified by:
      getInt in interface ReadableBuffer
      Returns:
      and integer value composed of bytes read from the buffer.
    • getLong

      public long getLong()
      Description copied from interface: ReadableBuffer
      Reads eight bytes from the buffer and returns them as an long value. The buffer position is advanced by eight byes.
      Specified by:
      getLong in interface ReadableBuffer
      Returns:
      and long value composed of bytes read from the buffer.
    • getShort

      public short getShort()
      Description copied from interface: ReadableBuffer
      Reads two bytes from the buffer and returns them as an short value. The buffer position is advanced by two byes.
      Specified by:
      getShort in interface ReadableBuffer
      Returns:
      and short value composed of bytes read from the buffer.
    • getFloat

      public float getFloat()
      Description copied from interface: ReadableBuffer
      Reads four bytes from the buffer and returns them as an float value. The buffer position is advanced by four byes.
      Specified by:
      getFloat in interface ReadableBuffer
      Returns:
      and float value composed of bytes read from the buffer.
    • getDouble

      public double getDouble()
      Description copied from interface: ReadableBuffer
      Reads eight bytes from the buffer and returns them as an double value. The buffer position is advanced by eight byes.
      Specified by:
      getDouble in interface ReadableBuffer
      Returns:
      and double value composed of bytes read from the buffer.
    • get

      public CompositeReadableBuffer get(byte[] data)
      Description copied from interface: ReadableBuffer
      A bulk read method that copies bytes from this buffer into the target byte array.
      Specified by:
      get in interface ReadableBuffer
      Parameters:
      data - The byte array to copy bytes read from this buffer.
      Returns:
      a reference to this ReadableBuffer instance.
    • get

      public CompositeReadableBuffer get(byte[] data, int offset, int length)
      Description copied from interface: ReadableBuffer
      A bulk read method that copies bytes from this buffer into the target byte array.
      Specified by:
      get in interface ReadableBuffer
      Parameters:
      data - The byte array to copy bytes read from this buffer.
      offset - The offset into the given array where the copy starts.
      length - The number of bytes to copy into the target array.
      Returns:
      a reference to this ReadableBuffer instance.
    • get

      Description copied from interface: ReadableBuffer
      Copy data from this buffer to the target buffer starting from the current position and continuing until either this buffer's remaining bytes are consumed or the target is full.
      Specified by:
      get in interface ReadableBuffer
      Parameters:
      target - The WritableBuffer to transfer this buffer's data to.
      Returns:
      a reference to this ReadableBuffer instance.
    • position

      public CompositeReadableBuffer position(int position)
      Description copied from interface: ReadableBuffer
      Sets the current position of this buffer to the given value. If the buffer mark value is defined and is larger than the newly set position is must be discarded.
      Specified by:
      position in interface ReadableBuffer
      Parameters:
      position - The new position to set for this buffer.
      Returns:
      a reference to this ReadableBuffer.
    • position

      public int position()
      Specified by:
      position in interface ReadableBuffer
      Returns:
      the current position from which the next read operation will start.
    • slice

      public CompositeReadableBuffer slice()
      Description copied from interface: ReadableBuffer
      Creates a new ReadableBuffer instance that is a view of the readable portion of this buffer. The position will be set to zero and the limit and the reported capacity will match the value returned by this buffer's ReadableBuffer.remaining() method, the mark will be undefined.
      Specified by:
      slice in interface ReadableBuffer
      Returns:
      a new ReadableBuffer that is a view of the readable portion of this buffer.
    • flip

      public CompositeReadableBuffer flip()
      Description copied from interface: ReadableBuffer
      Sets the buffer limit to the current position and the position is set to zero, the mark value reset to undefined.
      Specified by:
      flip in interface ReadableBuffer
      Returns:
      a reference to this ReadableBuffer.
    • limit

      public CompositeReadableBuffer limit(int limit)
      Description copied from interface: ReadableBuffer
      Sets the current read limit of this buffer to the given value. If the buffer mark value is defined and is larger than the limit the mark will be discarded. If the position is larger than the new limit it will be reset to the new limit.
      Specified by:
      limit in interface ReadableBuffer
      Parameters:
      limit - The new read limit to set for this buffer.
      Returns:
      a reference to this ReadableBuffer.
    • limit

      public int limit()
      Specified by:
      limit in interface ReadableBuffer
      Returns:
      the current value of this buffer's limit.
    • mark

      public CompositeReadableBuffer mark()
      Description copied from interface: ReadableBuffer
      Mark the current position of this buffer which can be returned to after a read operation by calling ReadableBuffer.reset().
      Specified by:
      mark in interface ReadableBuffer
      Returns:
      a reference to this ReadableBuffer.
    • reset

      public CompositeReadableBuffer reset()
      Description copied from interface: ReadableBuffer
      Reset the buffer's position to a previously marked value, the mark should remain set after calling this method.
      Specified by:
      reset in interface ReadableBuffer
      Returns:
      a reference to this ReadableBuffer.
    • rewind

      public CompositeReadableBuffer rewind()
      Description copied from interface: ReadableBuffer
      Resets the buffer position to zero and clears and previously set mark.
      Specified by:
      rewind in interface ReadableBuffer
      Returns:
      a reference to this ReadableBuffer.
    • clear

      public CompositeReadableBuffer clear()
      Description copied from interface: ReadableBuffer
      Resets the buffer position to zero and sets the limit to the buffer capacity, the mark value is discarded if set.
      Specified by:
      clear in interface ReadableBuffer
      Returns:
      a reference to this ReadableBuffer.
    • remaining

      public int remaining()
      Specified by:
      remaining in interface ReadableBuffer
      Returns:
      the remaining number of readable bytes in this buffer.
    • hasRemaining

      public boolean hasRemaining()
      Specified by:
      hasRemaining in interface ReadableBuffer
      Returns:
      true if there are readable bytes still remaining in this buffer.
    • duplicate

      public CompositeReadableBuffer duplicate()
      Description copied from interface: ReadableBuffer
      Creates a duplicate ReadableBuffer to this instance.

      The duplicated buffer will have the same position, limit and mark as this buffer. The two buffers share the same backing data.

      Specified by:
      duplicate in interface ReadableBuffer
      Returns:
      a duplicate of this ReadableBuffer.
    • byteBuffer

      public ByteBuffer byteBuffer()
      Specified by:
      byteBuffer in interface ReadableBuffer
      Returns:
      a ByteBuffer view of the current readable portion of this buffer.
    • readUTF8

      public String readUTF8() throws CharacterCodingException
      Description copied from interface: ReadableBuffer
      Reads a UTF-8 encoded String from the buffer starting the decode at the current position and reading until the limit is reached. The position is advanced to the limit once this method returns. If there is no bytes remaining in the buffer when this method is called a null is returned.
      Specified by:
      readUTF8 in interface ReadableBuffer
      Returns:
      a string decoded from the remaining bytes in this buffer.
      Throws:
      CharacterCodingException - if the encoding is invalid for any reason.
    • readString

      public String readString(CharsetDecoder decoder) throws CharacterCodingException
      Description copied from interface: ReadableBuffer
      Decodes a String from the buffer using the provided CharsetDecoder starting the decode at the current position and reading until the limit is reached. The position is advanced to the limit once this method returns. If there is no bytes remaining in the buffer when this method is called a null is returned.
      Specified by:
      readString in interface ReadableBuffer
      Returns:
      a string decoded from the remaining bytes in this buffer.
      Throws:
      CharacterCodingException - if the encoding is invalid for any reason.
    • reclaimRead

      public CompositeReadableBuffer reclaimRead()
      Compact the buffer dropping arrays that have been consumed by previous reads from this Composite buffer. The limit is reset to the new capacity
      Specified by:
      reclaimRead in interface ReadableBuffer
      Returns:
      a reference to this buffer
    • append

      public CompositeReadableBuffer append(byte[] array)
      Adds the given array into the composite buffer at the end.

      The appended array is not copied so changes to the source array are visible in this buffer and vice versa. If this composite was empty than it would return true for the hasArray() method until another array is appended.

      Calling this method resets the limit to the new capacity.

      Parameters:
      array - The array to add to this composite buffer.
      Returns:
      a reference to this CompositeReadableBuffer.
      Throws:
      IllegalArgumentException - if the array is null or zero size.
      IllegalStateException - if the buffer does not allow appends.
    • append

      Adds the given composite buffer contents (from current position, up to the limit) into this composite buffer at the end. The source buffer position will be set to its limit.

      The appended buffer contents are not copied wherever possible, so changes to the source arrays are typically visible in this buffer and vice versa. Exceptions include where the source buffer position is not located at the start of its current backing array, or where the given buffer has a limit that doesn't encompass all of the last array used, and so the remainder of that arrays contents must be copied first to append here.

      Calling this method resets the limit to the new capacity.

      Parameters:
      buffer - the buffer with contents to append into this composite buffer.
      Returns:
      a reference to this CompositeReadableBuffer.
      Throws:
      IllegalArgumentException - if the given buffer is null or has zero remainder.
      IllegalStateException - if the buffer does not allow appends.
    • append

      public CompositeReadableBuffer append(ReadableBuffer buffer)
      Adds the given readable buffer contents (from current position, up to the limit) into this composite buffer at the end. The source buffer position will be set to its limit.

      The appended buffer contents are not copied wherever possible, so changes to the source arrays are typically visible in this buffer and vice versa. Exceptions are where the source buffer is not backed by an array, or where the source buffer position is not located at the start of its backing array, and so the remainder of the contents must be copied first to append here.

      Calling this method resets the limit to the new capacity.

      Parameters:
      buffer - the buffer with contents to append into this composite buffer.
      Returns:
      a reference to this CompositeReadableBuffer.
      Throws:
      IllegalArgumentException - if the given buffer is null or has zero remainder.
      IllegalStateException - if the buffer does not allow appends.
    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object
    • equals

      public boolean equals(Object other)
      Overrides:
      equals in class Object
    • toString

      public String toString()
      Overrides:
      toString in class Object