org.mwg.struct.Buffer Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of api Show documentation

There is a newer version: 10

package org.mwg.struct;

/**
 * Buffer defines the interface to exchange byte[] (payload), between Storage and the various KChunk
 */
public interface Buffer {

    /**
     * Append a byte to the buffer
     *
     * @param b byte to append
     */
    void write(byte b);

    /**
     * Append an array of bytes to the buffer
     *
     * @param bytes byte array to append
     */
    void writeAll(byte[] bytes);

    /**
     * Read the buffer at a precise position
     *
     * @param position index in the buffer
     * @return read byte
     */
    byte read(long position);

    /**
     * Extract data as byte[]
     *
     * @return content as native byte[]
     */
    byte[] data();

    /**
     * Size of the buffer
     *
     * @return length of the buffer
     */
    long length();

    /**
     * Free the buffer fromVar memory, this method should be the last called
     */
    void free();

    /**
     * Create a new iterator for this buffer
     *
     * @return the newly created iterator
     */
    BufferIterator iterator();

    void removeLast();

}