ss: Introduce a safe byte buffer wrapper for use by custom state values

[deliverable/tracecompass.git] / statesystem / org.eclipse.tracecompass.statesystem.core / src / org / eclipse / tracecompass / internal / provisional / statesystem / core / statevalue / ISafeByteBufferWriter.java

/*******************************************************************************
 * Copyright (c) 2016 École Polytechnique de Montréal
 *
 * All rights reserved. This program and the accompanying materials are
 * made available under the terms of the Eclipse Public License v1.0 which
 * accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *******************************************************************************/

package org.eclipse.tracecompass.internal.provisional.statesystem.core.statevalue;

/**
 * Interface for a safe ByteBuffer for writing purposes. This interface allows
 * only to write data from a buffer, no other operation is allowed on it. The
 * implementation needs to make sure that the buffer does not write over the
 * limits of the buffer.
 *
 * @author Geneviève Bastien
 */
public interface ISafeByteBufferWriter {

    /**
     * Writes a byte at the buffer's current position
     *
     * @param value
     *            The byte to write
     */
    void put(byte value);

    /**
     * Transfers the bytes from the src array in the buffer at the current
     * position
     *
     * @param src
     *            the byte array to write
     */
    void put(byte[] src);

    /**
     * Writes a char at the buffer's current position
     *
     * @param value
     *            The char to write
     */
    void putChar(char value);

    /**
     * Writes a double at the buffer's current position
     *
     * @param value
     *            The double to write
     */
    void putDouble(double value);

    /**
     * Writes a float at the buffer's current position
     *
     * @param value
     *            The float to write
     */
    void putFloat(float value);

    /**
     * Writes an int at the buffer's current position
     *
     * @param value
     *            The int to write
     */
    void putInt(int value);

    /**
     * Writes a long at the buffer's current position
     *
     * @param value
     *            The long to write
     */
    void putLong(long value);

    /**
     * Writes a short at the buffer's current position
     *
     * @param value
     *            The short to write
     */
    void putShort(short value);

    /**
     * Writes a string value in the byte buffer. The implementation can decide
     * what format it will use. They can also have a maximum size, in which case
     * string should be truncated if they are larger than that.
     *
     * @param value
     *            The String value to write to the buffer
     */
    void putString(String value);

}