genericbytebuffer.java

High performance DB query

/*
 * @(#)$Id: GenericByteBuffer.java,v 1.4 2004/07/02 23:59:22 huebsch Exp $
 *
 * Copyright (c) 2001-2004 Regents of the University of California.
 * All rights reserved.
 *
 * This file is distributed under the terms in the attached BERKELEY-LICENSE
 * file. If you do not find these files, copies can be found by writing to:
 * Computer Science Division, Database Group, Universite of California,
 * 617 Soda Hall #1776, Berkeley, CA 94720-1776. Attention: Berkeley License
 *
 * Copyright (c) 2003-2004 Intel Corporation. All rights reserved.
 *
 * This file is distributed under the terms in the attached INTEL-LICENSE file.
 * If you do not find these files, copies can be found by writing to:
 * Intel Research Berkeley, 2150 Shattuck Avenue, Suite 1300,
 * Berkeley, CA, 94704.  Attention:  Intel License Inquiry.
 */


package util.network.serialization;

/**
 * Interface GenericByteBuffer
 *
 */
public interface GenericByteBuffer {

    /**
     * Method compact
     * @return
     */
    public GenericByteBuffer compact();

    /**
     * Method compareTo
     *
     * @param ob
     * @return
     */
    public int compareTo(Object ob);

    /**
     * Method duplicate
     * @return
     */
    public GenericByteBuffer duplicate();

    /**
     * Method equals
     *
     * @param ob
     * @return
     */
    public boolean equals(Object ob);

    /**
     * Method get
     * @return
     */
    public byte get();

    /**
     * Method get
     *
     * @param dst
     * @return
     */
    public GenericByteBuffer get(byte[] dst);

    /**
     * Method get
     *
     * @param dst
     * @param offset
     * @param length
     * @return
     */
    public GenericByteBuffer get(byte[] dst, int offset, int length);

    /**
     * Method get
     *
     * @param index
     * @return
     */
    public byte get(int index);

    /**
     * Method getChar
     * @return
     */
    public char getChar();

    /**
     * Method getChar
     *
     * @param index
     * @return
     */
    public char getChar(int index);

    /**
     * Method getDouble
     * @return
     */
    public double getDouble();

    /**
     * Method getDouble
     *
     * @param index
     * @return
     */
    public double getDouble(int index);

    /**
     * Method getFloat
     * @return
     */
    public float getFloat();

    /**
     * Method getFloat
     *
     * @param index
     * @return
     */
    public float getFloat(int index);

    /**
     * Method getInt
     * @return
     */
    public int getInt();

    /**
     * Method getInt
     *
     * @param index
     * @return
     */
    public int getInt(int index);

    /**
     * Method getLong
     * @return
     */
    public long getLong();

    /**
     * Method getLong
     *
     * @param index
     * @return
     */
    public long getLong(int index);

    /**
     * Method getShort
     * @return
     */
    public short getShort();

    /**
     * Method getShort
     *
     * @param index
     * @return
     */
    public short getShort(int index);

    /**
     * Method hashCode
     * @return
     */
    public int hashCode();

    /**
     * Method isDirect
     * @return
     */
    public boolean isDirect();

    /**
     * Method put
     *
     * @param b
     * @return
     */
    public GenericByteBuffer put(byte b);

    /**
     * Method put
     *
     * @param src
     * @return
     */
    public GenericByteBuffer put(byte[] src);

    /**
     * Method put
     *
     * @param src
     * @param offset
     * @param length
     * @return
     */
    public GenericByteBuffer put(byte[] src, int offset, int length);

    /**
     * Method put
     *
     * @param src
     * @return
     */
    public GenericByteBuffer put(GenericByteBuffer src);

    /**
     * Method put
     *
     * @param index
     * @param b
     * @return
     */
    public GenericByteBuffer put(int index, byte b);

    /**
     * Method putChar
     *
     * @param value
     * @return
     */
    public GenericByteBuffer putChar(char value);

    /**
     * Method putChar
     *
     * @param index
     * @param value
     * @return
     */
    public GenericByteBuffer putChar(int index, char value);

    /**
     * Method putDouble
     *
     * @param value
     * @return
     */
    public GenericByteBuffer putDouble(double value);

    /**
     * Method putDouble
     *
     * @param index
     * @param value
     * @return
     */
    public GenericByteBuffer putDouble(int index, double value);

    /**
     * Method putFloat
     *
     * @param value
     * @return
     */
    public GenericByteBuffer putFloat(float value);

    /**
     * Method putFloat
     *
     * @param index
     * @param value
     * @return
     */
    public GenericByteBuffer putFloat(int index, float value);

    /**
     * Method putInt
     *
     * @param value
     * @return
     */
    public GenericByteBuffer putInt(int value);

    /**
     * Method putInt
     *
     * @param index
     * @param value
     * @return
     */
    public GenericByteBuffer putInt(int index, int value);

    /**
     * Method putLong
     *
     * @param value
     * @return
     */
    public GenericByteBuffer putLong(long value);

    /**
     * Method putLong
     *
     * @param index
     * @param value
     * @return
     */
    public GenericByteBuffer putLong(int index, long value);

    /**
     * Method putShort
     *
     * @param value
     * @return
     */
    public GenericByteBuffer putShort(short value);

    /**
     * Method putShort
     *
     * @param index
     * @param value
     * @return
     */
    public GenericByteBuffer putShort(int index, short value);

    /**
     * Method slice
     * @return
     */
    public GenericByteBuffer slice();

    /**
     * Method isReadOnly
     * @return
     */
    public boolean isReadOnly();

    /**
     * Method capacity
     * @return
     */
    public int capacity();

    /**
     * Method limit
     * @return
     */
    public int limit();

    /**
     * Method limit
     *
     * @param newLimit
     * @return
     */
    public GenericByteBuffer limit(int newLimit);

    /**
     * Method position
     * @return
     */
    public int position();

    /**
     * Method position
     *
     * @param newPosition
     * @return
     */
    public GenericByteBuffer position(int newPosition);
}