Module org.glassfish.grizzly
Package org.glassfish.grizzly.memory

Class BuffersBuffer

java.lang.Object
org.glassfish.grizzly.memory.CompositeBuffer
org.glassfish.grizzly.memory.BuffersBuffer
All Implemented Interfaces:
Comparable<Buffer>, WritableMessage, Buffer
public final class BuffersBuffer extends CompositeBuffer
Author:
Alexey Stashok

  • Field Details

    • DEBUG_MODE

      public static volatile boolean DEBUG_MODE

    • disposeStackTrace

      protected Exception disposeStackTrace

  • Constructor Details

    • BuffersBuffer

      protected BuffersBuffer(MemoryManager memoryManager, Buffer[] buffers, int buffersSize, boolean isReadOnly)

  • Method Details

    • create

      public static BuffersBuffer create()
      Construct BuffersBuffer.
      Returns:
      BuffersBuffer

    • create

      public static BuffersBuffer create(MemoryManager memoryManager)

    • create

      public static BuffersBuffer create(MemoryManager memoryManager, Buffer... buffers)

    • create

      public static BuffersBuffer create(MemoryManager memoryManager, Buffer[] buffers, boolean isReadOnly)

    • tryDispose

      public boolean tryDispose()
      Description copied from interface: Buffer
      Try to dispose Buffer if it's allowed.
      Returns:
      true if successfully disposed

    • dispose

      public void dispose()
      Description copied from interface: Buffer
      Notify the allocator that the space for this Buffer is no longer needed. All calls to methods on a Buffer will fail after a call to dispose().

    • isComposite

      public boolean isComposite()
      Returns:
      true if this Buffer represents a composite of individual Buffer instances.

    • append

      public BuffersBuffer append(Buffer buffer)
      Specified by:
      append in class CompositeBuffer

    • prepend

      public BuffersBuffer prepend(Buffer buffer)
      Description copied from interface: Buffer
      Prepend data from header.position() to header.limit() to the current buffer. This will change the value returned by buffer()!
      Specified by:
      prepend in interface Buffer
      Specified by:
      prepend in class CompositeBuffer
      Parameters:
      buffer - the data to prepend
      Returns:
      the new buffer

    • replace

      public boolean replace(Buffer oldBuffer, Buffer newBuffer)
      Description copied from class: CompositeBuffer
      Replace one internal Buffer with another one.
      Specified by:
      replace in class CompositeBuffer
      Parameters:
      oldBuffer - the Buffer to replace.
      newBuffer - the new Buffer.
      Returns:
      true, if the oldBuffer was found and replaced, or false otherwise.

    • underlying

      public Buffer[] underlying()
      Description copied from interface: Buffer
      Return the underlying buffer
      Specified by:
      underlying in interface Buffer
      Specified by:
      underlying in class CompositeBuffer
      Returns:
      the underlying buffer

    • position

      public int position()
      Description copied from interface: Buffer
      Returns this buffer's position.
      Returns:
      The position of this buffer

    • position

      public BuffersBuffer position(int newPosition)
      Description copied from interface: Buffer
      Sets this buffer's position. If the mark is defined and larger than the new position then it is discarded.
      Parameters:
      newPosition - The new position value; must be non-negative and no larger than the current limit
      Returns:
      This buffer

    • limit

      public int limit()
      Description copied from interface: Buffer
      Returns this buffer's limit.
      Returns:
      The limit of this buffer

    • limit

      public BuffersBuffer limit(int newLimit)
      Description copied from interface: Buffer
      Sets this buffer's limit. If the position is larger than the new limit then it is set to the new limit. If the mark is defined and larger than the new limit then it is discarded.
      Parameters:
      newLimit - The new limit value; must be non-negative and no larger than this buffer's capacity
      Returns:
      This buffer

    • capacity

      public int capacity()
      Description copied from interface: Buffer
      Returns this buffer's capacity.
      Returns:
      The capacity of this buffer

    • mark

      public BuffersBuffer mark()
      Description copied from interface: Buffer
      Sets this buffer's mark at its position.
      Returns:
      This buffer

    • reset

      public BuffersBuffer reset()
      Description copied from interface: Buffer
      Resets this buffer's position to the previously-marked position.

      Invoking this method neither changes nor discards the mark's value.

      Returns:
      This buffer

    • isDirect

      public boolean isDirect()
      Description copied from interface: Buffer
      Tells whether or not this buffer is direct.
      Returns:
      true if, and only if, this buffer is direct

    • clear

      public BuffersBuffer clear()
      Description copied from interface: Buffer
      Clears this buffer. The position is set to zero, the limit is set to the capacity, and the mark is discarded.

      Invoke this method before using a sequence of channel-read or put operations to fill this buffer. For example: 

       buf.clear(); // Prepare buffer for reading
 in.read(buf); // Read data

      This method does not actually erase the data in the buffer, but it is named as if it did because it will most often be used in situations in which that might as well be the case.

      Returns:
      This buffer

    • flip

      public BuffersBuffer flip()
      Description copied from interface: Buffer
      Flips this buffer. The limit is set to the current position and then the position is set to zero. If the mark is defined then it is discarded.

      After a sequence of channel-read or put operations, invoke this method to prepare for a sequence of channel-write or relative get operations. For example: 

       buf.put(magic); // Prepend header
 in.read(buf); // Read data into rest of buffer
 buf.flip(); // Flip buffer
 out.write(buf); // Write header + data to channel

      This method is often used in conjunction with the compact method when transferring data from one place to another.

      Returns:
      This buffer

    • rewind

      public BuffersBuffer rewind()
      Description copied from interface: Buffer
      Rewinds this buffer. The position is set to zero and the mark is discarded.

      Invoke this method before a sequence of channel-write or get operations, assuming that the limit has already been set appropriately. For example: 

       out.write(buf); // Write remaining data
 buf.rewind(); // Rewind buffer
 buf.get(array); // Copy data into array
      Returns:
      This buffer

    • remaining

      public int remaining()
      Description copied from interface: Buffer
      Returns the number of elements between the current position and the limit.
      Returns:
      The number of elements remaining in this buffer

    • hasRemaining

      public boolean hasRemaining()
      Description copied from interface: Buffer
      Tells whether there are any elements between the current position and the limit.
      Returns:
      true if, and only if, there is at least one element remaining in this buffer

    • isReadOnly

      public boolean isReadOnly()
      Description copied from interface: Buffer
      Tells whether or not this buffer is read-only.
      Returns:
      true if, and only if, this buffer is read-only

    • asReadOnlyBuffer

      public BuffersBuffer asReadOnlyBuffer()
      Description copied from interface: Buffer
      Creates a new, read-only Buffer that shares this buffer's content.

      The content of the new buffer will be that of this buffer. Changes to this buffer's content will be visible in the new buffer; the new buffer itself, however, will be read-only and will not allow the shared content to be modified. The two buffer's position, limit, and mark values will be independent.

      The new buffer's capacity, limit, position, and mark values will be identical to those of this buffer.

      If this buffer is itself read-only then this method behaves in exactly the same way as the duplicate method.

      Returns:
      The new, read-only Buffer

    • split

      public Buffer split(int splitPosition)
      Description copied from interface: Buffer
      Split up the buffer into two parts: [0..splitPosition) and [splitPosition, capacity). This Buffer will represent the first part: [0..splitPosition) and returned Buffer will represent the second part: [splitPosition, capacity). Splitting a buffer will reset the mark if the mark is greater than or equal to the splitPosition.
      Parameters:
      splitPosition - position of split.
      Returns:
      the Buffer, which represents split part [splitPosition, capacity)

    • shrink

      public void shrink()
      Description copied from interface: Buffer
      Disposes the buffer part, outside [position, limit] interval if possible. May return without changing capacity. After shrink is called, position/limit/capacity values may have different values, than before, but still point to the same Buffer elements.

    • trim

      public void trim()
      Description copied from interface: Buffer
      Trim the buffer by reducing capacity to position, if possible. May return without changing capacity. Also resets the position to 0, like Buffer.flip().

    • removeRightBuffers

      protected int removeRightBuffers(int startIndex)

    • slice

      public Buffer slice()
      Description copied from interface: Buffer
      Creates a new Buffer whose content is a shared subsequence of this buffer's content.

      The content of the new buffer will start at this buffer's current position. Changes to this buffer's content will be visible in the new buffer, and vice versa; the two buffers' position, limit, and mark values will be independent.

      The new buffer's position will be zero, its capacity and its limit will be the number of bytes remaining in this buffer, and its mark will be undefined. The new buffer will be direct if, and only if, this buffer is direct, and it will be read-only if, and only if, this buffer is read-only.

      Returns:
      The new Buffer

    • slice

      public Buffer slice(int position, int limit)
      Description copied from interface: Buffer
      Creates a new Buffer whose content is a shared subsequence of this buffer's content.

      The content of the new buffer will start at passed position and end at passed limit. Changes to this buffer's content will be visible in the new buffer, and vice versa; the two buffer's position, limit, and mark values will be independent.

      The new buffer's position will be zero, its capacity and its limit will be the number of bytes remaining in this buffer, and its mark will be undefined. The new buffer will be direct if, and only if, this buffer is direct, and it will be read-only if, and only if, this buffer is read-only.

      Parameters:
      position - the position of the start of the slice
      limit - the limit to take the slice up to
      Returns:
      The new Buffer

    • duplicate

      public BuffersBuffer duplicate()
      Description copied from interface: Buffer
      Creates a new Buffer that shares this buffer's content.

      The content of the new buffer will be that of this buffer. Changes to this buffer's content will be visible in the new buffer, and vice versa; the two buffer's position, limit, and mark values will be independent.

      The new buffer's capacity, limit, position, and mark values will be identical to those of this buffer. The new buffer will be direct if, and only if, this buffer is direct, and it will be read-only if, and only if, this buffer is read-only.

      Returns:
      The new Buffer

    • compact

      public BuffersBuffer compact()
      Description copied from interface: Buffer
      Compacts this buffer  (optional operation).

      The bytes between the buffer's current position and its limit, if any, are copied to the beginning of the buffer. That is, the byte at index p = position() is copied to index zero, the byte at index p + 1 is copied to index one, and so forth until the byte at index limit() - 1 is copied to index n = limit() - 1 - p. The buffer's position is then set to n+1 and its limit is set to its capacity. The mark, if defined, is discarded.

      The buffer's position is set to the number of bytes copied, rather than to zero, so that an invocation of this method can be followed immediately by an invocation of another relative put method.

      Invoke this method after writing data from a buffer in case the write was incomplete. The following loop, for example, copies bytes from one channel to another via the buffer buf: 

       buf.clear(); // Prepare buffer for use
 for (;;) {
     if (in.read(buf) < 0 && !buf.hasRemaining())
         break; // No more bytes to transfer
     buf.flip();
     out.write(buf);
     buf.compact(); // In case of partial write
 }
      Returns:
      This buffer

    • order

      public ByteOrder order()
      Description copied from interface: Buffer
      Retrieves this buffer's byte order.

      The byte order is used when reading or writing multibyte values, and when creating buffers that are views of this Buffer. The order of a newly-created Buffer is always BIG_ENDIAN.

      Returns:
      This buffer's byte order

    • order

      public BuffersBuffer order(ByteOrder bo)
      Description copied from interface: Buffer
      Modifies this buffer's byte order.
      Parameters:
      bo - The new byte order, either BIG_ENDIAN or LITTLE_ENDIAN
      Returns:
      This buffer

    • allowBufferDispose

      public boolean allowBufferDispose()

    • allowBufferDispose

      public void allowBufferDispose(boolean allow)

    • allowInternalBuffersDispose

      public boolean allowInternalBuffersDispose()
      Specified by:
      allowInternalBuffersDispose in class CompositeBuffer

    • allowInternalBuffersDispose

      public void allowInternalBuffersDispose(boolean allowInternalBuffersDispose)
      Specified by:
      allowInternalBuffersDispose in class CompositeBuffer

    • get

      public byte get()
      Description copied from interface: Buffer
      Relative get method. Reads the byte at this buffer's current position, and then increments the position.
      Returns:
      The byte at the buffer's current position

    • put

      public BuffersBuffer put(byte b)
      Description copied from interface: Buffer
      Relative put method  (optional operation).

      Writes the given byte into this buffer at the current position, and then increments the position.

      Parameters:
      b - The byte to be written
      Returns:
      This buffer

    • get

      public byte get(int index)
      Description copied from interface: Buffer
      Absolute get method. Reads the byte at the given index.
      Parameters:
      index - The index from which the byte will be read
      Returns:
      The byte at the given index

    • put

      public BuffersBuffer put(int index, byte b)
      Description copied from interface: Buffer
      Absolute put method  (optional operation).

      Writes the given byte into this buffer at the given index.

      Parameters:
      index - The index at which the byte will be written
      b - The byte value to be written
      Returns:
      This buffer

    • get

      public BuffersBuffer get(byte[] dst)
      Description copied from interface: Buffer
      Relative bulk get method.

      This method transfers bytes from this buffer into the given destination array. An invocation of this method of the form src.get(a) behaves in exactly the same way as the invocation 

       src.get(a, 0, a.length)
      Parameters:
      dst - destination array to put the bytes into
      Returns:
      This buffer

    • get

      public BuffersBuffer get(byte[] dst, int offset, int length)
      Description copied from interface: Buffer
      Relative bulk get method.

      This method transfers bytes from this buffer into the given destination array. If there are fewer bytes remaining in the buffer than are required to satisfy the request, that is, if length > remaining(), then no bytes are transferred and a BufferUnderflowException is thrown.

      Otherwise, this method copies length bytes from this buffer into the given array, starting at the current position of this buffer and at the given offset in the array. The position of this buffer is then incremented by length.

      In other words, an invocation of this method of the form src.get(dst, off, len) has exactly the same effect as the loop 

       for (int i = off; i < off + len; i++)
     dst[i] = src.get();
      except that it first checks that there are sufficient bytes in this buffer and it is potentially much more efficient.
      Parameters:
      dst - The array into which bytes are to be written
      offset - The offset within the array of the first byte to be written; must be non-negative and no larger than dst.length
      length - The maximum number of bytes to be written to the given array; must be non-negative and no larger than dst.length - offset
      Returns:
      This buffer

    • put

      public BuffersBuffer put(byte[] src)
      Description copied from interface: Buffer
      Relative bulk put method  (optional operation).

      This method transfers the entire content of the given source byte array into this buffer. An invocation of this method of the form dst.put(a) behaves in exactly the same way as the invocation 

       dst.put(a, 0, a.length)
      Parameters:
      src - source of bytes to put into the Buffer
      Returns:
      This buffer

    • put

      public BuffersBuffer put(byte[] src, int offset, int length)
      Description copied from interface: Buffer
      Relative bulk put method  (optional operation).

      This method transfers bytes into this buffer from the given source array. If there are more bytes to be copied from the array than remain in this buffer, that is, if length > remaining(), then no bytes are transferred and a BufferOverflowException is thrown.

      Otherwise, this method copies length bytes from the given array into this buffer, starting at the given offset in the array and at the current position of this buffer. The position of this buffer is then incremented by length.

      In other words, an invocation of this method of the form dst.put(src, off, len) has exactly the same effect as the loop 

       for (int i = off; i < off + len; i++)
     dst.put(a[i]);
      except that it first checks that there is sufficient space in this buffer and it is potentially much more efficient.
      Parameters:
      src - The array from which bytes are to be read
      offset - The offset within the array of the first byte to be read; must be non-negative and no larger than array.length
      length - The number of bytes to be read from the given array; must be non-negative and no larger than array.length - offset
      Returns:
      This buffer

    • put8BitString

      public BuffersBuffer put8BitString(String s)
      Description copied from interface: Buffer
      Relative bulk put method  (optional operation).

      This method transfers bytes into this buffer from the given 8-bit source String. If the source String.length() is bigger than this buffer's remaining, that is, if length() > remaining(), then no bytes are transferred and a BufferOverflowException is thrown.

      Otherwise, this method copies length bytes from the given String into this buffer.

      In other words, an invocation of this method of the form dst.put8BitString(src) has exactly the same effect as the loop 

       for (int i = 0; i < src.length(); i++)
     dst.put((byte) src.charAt(i));
      except that it first checks that there is sufficient space in this buffer and it is potentially much more efficient.
      Parameters:
      s - The String from which bytes are to be read
      Returns:
      This buffer

    • get

      public BuffersBuffer get(ByteBuffer dst)
      Description copied from interface: Buffer
      Relative bulk get method.

      This method transfers bytes from this buffer into the given destination ByteBuffer. An invocation of this method of the form src.get(a) behaves in exactly the same way as the invocation 

       src.get(a, 0, a.remaining())
      Parameters:
      dst - destination ByteBuffer to put the data into
      Returns:
      This buffer

    • get

      public BuffersBuffer get(ByteBuffer dst, int offset, int length)
      Description copied from interface: Buffer
      Relative bulk get method.

      This method transfers bytes from this buffer into the given destination ByteBuffer. If there are fewer bytes remaining in the buffer than are required to satisfy the request, that is, if length > remaining(), then no bytes are transferred and a BufferUnderflowException is thrown.

      Otherwise, this method copies length bytes from this buffer into the given ByteBuffer, starting at the current position of this buffer and at the given offset in the ByteBuffer. The position of this buffer is then incremented by length.

      In other words, an invocation of this method of the form src.get(dst, off, len) has exactly the same effect as the loop 

       for (int i = off; i < off + len; i++)
     dst.put(i) = src.get();
      except that it first checks that there are sufficient bytes in this buffer and it is potentially much more efficient.
      Parameters:
      dst - The ByteBuffer into which bytes are to be written
      offset - The offset within the ByteBuffer of the first byte to be written; must be non-negative and no larger than dst.remaining()
      length - The maximum number of bytes to be written to the given array; must be non-negative and no larger than dst.remaining() - offset
      Returns:
      This buffer

    • put

      public BuffersBuffer put(ByteBuffer src)
      Description copied from interface: Buffer
      Relative bulk put method  (optional operation).

      This method transfers the bytes remaining in the given source buffer into this buffer. If there are more bytes remaining in the source buffer than in this buffer, that is, if src.remaining() > remaining(), then no bytes are transferred and a BufferOverflowException is thrown.

      Otherwise, this method copies n = src.remaining() bytes from the given buffer into this buffer, starting at each buffer's current position. The positions of both buffers are then incremented by n.

      In other words, an invocation of this method of the form dst.put(src) has exactly the same effect as the loop 

       while (src.hasRemaining())
     dst.put(src.get());
      except that it first checks that there is sufficient space in this buffer and it is potentially much more efficient.
      Parameters:
      src - The source buffer from which bytes are to be read; must not be this buffer
      Returns:
      This buffer

    • put

      public BuffersBuffer put(ByteBuffer src, int offset, int length)
      Description copied from interface: Buffer
      Relative bulk put method  (optional operation).

      This method transfers the "length" bytes from the given source buffer into this buffer. If this buffer has less bytes remaining than length, that is, if length > remaining(), then no bytes are transferred and a BufferOverflowException is thrown.

      Otherwise, this method copies n = length bytes from the given position in the source buffer into this buffer, starting from the current buffer position. The positions of this buffer is then incremented by length.

      In other words, an invocation of this method of the form dst.put(src, position, length) has exactly the same effect as the loop 

       for (int i = 0; i < length; i++)
     dst.put(src.get(i + position));
      except that it first checks that there is sufficient space in this buffer and it is potentially much more efficient.
      Parameters:
      src - The source buffer from which bytes are to be read; must not be this buffer
      offset - starting position in the source buffer
      length - number of bytes to be copied
      Returns:
      This buffer

    • put

      public BuffersBuffer put(Buffer src)
      Description copied from interface: Buffer
      Relative bulk put method  (optional operation).

      This method transfers the bytes remaining in the given source buffer into this buffer. If there are more bytes remaining in the source buffer than in this buffer, that is, if src.remaining() > remaining(), then no bytes are transferred and a BufferOverflowException is thrown.

      Otherwise, this method copies n = src.remaining() bytes from the given buffer into this buffer, starting at each buffer's current position. The positions of both buffers are then incremented by n.

      In other words, an invocation of this method of the form dst.put(src) has exactly the same effect as the loop 

       while (src.hasRemaining())
     dst.put(src.get());
      except that it first checks that there is sufficient space in this buffer and it is potentially much more efficient.
      Parameters:
      src - The source buffer from which bytes are to be read; must not be this buffer
      Returns:
      This buffer

    • put

      public Buffer put(Buffer src, int position, int length)
      Description copied from interface: Buffer
      Relative bulk put method  (optional operation).

      This method transfers the "length" bytes from the given source buffer into this buffer. If this buffer has less bytes remaining than length, that is, if length > remaining(), then no bytes are transferred and a BufferOverflowException is thrown.

      Otherwise, this method copies n = length bytes from the given position in the source buffer into this buffer, starting from the current buffer position. The positions of this buffer is then incremented by length.

      In other words, an invocation of this method of the form dst.put(src, position, length) has exactly the same effect as the loop 

       for (int i = 0; i < length; i++)
     dst.put(src.get(i + position));
      except that it first checks that there is sufficient space in this buffer and it is potentially much more efficient.
      Parameters:
      src - The source buffer from which bytes are to be read; must not be this buffer
      position - starting position in the source buffer
      length - number of bytes to be copied
      Returns:
      This buffer

    • getChar

      public char getChar()
      Description copied from interface: Buffer
      Relative get method for reading a char value.

      Reads the next two bytes at this buffer's current position, composing them into a char value according to the current byte order, and then increments the position by two.

      Returns:
      The char value at the buffer's current position

    • putChar

      public BuffersBuffer putChar(char value)
      Description copied from interface: Buffer
      Relative put method for writing a char value  (optional operation).

      Writes two bytes containing the given char value, in the current byte order, into this buffer at the current position, and then increments the position by two.

      Parameters:
      value - The char value to be written
      Returns:
      This buffer

    • getChar

      public char getChar(int index)
      Description copied from interface: Buffer
      Absolute get method for reading a char value.

      Reads two bytes at the given index, composing them into a char value according to the current byte order.

      Parameters:
      index - The index from which the bytes will be read
      Returns:
      The char value at the given index

    • putChar

      public BuffersBuffer putChar(int index, char value)
      Description copied from interface: Buffer
      Absolute put method for writing a char value  (optional operation).

      Writes two bytes containing the given char value, in the current byte order, into this buffer at the given index.

      Parameters:
      index - The index at which the bytes will be written
      value - The char value to be written
      Returns:
      This buffer

    • getShort

      public short getShort()
      Description copied from interface: Buffer
      Relative get method for reading a short value.

      Reads the next two bytes at this buffer's current position, composing them into a short value according to the current byte order, and then increments the position by two.

      Returns:
      The short value at the buffer's current position

    • putShort

      public BuffersBuffer putShort(short value)
      Description copied from interface: Buffer
      Relative put method for writing a short value  (optional operation).

      Writes two bytes containing the given short value, in the current byte order, into this buffer at the current position, and then increments the position by two.

      Parameters:
      value - The short value to be written
      Returns:
      This buffer

    • getShort

      public short getShort(int index)
      Description copied from interface: Buffer
      Absolute get method for reading a short value.

      Reads two bytes at the given index, composing them into a short value according to the current byte order.

      Parameters:
      index - The index from which the bytes will be read
      Returns:
      The short value at the given index

    • putShort

      public BuffersBuffer putShort(int index, short value)
      Description copied from interface: Buffer
      Absolute put method for writing a short value  (optional operation).

      Writes two bytes containing the given short value, in the current byte order, into this buffer at the given index.

      Parameters:
      index - The index at which the bytes will be written
      value - The short value to be written
      Returns:
      This buffer

    • getInt

      public int getInt()
      Description copied from interface: Buffer
      Relative get method for reading an int value.

      Reads the next four bytes at this buffer's current position, composing them into an int value according to the current byte order, and then increments the position by four.

      Returns:
      The int value at the buffer's current position

    • putInt

      public BuffersBuffer putInt(int value)
      Description copied from interface: Buffer
      Relative put method for writing an int value  (optional operation).

      Writes four bytes containing the given int value, in the current byte order, into this buffer at the current position, and then increments the position by four.

      Parameters:
      value - The int value to be written
      Returns:
      This buffer

    • getInt

      public int getInt(int index)
      Description copied from interface: Buffer
      Absolute get method for reading an int value.

      Reads four bytes at the given index, composing them into a int value according to the current byte order.

      Parameters:
      index - The index from which the bytes will be read
      Returns:
      The int value at the given index

    • putInt

      public BuffersBuffer putInt(int index, int value)
      Description copied from interface: Buffer
      Absolute put method for writing an int value  (optional operation).

      Writes four bytes containing the given int value, in the current byte order, into this buffer at the given index.

      Parameters:
      index - The index at which the bytes will be written
      value - The int value to be written
      Returns:
      This buffer

    • getLong

      public long getLong()
      Description copied from interface: Buffer
      Relative get method for reading a long value.

      Reads the next eight bytes at this buffer's current position, composing them into a long value according to the current byte order, and then increments the position by eight.

      Returns:
      The long value at the buffer's current position

    • putLong

      public BuffersBuffer putLong(long value)
      Description copied from interface: Buffer
      Relative put method for writing a long value  (optional operation).

      Writes eight bytes containing the given long value, in the current byte order, into this buffer at the current position, and then increments the position by eight.

      Parameters:
      value - The long value to be written
      Returns:
      This buffer

    • getLong

      public long getLong(int index)
      Description copied from interface: Buffer
      Absolute get method for reading a long value.

      Reads eight bytes at the given index, composing them into a long value according to the current byte order.

      Parameters:
      index - The index from which the bytes will be read
      Returns:
      The long value at the given index

    • putLong

      public BuffersBuffer putLong(int index, long value)
      Description copied from interface: Buffer
      Absolute put method for writing a long value  (optional operation).

      Writes eight bytes containing the given long value, in the current byte order, into this buffer at the given index.

      Parameters:
      index - The index at which the bytes will be written
      value - The long value to be written
      Returns:
      This buffer

    • getFloat

      public float getFloat()
      Description copied from interface: Buffer
      Relative get method for reading a float value.

      Reads the next four bytes at this buffer's current position, composing them into a float value according to the current byte order, and then increments the position by four.

      Returns:
      The float value at the buffer's current position

    • putFloat

      public BuffersBuffer putFloat(float value)
      Description copied from interface: Buffer
      Relative put method for writing a float value  (optional operation).

      Writes four bytes containing the given float value, in the current byte order, into this buffer at the current position, and then increments the position by four.

      Parameters:
      value - The float value to be written
      Returns:
      This buffer

    • getFloat

      public float getFloat(int index)
      Description copied from interface: Buffer
      Absolute get method for reading a float value.

      Reads four bytes at the given index, composing them into a float value according to the current byte order.

      Parameters:
      index - The index from which the bytes will be read
      Returns:
      The float value at the given index

    • putFloat

      public BuffersBuffer putFloat(int index, float value)
      Description copied from interface: Buffer
      Absolute put method for writing a float value  (optional operation).

      Writes four bytes containing the given float value, in the current byte order, into this buffer at the given index.

      Parameters:
      index - The index at which the bytes will be written
      value - The float value to be written
      Returns:
      This buffer

    • getDouble

      public double getDouble()
      Description copied from interface: Buffer
      Relative get method for reading a double value.

      Reads the next eight bytes at this buffer's current position, composing them into a double value according to the current byte order, and then increments the position by eight.

      Returns:
      The double value at the buffer's current position

    • putDouble

      public BuffersBuffer putDouble(double value)
      Description copied from interface: Buffer
      Relative put method for writing a double value  (optional operation).

      Writes eight bytes containing the given double value, in the current byte order, into this buffer at the current position, and then increments the position by eight.

      Parameters:
      value - The double value to be written
      Returns:
      This buffer

    • getDouble

      public double getDouble(int index)
      Description copied from interface: Buffer
      Absolute get method for reading a double value.

      Reads eight bytes at the given index, composing them into a double value according to the current byte order.

      Parameters:
      index - The index from which the bytes will be read
      Returns:
      The double value at the given index

    • putDouble

      public BuffersBuffer putDouble(int index, double value)
      Description copied from interface: Buffer
      Absolute put method for writing a double value  (optional operation).

      Writes eight bytes containing the given double value, in the current byte order, into this buffer at the given index.

      Parameters:
      index - The index at which the bytes will be written
      value - The double value to be written
      Returns:
      This buffer

    • bulk

      public int bulk(CompositeBuffer.BulkOperation operation)
      Iterates over Buffer bytes from Buffer.position() to Buffer.limit() and lets CompositeBuffer.BulkOperation examine/change the buffer content;
      Specified by:
      bulk in class CompositeBuffer
      Parameters:
      operation - CompositeBuffer.BulkOperation
      Returns:
      Buffer position the processing was stopped on, or -1, if processing reached the limit.

    • bulk

      public int bulk(CompositeBuffer.BulkOperation operation, int position, int limit)
      Iterates over Buffer bytes from position to limit and lets CompositeBuffer.BulkOperation examine/change the buffer content;
      Specified by:
      bulk in class CompositeBuffer
      Parameters:
      operation - CompositeBuffer.BulkOperation
      Returns:
      Buffer position the processing was stopped on, or -1, if processing reached the limit.

    • compareTo

      public int compareTo(Buffer that)

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • toStringContent

      public String toStringContent()
      Description copied from interface: Buffer
      Returns Buffer content as String, using default Charset
      Returns:
      String representation of this Buffer content.

    • toStringContent

      public String toStringContent(Charset charset)
      Description copied from interface: Buffer
      Returns Buffer content as String
      Parameters:
      charset - the Charset, which will be use for byte[] -> String transformation.
      Returns:
      String representation of this Buffer content.

    • toStringContent

      public String toStringContent(Charset charset, int position, int limit)
      Description copied from interface: Buffer
      Returns Buffer's chunk content as String
      Parameters:
      charset - the Charset, which will be use for byte[] -> String transformation.
      position - the first byte offset in the Buffer (inclusive)
      limit - the last byte offset in the Buffer (exclusive)
      Returns:
      String representation of part of this Buffer.

    • dumpHex

      public void dumpHex(Appendable appendable)
      Description copied from interface: Buffer
      Generate a hex dump of this Buffer's content.
      Parameters:
      appendable - the Appendable to dump this Buffer's content to.

    • toByteBuffer

      public ByteBuffer toByteBuffer()
      Description copied from interface: Buffer

      Converts this Buffer to a ByteBuffer. If this Buffer is not composite - then returned ByteBuffer's content is a shared subsequence of this buffer's content, with CompositeBuffer this is not guaranteed. The position of the returned ByteBuffer is not guaranteed to be 0, the capacity of the returned ByteBuffer is not guaranteed to be equal to the capacity of this Buffer. It is guaranteed that the result of the returned ByteBuffer's Buffer.remaining() call will be equal to this Buffer's Buffer.remaining() call. The Buffer's and ByteBuffer's position, limit, and mark values are not guaranteed to be independent, so it's recommended to save and restore position, limit values if it is planned to change them or ByteBuffer.slice() the returned ByteBuffer.

      Returns:
      this Buffer as a ByteBuffer.

    • toByteBuffer

      public ByteBuffer toByteBuffer(int position, int limit)
      Description copied from interface: Buffer

      Converts this Buffer to a ByteBuffer. If this Buffer is not composite - then returned ByteBuffer's content is a shared subsequence of this buffer's content, with CompositeBuffer this is not guaranteed. The position of the returned ByteBuffer is not guaranteed to be 0, the capacity of the returned ByteBuffer is not guaranteed to be equal to the capacity of this Buffer. It is guaranteed that the result of the returned ByteBuffer's Buffer.remaining() call will be equal (limit - position). The Buffer's and ByteBuffer's position, limit, and mark values are not guaranteed to be independent, so it's recommended to save and restore position, limit values if it is planned to change them or ByteBuffer.slice() the returned ByteBuffer.

      Parameters:
      position - the position for the starting subsequence for the returned ByteBuffer.
      limit - the limit for the ending of the subsequence of the returned ByteBuffer.
      Returns:
      this Buffer as a ByteBuffer.

    • toByteBufferArray

      public ByteBufferArray toByteBufferArray()
      Description copied from interface: Buffer

      Converts this Buffer to a ByteBuffer per Buffer.toByteBuffer() and returns a ByteBufferArray containing the converted ByteBuffer. It is guaranteed that returned array's ByteBuffer elements' content is a shared subsequence of this buffer's content no matter if it's a CompositeBuffer or not.

      Returns:
      Converts this Buffer to a ByteBuffer per Buffer.toByteBuffer() and returns a ByteBufferArray containing the converted ByteBuffer.
      See Also:

    • toByteBufferArray

      public ByteBufferArray toByteBufferArray(ByteBufferArray array)
      Description copied from interface: Buffer

      Converts this Buffer to a ByteBuffer per Buffer.toByteBuffer() and adds the result to the provided ByteBufferArray. It is guaranteed that returned array's ByteBuffer elements' content is a shared subsequence of this buffer's content no matter if it's a CompositeBuffer or not.

      Parameters:
      array - this buffer as a ByteBufferArray
      Returns:
      returns the provided ByteBufferArray with the converted ByteBuffer added to provided array.
      See Also:

    • toByteBufferArray

      public ByteBufferArray toByteBufferArray(int position, int limit)
      Description copied from interface: Buffer

      Converts this Buffer to a ByteBuffer per Buffer.toByteBuffer(int, int) and returns a ByteBufferArray containing the converted ByteBuffer. It is guaranteed that returned array's ByteBuffer elements' content is a shared subsequence of this buffer's content no matter if it's a CompositeBuffer or not.

      Parameters:
      position - the start position within the source buffer
      limit - the limit, or number, of bytes to include in the resulting ByteBuffer
      Returns:
      Converts this Buffer to a ByteBuffer per Buffer.toByteBuffer(int, int) and returns a ByteBufferArray containing the converted ByteBuffer.
      See Also:

    • toByteBufferArray

      public ByteBufferArray toByteBufferArray(ByteBufferArray array, int position, int limit)
      Description copied from interface: Buffer

      Converts this Buffer to a ByteBuffer per Buffer.toByteBuffer(int, int) and adds the result to the provided ByteBufferArray. It is guaranteed that returned array's ByteBuffer elements' content is a shared subsequence of this buffer's content no matter if it's a CompositeBuffer or not.

      Parameters:
      array - the ByteBufferArray to append this to
      position - the start position within the source buffer
      limit - the limit, or number, of bytes to include in the resulting ByteBuffer
      Returns:
      returns the provided ByteBufferArray with the converted ByteBuffer added to provided array.
      See Also:

    • toBufferArray

      public BufferArray toBufferArray()
      Description copied from interface: Buffer

      Returns a new BufferArray instance with this Buffer added as an element to the BufferArray. It is guaranteed that returned array's Buffer elements' content is a shared subsequence of this buffer's content no matter if it's a CompositeBuffer or not.

      Returns:
      Returns a new BufferArray instance with this Buffer added as an element to the BufferArray.

    • toBufferArray

      public BufferArray toBufferArray(BufferArray array)
      Description copied from interface: Buffer

      Returns the specified BufferArray after adding this Buffer. It is guaranteed that returned array's Buffer elements' content is a shared subsequence of this buffer's content no matter if it's a CompositeBuffer or not.

      Parameters:
      array - the base array to append to
      Returns:
      Returns the specified BufferArray after adding this Buffer.

    • toBufferArray

      public BufferArray toBufferArray(int position, int limit)
      Description copied from interface: Buffer

      Updates this Buffer's position and limit and adds it to a new BufferArray instance. It is guaranteed that returned array's Buffer elements' content is a shared subsequence of this buffer's content no matter if it's a CompositeBuffer or not.

      Parameters:
      position - the new position for this Buffer
      limit - the new limit for this Buffer
      Returns:
      adds this Buffer and returns the specified BufferArray.

    • toBufferArray

      public BufferArray toBufferArray(BufferArray array, int position, int limit)
      Description copied from interface: Buffer

      Updates this Buffer's position and limit and adds it to the specified BufferArray. It is guaranteed that returned array's Buffer elements' content is a shared subsequence of this buffer's content no matter if it's a CompositeBuffer or not.

      Parameters:
      array - the BufferArray to prepend to
      position - the new position for this Buffer
      limit - the new limit for this Buffer
      Returns:
      adds this Buffer and returns the specified BufferArray.

    • removeAll

      public void removeAll()
      Description copied from class: CompositeBuffer
      Removes underlying Buffers, without disposing
      Specified by:
      removeAll in class CompositeBuffer

    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object

    • hasArray

      public boolean hasArray()
      Description copied from interface: Buffer
      Tells whether or not this buffer is backed by an accessible byte array. If this method returns true then the array and arrayOffset methods may safely be invoked.
      Returns:
      true if, and only if, this buffer is backed by an array and is not read-only

    • array

      public byte[] array()
      Description copied from interface: Buffer
      Returns the byte array that backs this buffer (optional operation). Modifications to this buffer's content will cause the returned array's content to be modified, and vice versa. Invoke the hasArray method before invoking this method in order to ensure that this buffer has an accessible backing array.
      Returns:
      The array that backs this buffer

    • arrayOffset

      public int arrayOffset()
      Description copied from interface: Buffer
      Returns the offset within this buffer's backing array of the first element of the buffer (optional operation). If this buffer is backed by an array then buffer position p corresponds to array index p + arrayOffset(). Invoke the hasArray method before invoking this method in order to ensure that this buffer has an accessible backing array.
      Returns:
      The offset within this buffer's array of the first element of the buffer

    • hashCode

      public int hashCode()
      Returns the current hash code of this buffer.

      The hash code of a byte buffer depends only upon its remaining elements; that is, upon the elements from position() up to, and including, the element at limit() - 1.

      Because buffer hash codes are content-dependent, it is inadvisable to use buffers as keys in hash maps or similar data structures unless it is known that their contents will not change.

      Overrides:
      hashCode in class Object
      Returns:
      The current hash code of this buffer

    • release

      public boolean release()
      Description copied from interface: WritableMessage
      Perform message specific actions to release resources held by the entity backing this WritableMessage.
      Returns:
      true if successfully released

    • isExternal

      public boolean isExternal()
      Returns true if the message represents an external resource (for example FileTransfer), which is not loaded in memory.
      Returns:
      False, if the message is located in memory (like Buffer).