com.amazon.ion.impl.bin.utf8.PoolableByteBuffer Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of ion-java Show documentation

A Java implementation of the Amazon Ion data notation.

There is a newer version: 1.11.9

package com.amazon.ion.impl.bin.utf8;

import java.nio.ByteBuffer;

/**
 * Holds a reusable {@link ByteBuffer}. Instances of this class are reusable but are NOT threadsafe.
 *
 * Instances are vended by {@link ByteBufferPool#getOrCreate()}.
 *
 * Users are expected to call {@link #close()} when the decoder is no longer needed.
 */
public class PoolableByteBuffer extends Poolable {

    static final int BUFFER_SIZE_IN_BYTES = 4 * 1024;

    // The reusable buffer.
    private final ByteBuffer buffer;

    /**
     * @param pool the pool to which the object will be returned upon {@link #close()}.
     */
    PoolableByteBuffer(Pool pool) {
        super(pool);
        buffer = ByteBuffer.allocate(BUFFER_SIZE_IN_BYTES);
    }

    /**
     * @return the buffer.
     */
    public ByteBuffer getBuffer() {
        return buffer;
    }
}