POPBuffer (POPJava 1.5 API)

java.lang.Object
- ch.icosys.popjava.core.buffer.POPBuffer

Direct Known Subclasses:

BufferPlugin, BufferRaw
```
public abstract class POPBuffer
extends java.lang.Object
```
This abstract class defined all the required methods to implement a buffer. The buffer is responsible to encode and decode the data before sending them or receiving them over the network. Buffer usage: Put the data to be serialized into the buffer and take it out again in the same order. A special note for Arrays. To put in an array, the putXXArray functions can be used. But to take them out again, first the array length needs to be retrieved with getInt();
Example:
```
 
 buffer.putByteArray(byteArray);
 
 byte [] deserialized = buffer.getByteArray(buffer.getInt());
 
 
```
Note that null arrays can be stored in the buffer, but will be transformed to arrays of length 0 during deserializiation.

Field Summary

Fields
Modifier and Type Field and Description

protected MessageHeader messageHeader
Each buffer send must contains a message header

protected int size
Size of the buffer in byte

Fields
Modifier and Type	Field and Description
`protected MessageHeader`	`messageHeader` Each buffer send must contains a message header
`protected int`	`size` Size of the buffer in byte

Constructor Summary

Constructors
Constructor and Description

POPBuffer()
Default constructor

POPBuffer(MessageHeader messageHeader)
Constructor with given values

Constructors
Constructor and Description
`POPBuffer()` Default constructor
`POPBuffer(MessageHeader messageHeader)` Constructor with given values

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`abstract byte[]`	`array()`
`static void`	`checkAndThrow(int systemErrorCode, POPBuffer buffer)` Check error code and throw the right exception
`void`	`deserializeReferenceObject(java.lang.Class<?> type, java.lang.Object obj)` Retrieve an object reference from the buffer
`abstract MessageHeader`	`extractHeader()` Retrieve the message header from the buffer
`abstract byte`	`get()` Retrieve a byte from the buffer
`<T> T`	`getArray(java.lang.Class<T> arrayType)` Retrieve an array from the buffer
`abstract boolean`	`getBoolean()` Retrieve a boolean from the buffer
`abstract boolean[]`	`getBooleanArray(int length)` Retrieve a boolean array from the buffer
`abstract byte[]`	`getByteArray(int length)` Retrieve a byte array from the buffer
`abstract char`	`getChar()` Retrieve a char from the buffer
`abstract char[]`	`getCharArray(int length)` Retrieve a char array from the buffer
`abstract double`	`getDouble()` Retrieve a double from the buffer
`abstract double[]`	`getDoubleArray(int length)` Retrieve a double array from the buffer
`abstract float`	`getFloat()` Retrieve a float from the buffer
`abstract float[]`	`getFloatArray(int length)` Retrieve a float array from the buffer
`MessageHeader`	`getHeader()` Get the message header associated with this buffer
`abstract int`	`getInt()` Retrieve a int from the buffer
`abstract int[]`	`getIntArray(int length)` Retrieve a int array from the buffer
`abstract long`	`getLong()` Retrieve a long from the buffer
`abstract long[]`	`getLongArray(int length)` Retrieve a long array from the buffer
`abstract short`	`getShort()` Retrieve a short from the buffer
`abstract short[]`	`getShortArray(int length)` Retrieve a short array from the buffer
`abstract java.lang.String`	`getString()` Retrieve a string from the buffer
`abstract int`	`getTranslatedInteger(byte[] value)` Get a integer value of the byte array
`java.lang.Object`	`getValue(java.lang.Class<?> c)` Retrieve an object from the buffer
`java.lang.Object`	`getValue(Combox sourceCombox, java.lang.Class<?> c)` Retrieve an object from the buffer
`abstract int`	`packMessageHeader()` Pack the message header into the buffer
`abstract void`	`put(byte value)` Insert a byte in the buffer
`abstract void`	`put(byte[] data)` Insert a byte array into the buffer
`abstract void`	`put(byte[] data, int offset, int length)` Insert a byte array into a specific place in the buffer
`void`	`putArray(java.lang.Object o)` Insert an array into the buffer
`abstract void`	`putBoolean(boolean value)` Insert a boolean in the buffer
`abstract void`	`putBooleanArray(boolean[] value)` Insert a boolean array into the buffer
`abstract void`	`putByteArray(byte[] value)` Insert a byte array into the buffer
`abstract void`	`putChar(char value)` Insert a char into the buffer
`abstract void`	`putCharArray(char[] value)` Insert a char array into the buffer
`abstract void`	`putDouble(double value)` Insert a double value into the buffer
`abstract void`	`putDoubleArray(double[] value)` Insert a double array into the buffer
`abstract void`	`putFloat(float value)` Insert a float value into the buffer
`abstract void`	`putFloatArray(float[] value)` Insert a float array into the buffer
`abstract void`	`putInt(int value)` Insert a int into the buffer
`abstract void`	`putIntArray(int[] value)` Insert a int array into the buffer
`abstract void`	`putLong(long value)` Insert a long into the buffer
`abstract void`	`putLongArray(long[] value)` Insert a long array into the buffer
`abstract void`	`putShort(short value)` Insert a short into the buffer
`abstract void`	`putShortArray(short[] value)` Insert a short array into the buffer
`abstract void`	`putString(java.lang.String value)` Insert a string into the buffer
`void`	`putValue(java.lang.Object o, java.lang.Class<?> c)` Insert an object into the buffer
`abstract void`	`reset()` Erase the buffer and set the pointer to the beginning
`abstract void`	`resetToReceive()` Reset the buffer before reception of a new message
`void`	`serializeReferenceObject(java.lang.Class<?> type, java.lang.Object obj)` Insert an object reference into the buffer
`void`	`setHeader(MessageHeader messageHeader)` Associate a message header with this buffer
`int`	`size()` Get the current size of the buffer
`java.lang.String`	`toCharString()` Return an empty string
`java.lang.String`	`toIntString()` Return an empty string

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - messageHeader
```
protected MessageHeader messageHeader
```
    Each buffer send must contains a message header
  - size
```
protected int size
```
    Size of the buffer in byte
- Constructor Detail
  - POPBuffer
```
public POPBuffer()
```
    Default constructor
  - POPBuffer
```
public POPBuffer(MessageHeader messageHeader)
```
    Constructor with given values
    
    Parameters:
    
    messageHeader - Message header to be associated with this buffer
- Method Detail
  - reset
```
public abstract void reset()
```
    Erase the buffer and set the pointer to the beginning
  - put
```
public abstract void put(byte value)
```
    Insert a byte in the buffer
    
    Parameters:
    
    value - byte value to insert
  - putBoolean
```
public abstract void putBoolean(boolean value)
```
    Insert a boolean in the buffer
    
    Parameters:
    
    value - boolean value to insert
  - putChar
```
public abstract void putChar(char value)
```
    Insert a char into the buffer
    
    Parameters:
    
    value - char value to insert
  - putInt
```
public abstract void putInt(int value)
```
    Insert a int into the buffer
    
    Parameters:
    
    value - int value to insert
  - putLong
```
public abstract void putLong(long value)
```
    Insert a long into the buffer
    
    Parameters:
    
    value - long value to insert
  - putShort
```
public abstract void putShort(short value)
```
    Insert a short into the buffer
    
    Parameters:
    
    value - short value to insert
  - putFloat
```
public abstract void putFloat(float value)
```
    Insert a float value into the buffer
    
    Parameters:
    
    value - float value to insert
  - putDouble
```
public abstract void putDouble(double value)
```
    Insert a double value into the buffer
    
    Parameters:
    
    value - double value to insert
  - put
```
public abstract void put(byte[] data)
```
    Insert a byte array into the buffer
    
    Parameters:
    
    data - byte array to insert
  - put
```
public abstract void put(byte[] data,
                         int offset,
                         int length)
```
    Insert a byte array into a specific place in the buffer
    
    Parameters:
    
    data - byte array to insert
    
    offset - offset for insertion
    
    length - length of the array
  - putByteArray
```
public abstract void putByteArray(byte[] value)
```
    Insert a byte array into the buffer
    
    Parameters:
    
    value - byte array to insert
  - putCharArray
```
public abstract void putCharArray(char[] value)
```
    Insert a char array into the buffer
    
    Parameters:
    
    value - char array to insert
  - putBooleanArray
```
public abstract void putBooleanArray(boolean[] value)
```
    Insert a boolean array into the buffer
    
    Parameters:
    
    value - boolean array to insert
  - putIntArray
```
public abstract void putIntArray(int[] value)
```
    Insert a int array into the buffer
    
    Parameters:
    
    value - int array to insert
  - putShortArray
```
public abstract void putShortArray(short[] value)
```
    Insert a short array into the buffer
    
    Parameters:
    
    value - short array to insert
  - putLongArray
```
public abstract void putLongArray(long[] value)
```
    Insert a long array into the buffer
    
    Parameters:
    
    value - long array to insert
  - putFloatArray
```
public abstract void putFloatArray(float[] value)
```
    Insert a float array into the buffer
    
    Parameters:
    
    value - float array to insert
  - putDoubleArray
```
public abstract void putDoubleArray(double[] value)
```
    Insert a double array into the buffer
    
    Parameters:
    
    value - double array to insert
  - getByteArray
```
public abstract byte[] getByteArray(int length)
```
    Retrieve a byte array from the buffer
    
    Parameters:
    
    length - length of the array to retrieve
    
    Returns:
    
    byte array retrieved in the buffer
  - getCharArray
```
public abstract char[] getCharArray(int length)
```
    Retrieve a char array from the buffer
    
    Parameters:
    
    length - length of the array to retrieve
    
    Returns:
    
    char array retrieved in the buffer
  - getBooleanArray
```
public abstract boolean[] getBooleanArray(int length)
```
    Retrieve a boolean array from the buffer
    
    Parameters:
    
    length - length of the array to retrieve
    
    Returns:
    
    boolean array retrieved in the buffer
  - getIntArray
```
public abstract int[] getIntArray(int length)
```
    Retrieve a int array from the buffer
    
    Parameters:
    
    length - length of the array to retrieve
    
    Returns:
    
    int array retrieved in the buffer
  - getLongArray
```
public abstract long[] getLongArray(int length)
```
    Retrieve a long array from the buffer
    
    Parameters:
    
    length - length of the array to retrieve
    
    Returns:
    
    long array retrieved in the buffer
  - getShortArray
```
public abstract short[] getShortArray(int length)
```
    Retrieve a short array from the buffer
    
    Parameters:
    
    length - length of the array to retrieve
    
    Returns:
    
    short array retrieved in the buffer
  - getFloatArray
```
public abstract float[] getFloatArray(int length)
```
    Retrieve a float array from the buffer
    
    Parameters:
    
    length - length of the array to retrieve
    
    Returns:
    
    float array retrieved in the buffer
  - getDoubleArray
```
public abstract double[] getDoubleArray(int length)
```
    Retrieve a double array from the buffer
    
    Parameters:
    
    length - length of the array to retrieve
    
    Returns:
    
    double array retrieved in the buffer
  - putString
```
public abstract void putString(java.lang.String value)
```
    Insert a string into the buffer
    
    Parameters:
    
    value - string value to insert
  - get
```
public abstract byte get()
```
    Retrieve a byte from the buffer
    
    Returns:
    
    byte retrieved in the buffer
  - getBoolean
```
public abstract boolean getBoolean()
```
    Retrieve a boolean from the buffer
    
    Returns:
    
    boolean retrieved in the buffer
  - getChar
```
public abstract char getChar()
```
    Retrieve a char from the buffer
    
    Returns:
    
    char retrieved in the buffer
  - getInt
```
public abstract int getInt()
```
    Retrieve a int from the buffer
    
    Returns:
    
    int retrieved in the buffer
  - getLong
```
public abstract long getLong()
```
    Retrieve a long from the buffer
    
    Returns:
    
    long retrieved in the buffer
  - getShort
```
public abstract short getShort()
```
    Retrieve a short from the buffer
    
    Returns:
    
    short retrieved in the buffer
  - getFloat
```
public abstract float getFloat()
```
    Retrieve a float from the buffer
    
    Returns:
    
    float retrieved in the buffer
  - getDouble
```
public abstract double getDouble()
```
    Retrieve a double from the buffer
    
    Returns:
    
    double retrieved in the buffer
  - getString
```
public abstract java.lang.String getString()
```
    Retrieve a string from the buffer
    
    Returns:
    
    string retrieved in the buffer
  - array
```
public abstract byte[] array()
```
  - getTranslatedInteger
```
public abstract int getTranslatedInteger(byte[] value)
```
    Get a integer value of the byte array
    
    Parameters:
    
    value - The byte array to translate
    
    Returns:
    
    The integer
  - extractHeader
```
public abstract MessageHeader extractHeader()
```
    Retrieve the message header from the buffer
    
    Returns:
    
    message header retrieved in the buffer
  - resetToReceive
```
public abstract void resetToReceive()
```
    Reset the buffer before reception of a new message
  - packMessageHeader
```
public abstract int packMessageHeader()
```
    Pack the message header into the buffer
    
    Returns:
    
    number of byte used for the message header
  - setHeader
```
public void setHeader(MessageHeader messageHeader)
```
    Associate a message header with this buffer
    
    Parameters:
    
    messageHeader - Message header to be associated with this buffer
  - getHeader
```
public MessageHeader getHeader()
```
    Get the message header associated with this buffer
    
    Returns:
    
    Message header associated with the buffer
  - size
```
public int size()
```
    Get the current size of the buffer
    
    Returns:
    
    current size of the buffer as a int value
  - getValue
```
public java.lang.Object getValue(java.lang.Class<?> c)
                          throws POPException
```
    Retrieve an object from the buffer
    
    Parameters:
    
    c - Class of the object to retrieve
    
    Returns:
    
    Object retrieved in the buffer
    
    Throws:
    
    POPException - thrown if the deserialization process is not going well
  - getValue
```
public java.lang.Object getValue(Combox sourceCombox,
                                 java.lang.Class<?> c)
                          throws POPException
```
    Retrieve an object from the buffer
    
    Parameters:
    
    c - Class of the object to retrieve
    
    Returns:
    
    Object retrieved in the buffer
    
    Throws:
    
    POPException - thrown if the deserialization process is not going well
  - putValue
```
public void putValue(java.lang.Object o,
                     java.lang.Class<?> c)
              throws POPException
```
    Insert an object into the buffer
    
    Parameters:
    
    o - Object to be inserted
    
    c - Class of the object to be inserted
    
    Throws:
    
    POPException - thrown if the serialization process is not going well
  - putArray
```
public void putArray(java.lang.Object o)
              throws POPException
```
    Insert an array into the buffer
    
    Parameters:
    
    o - Array to be inserted
    
    Throws:
    
    POPException - thrown if the serialization process is not going well
  - getArray
```
public <T> T getArray(java.lang.Class<T> arrayType)
               throws POPException
```
    Retrieve an array from the buffer
    
    Type Parameters:
    
    T - the type of return
    
    Parameters:
    
    arrayType - Class of the array to retrieve
    
    Returns:
    
    Array retrieved in the buffer
    
    Throws:
    
    POPException - thrown if the serialization process is not going well
  - serializeReferenceObject
```
public void serializeReferenceObject(java.lang.Class<?> type,
                                     java.lang.Object obj)
                              throws POPException
```
    Insert an object reference into the buffer
    
    Parameters:
    
    type - Class of the object
    
    obj - Object to be inserted
    
    Throws:
    
    POPException - thrown if the serialization process is not going well
  - deserializeReferenceObject
```
public void deserializeReferenceObject(java.lang.Class<?> type,
                                       java.lang.Object obj)
                                throws POPException
```
    Retrieve an object reference from the buffer
    
    Parameters:
    
    type - Class of the object
    
    obj - Object to be retrieved
    
    Throws:
    
    POPException - thrown if the deserialization process is not going well
  - checkAndThrow
```
public static void checkAndThrow(int systemErrorCode,
                                 POPBuffer buffer)
                          throws POPException
```
    Check error code and throw the right exception
    
    Parameters:
    
    systemErrorCode - Code of the error
    
    buffer - Buffer from which retrieve the additional informations
    
    Throws:
    
    POPException - thrown if any problem occurred
  - toIntString
```
public java.lang.String toIntString()
```
    Return an empty string
    
    Returns:
    
    empty string
  - toCharString
```
public java.lang.String toCharString()
```
    Return an empty string
    
    Returns:
    
    empty string

Class POPBuffer

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

messageHeader

size

Constructor Detail

POPBuffer

POPBuffer

Method Detail

reset

put

putBoolean

putChar

putInt

putLong

putShort

putFloat

putDouble

put

put

putByteArray

putCharArray

putBooleanArray

putIntArray

putShortArray

putLongArray

putFloatArray

putDoubleArray

getByteArray

getCharArray

getBooleanArray

getIntArray

getLongArray

getShortArray

getFloatArray

getDoubleArray

putString

get

getBoolean

getChar

getInt

getLong

getShort

getFloat

getDouble

getString

array

getTranslatedInteger

extractHeader

resetToReceive

packMessageHeader

setHeader

getHeader

size

getValue

getValue

putValue

putArray

getArray

serializeReferenceObject

deserializeReferenceObject

checkAndThrow

toIntString

toCharString