Package org.apache.qpid.protonj2.buffer.impl

Class ProtonByteArrayBufferAllocator

java.lang.Object
org.apache.qpid.protonj2.buffer.impl.ProtonByteArrayBufferAllocator
All Implemented Interfaces:
AutoCloseable, ProtonBufferAllocator
public final class ProtonByteArrayBufferAllocator extends Object implements ProtonBufferAllocator
A Proton built in byte array based buffer allocator

  • Constructor Summary

    Constructors
    Constructor
    Description
    ProtonByteArrayBufferAllocator()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    ProtonBuffer
    allocate()
    Create a new ProtonBuffer instance with default initial capacity.
    ProtonBuffer
    allocate(int initialCapacity)
    Create a new ProtonBuffer instance with the given initial capacity and the implicit growth limit should be that of the underlying buffer implementations maximum capacity limit.
    ProtonBuffer
    allocateHeapBuffer()
    Create a new ProtonBuffer instance with default initial capacity.
    ProtonBuffer
    allocateHeapBuffer(int initialCapacity)
    Create a new ProtonBuffer instance with the given initial capacity and the implicit growth limit should be that of the underlying buffer implementations maximum capacity limit.
    static final ProtonBufferAllocator
    allocator()
     
    void
    close()
     
    ProtonCompositeBuffer
    composite()
    Creates a new composite buffer instance that uses this allocator to create new backing space when the buffer writes exceed capacity or the ensure writable space API is used.
    ProtonCompositeBuffer
    composite(ProtonBuffer buffer)
    Creates a new composite buffer instance that uses this allocator to create new backing space when the buffer writes exceed capacity or the ensure writable space API is used.
    ProtonCompositeBuffer
    composite(ProtonBuffer[] buffers)
    Creates a new composite buffer instance that uses this allocator to create new backing space when the buffer writes exceed capacity or the ensure writable space API is used.
    ProtonBuffer
    copy(byte[] array, int offset, int length)
    Create a new ProtonBuffer that copies the given byte array using the provided offset and length values to confine the view of that array.
    ProtonBuffer
    outputBuffer(int initialCapacity)
    Create a new output ProtonBuffer instance with the given initial capacity and the implicit growth capacity should be that of the underlying buffer implementations limit.
    ProtonBuffer
    wrap(byte[] array, int offset, int length)
    Shallow copy of the given array segment used when the caller knows that they will not share the bytes wrapped with any other application code.

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface org.apache.qpid.protonj2.buffer.ProtonBufferAllocator

    copy

  • Constructor Details

    • ProtonByteArrayBufferAllocator

      public ProtonByteArrayBufferAllocator()

  • Method Details

    • close

      public void close()
      Specified by:
      close in interface AutoCloseable
      Specified by:
      close in interface ProtonBufferAllocator

    • allocator

      public static final ProtonBufferAllocator allocator()

    • outputBuffer

      public ProtonBuffer outputBuffer(int initialCapacity)
      Description copied from interface: ProtonBufferAllocator
      Create a new output ProtonBuffer instance with the given initial capacity and the implicit growth capacity should be that of the underlying buffer implementations limit. The buffer implementation should support growing the buffer on an as needed basis to allow writes without the user needing to code extra capacity and buffer reallocation checks.

      The returned buffer will be used for frame output from the Proton engine and can be a pooled buffer which the IO handler will then need to release once the buffer has been written.

      Specified by:
      outputBuffer in interface ProtonBufferAllocator
      Parameters:
      initialCapacity - The initial capacity to use when creating the new ProtonBuffer.
      Returns:
      a new ProtonBuffer instance with the given initial capacity.

    • allocate

      public ProtonBuffer allocate()
      Description copied from interface: ProtonBufferAllocator
      Create a new ProtonBuffer instance with default initial capacity. The buffer implementation should support growing the buffer on an as needed basis to allow writes without the user needing to code extra capacity and buffer reallocation checks.

      Proton buffers are closable resources and their life-span requires that they be closed upon reaching their determined end of life.

      Specified by:
      allocate in interface ProtonBufferAllocator
      Returns:
      a new ProtonBuffer instance with default initial capacity.

    • allocate

      public ProtonBuffer allocate(int initialCapacity)
      Description copied from interface: ProtonBufferAllocator
      Create a new ProtonBuffer instance with the given initial capacity and the implicit growth limit should be that of the underlying buffer implementations maximum capacity limit.

      Proton buffers are closable resources and their life-span requires that they be closed upon reaching their determined end of life.

      Specified by:
      allocate in interface ProtonBufferAllocator
      Parameters:
      initialCapacity - The initial capacity to use when creating the new ProtonBuffer.
      Returns:
      a new ProtonBuffer instance with the given initial capacity.

    • allocateHeapBuffer

      public ProtonBuffer allocateHeapBuffer()
      Description copied from interface: ProtonBufferAllocator
      Create a new ProtonBuffer instance with default initial capacity. The buffer implementation should support growing the buffer on an as needed basis to allow writes without the user needing to code extra capacity and buffer reallocation checks. The buffer allocated must be a heap buffer for cases where the buffered resource may not be easily closed and must revert to GC reclaim semantics.

      Proton buffers are closable resources and their life-span requires that they be closed upon reaching their determined end of life.

      Specified by:
      allocateHeapBuffer in interface ProtonBufferAllocator
      Returns:
      a new ProtonBuffer instance with default initial capacity.

    • allocateHeapBuffer

      public ProtonBuffer allocateHeapBuffer(int initialCapacity)
      Description copied from interface: ProtonBufferAllocator
      Create a new ProtonBuffer instance with the given initial capacity and the implicit growth limit should be that of the underlying buffer implementations maximum capacity limit. The buffer allocated must be a heap buffer for cases where the buffered resource may not be easily closed and must revert to GC reclaim semantics.

      Proton buffers are closable resources and their life-span requires that they be closed upon reaching their determined end of life.

      Specified by:
      allocateHeapBuffer in interface ProtonBufferAllocator
      Parameters:
      initialCapacity - The initial capacity to use when creating the new ProtonBuffer.
      Returns:
      a new ProtonBuffer instance with the given initial capacity.

    • copy

      public ProtonBuffer copy(byte[] array, int offset, int length)
      Description copied from interface: ProtonBufferAllocator
      Create a new ProtonBuffer that copies the given byte array using the provided offset and length values to confine the view of that array.

      The initial capacity of the buffer should be that of the length of the wrapped array. The returned buffer can be expanded using the normal write or expand methods. The write offset of the returned buffer will be set to the capacity.

      Changes to the input buffer after calling this method will not affect the contents of the returned buffer copy.

      Specified by:
      copy in interface ProtonBufferAllocator
      Parameters:
      array - the byte array to copy.
      offset - the offset into the array where the view begins.
      length - the number of bytes in the array to expose
      Returns:
      a new ProtonBuffer that is a copy of the given array.

    • wrap

      public ProtonBuffer wrap(byte[] array, int offset, int length)
      Shallow copy of the given array segment used when the caller knows that they will not share the bytes wrapped with any other application code.
      Parameters:
      array - The array that should be wrapped
      offset - The offset into the array where the wrapper starts
      length - The number of bytes that will be represented in the span.
      Returns:
      A ProtonBuffer that wraps the given array bytes.

    • composite

      public ProtonCompositeBuffer composite()
      Description copied from interface: ProtonBufferAllocator
      Creates a new composite buffer instance that uses this allocator to create new backing space when the buffer writes exceed capacity or the ensure writable space API is used. The created buffer will be empty and can be expanded with the normal buffer API or extended with the addition of buffers.
      Specified by:
      composite in interface ProtonBufferAllocator
      Returns:
      a new empty composite buffer instance.

    • composite

      public ProtonCompositeBuffer composite(ProtonBuffer buffer)
      Description copied from interface: ProtonBufferAllocator
      Creates a new composite buffer instance that uses this allocator to create new backing space when the buffer writes exceed capacity or the ensure writable space API is used. The created buffer will be composed of the given sequence of buffers.
      Specified by:
      composite in interface ProtonBufferAllocator
      Parameters:
      buffer - the buffers to compose
      Returns:
      a new composite buffer instance.

    • composite

      public ProtonCompositeBuffer composite(ProtonBuffer[] buffers)
      Description copied from interface: ProtonBufferAllocator
      Creates a new composite buffer instance that uses this allocator to create new backing space when the buffer writes exceed capacity or the ensure writable space API is used. The created buffer will be composed of the given sequence of buffers.
      Specified by:
      composite in interface ProtonBufferAllocator
      Parameters:
      buffers - the array of buffers to compose
      Returns:
      a new composite buffer instance.