BufferPlugin (POPJava 1.5 API)

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

```
public class BufferPlugin
extends POPBuffer
```
This class defined the interface for each new buffer plug-in

Field Summary
- Fields inherited from class ch.icosys.popjava.core.buffer.POPBuffer
  messageHeader, size

Constructor Summary

Constructors
Constructor and Description

BufferPlugin()

Constructors
Constructor and Description
`BufferPlugin()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`byte[]`	`array()`
`MessageHeader`	`extractHeader()` Retrieve the message header from the buffer
`byte`	`get()` Retrieve a byte from the buffer
`boolean`	`getBoolean()` Retrieve a boolean from the buffer
`boolean[]`	`getBooleanArray(int length)` Retrieve a boolean array from the buffer
`byte[]`	`getByteArray(int length)` Retrieve a byte array from the buffer
`char`	`getChar()` Retrieve a char from the buffer
`char[]`	`getCharArray(int length)` Retrieve a char array from the buffer
`double`	`getDouble()` Retrieve a double from the buffer
`double[]`	`getDoubleArray(int length)` Retrieve a double array from the buffer
`float`	`getFloat()` Retrieve a float from the buffer
`float[]`	`getFloatArray(int length)` Retrieve a float array from the buffer
`int`	`getInt()` Retrieve a int from the buffer
`int[]`	`getIntArray(int length)` Retrieve a int array from the buffer
`long`	`getLong()` Retrieve a long from the buffer
`long[]`	`getLongArray(int length)` Retrieve a long array from the buffer
`short`	`getShort()` Retrieve a short from the buffer
`short[]`	`getShortArray(int length)` Retrieve a short array from the buffer
`java.lang.String`	`getString()` Retrieve a string from the buffer
`int`	`getTranslatedInteger(byte[] value)` Get a integer value of the byte array
`int`	`packMessageHeader()` Pack the message header into the buffer
`void`	`put(byte value)` Insert a byte in the buffer
`void`	`put(byte[] data)` Insert a byte array into the buffer
`void`	`put(byte[] data, int offset, int length)` Insert a byte array into a specific place in the buffer
`void`	`putBoolean(boolean value)` Insert a boolean in the buffer
`void`	`putBooleanArray(boolean[] value)` Insert a boolean array into the buffer
`void`	`putByteArray(byte[] value)` Insert a byte array into the buffer
`void`	`putChar(char value)` Insert a char into the buffer
`void`	`putCharArray(char[] value)` Insert a char array into the buffer
`void`	`putDouble(double value)` Insert a double value into the buffer
`void`	`putDoubleArray(double[] value)` Insert a double array into the buffer
`void`	`putFloat(float value)` Insert a float value into the buffer
`void`	`putFloatArray(float[] value)` Insert a float array into the buffer
`void`	`putInt(int value)` Insert a int into the buffer
`void`	`putIntArray(int[] value)` Insert a int array into the buffer
`void`	`putLong(long value)` Insert a long into the buffer
`void`	`putLongArray(long[] value)` Insert a long array into the buffer
`void`	`putShort(short value)` Insert a short into the buffer
`void`	`putShortArray(short[] value)` Insert a short array into the buffer
`void`	`putString(java.lang.String value)` Insert a string into the buffer
`void`	`reset()` Erase the buffer and set the pointer to the beginning
`void`	`resetToReceive()` Reset the buffer before reception of a new message

Methods inherited from class ch.icosys.popjava.core.buffer.POPBuffer
checkAndThrow, deserializeReferenceObject, getArray, getHeader, getValue, getValue, putArray, putValue, serializeReferenceObject, setHeader, size, toCharString, toIntString

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

- Constructor Detail
  - BufferPlugin
```
public BufferPlugin()
```
- Method Detail
  - array
```
public byte[] array()
```
    Specified by:
    
    array in class POPBuffer
  - extractHeader
```
public MessageHeader extractHeader()
```
    Description copied from class: POPBuffer
    
    Retrieve the message header from the buffer
    
    Specified by:
    
    extractHeader in class POPBuffer
    
    Returns:
    
    message header retrieved in the buffer
  - get
```
public byte get()
```
    Description copied from class: POPBuffer
    
    Retrieve a byte from the buffer
    
    Specified by:
    
    get in class POPBuffer
    
    Returns:
    
    byte retrieved in the buffer
  - getBoolean
```
public boolean getBoolean()
```
    Description copied from class: POPBuffer
    
    Retrieve a boolean from the buffer
    
    Specified by:
    
    getBoolean in class POPBuffer
    
    Returns:
    
    boolean retrieved in the buffer
  - getBooleanArray
```
public boolean[] getBooleanArray(int length)
```
    Description copied from class: POPBuffer
    
    Retrieve a boolean array from the buffer
    
    Specified by:
    
    getBooleanArray in class POPBuffer
    
    Parameters:
    
    length - length of the array to retrieve
    
    Returns:
    
    boolean array retrieved in the buffer
  - getByteArray
```
public byte[] getByteArray(int length)
```
    Description copied from class: POPBuffer
    
    Retrieve a byte array from the buffer
    
    Specified by:
    
    getByteArray in class POPBuffer
    
    Parameters:
    
    length - length of the array to retrieve
    
    Returns:
    
    byte array retrieved in the buffer
  - getChar
```
public char getChar()
```
    Description copied from class: POPBuffer
    
    Retrieve a char from the buffer
    
    Specified by:
    
    getChar in class POPBuffer
    
    Returns:
    
    char retrieved in the buffer
  - getDouble
```
public double getDouble()
```
    Description copied from class: POPBuffer
    
    Retrieve a double from the buffer
    
    Specified by:
    
    getDouble in class POPBuffer
    
    Returns:
    
    double retrieved in the buffer
  - getDoubleArray
```
public double[] getDoubleArray(int length)
```
    Description copied from class: POPBuffer
    
    Retrieve a double array from the buffer
    
    Specified by:
    
    getDoubleArray in class POPBuffer
    
    Parameters:
    
    length - length of the array to retrieve
    
    Returns:
    
    double array retrieved in the buffer
  - getFloat
```
public float getFloat()
```
    Description copied from class: POPBuffer
    
    Retrieve a float from the buffer
    
    Specified by:
    
    getFloat in class POPBuffer
    
    Returns:
    
    float retrieved in the buffer
  - getFloatArray
```
public float[] getFloatArray(int length)
```
    Description copied from class: POPBuffer
    
    Retrieve a float array from the buffer
    
    Specified by:
    
    getFloatArray in class POPBuffer
    
    Parameters:
    
    length - length of the array to retrieve
    
    Returns:
    
    float array retrieved in the buffer
  - getInt
```
public int getInt()
```
    Description copied from class: POPBuffer
    
    Retrieve a int from the buffer
    
    Specified by:
    
    getInt in class POPBuffer
    
    Returns:
    
    int retrieved in the buffer
  - getIntArray
```
public int[] getIntArray(int length)
```
    Description copied from class: POPBuffer
    
    Retrieve a int array from the buffer
    
    Specified by:
    
    getIntArray in class POPBuffer
    
    Parameters:
    
    length - length of the array to retrieve
    
    Returns:
    
    int array retrieved in the buffer
  - getLong
```
public long getLong()
```
    Description copied from class: POPBuffer
    
    Retrieve a long from the buffer
    
    Specified by:
    
    getLong in class POPBuffer
    
    Returns:
    
    long retrieved in the buffer
  - getLongArray
```
public long[] getLongArray(int length)
```
    Description copied from class: POPBuffer
    
    Retrieve a long array from the buffer
    
    Specified by:
    
    getLongArray in class POPBuffer
    
    Parameters:
    
    length - length of the array to retrieve
    
    Returns:
    
    long array retrieved in the buffer
  - getString
```
public java.lang.String getString()
```
    Description copied from class: POPBuffer
    
    Retrieve a string from the buffer
    
    Specified by:
    
    getString in class POPBuffer
    
    Returns:
    
    string retrieved in the buffer
  - put
```
public void put(byte value)
```
    Description copied from class: POPBuffer
    
    Insert a byte in the buffer
    
    Specified by:
    
    put in class POPBuffer
    
    Parameters:
    
    value - byte value to insert
  - put
```
public void put(byte[] data)
```
    Description copied from class: POPBuffer
    
    Insert a byte array into the buffer
    
    Specified by:
    
    put in class POPBuffer
    
    Parameters:
    
    data - byte array to insert
  - put
```
public void put(byte[] data,
                int offset,
                int length)
```
    Description copied from class: POPBuffer
    
    Insert a byte array into a specific place in the buffer
    
    Specified by:
    
    put in class POPBuffer
    
    Parameters:
    
    data - byte array to insert
    
    offset - offset for insertion
    
    length - length of the array
  - putBoolean
```
public void putBoolean(boolean value)
```
    Description copied from class: POPBuffer
    
    Insert a boolean in the buffer
    
    Specified by:
    
    putBoolean in class POPBuffer
    
    Parameters:
    
    value - boolean value to insert
  - putBooleanArray
```
public void putBooleanArray(boolean[] value)
```
    Description copied from class: POPBuffer
    
    Insert a boolean array into the buffer
    
    Specified by:
    
    putBooleanArray in class POPBuffer
    
    Parameters:
    
    value - boolean array to insert
  - putByteArray
```
public void putByteArray(byte[] value)
```
    Description copied from class: POPBuffer
    
    Insert a byte array into the buffer
    
    Specified by:
    
    putByteArray in class POPBuffer
    
    Parameters:
    
    value - byte array to insert
  - putChar
```
public void putChar(char value)
```
    Description copied from class: POPBuffer
    
    Insert a char into the buffer
    
    Specified by:
    
    putChar in class POPBuffer
    
    Parameters:
    
    value - char value to insert
  - putDouble
```
public void putDouble(double value)
```
    Description copied from class: POPBuffer
    
    Insert a double value into the buffer
    
    Specified by:
    
    putDouble in class POPBuffer
    
    Parameters:
    
    value - double value to insert
  - putDoubleArray
```
public void putDoubleArray(double[] value)
```
    Description copied from class: POPBuffer
    
    Insert a double array into the buffer
    
    Specified by:
    
    putDoubleArray in class POPBuffer
    
    Parameters:
    
    value - double array to insert
  - putFloat
```
public void putFloat(float value)
```
    Description copied from class: POPBuffer
    
    Insert a float value into the buffer
    
    Specified by:
    
    putFloat in class POPBuffer
    
    Parameters:
    
    value - float value to insert
  - putFloatArray
```
public void putFloatArray(float[] value)
```
    Description copied from class: POPBuffer
    
    Insert a float array into the buffer
    
    Specified by:
    
    putFloatArray in class POPBuffer
    
    Parameters:
    
    value - float array to insert
  - putInt
```
public void putInt(int value)
```
    Description copied from class: POPBuffer
    
    Insert a int into the buffer
    
    Specified by:
    
    putInt in class POPBuffer
    
    Parameters:
    
    value - int value to insert
  - putIntArray
```
public void putIntArray(int[] value)
```
    Description copied from class: POPBuffer
    
    Insert a int array into the buffer
    
    Specified by:
    
    putIntArray in class POPBuffer
    
    Parameters:
    
    value - int array to insert
  - putLong
```
public void putLong(long value)
```
    Description copied from class: POPBuffer
    
    Insert a long into the buffer
    
    Specified by:
    
    putLong in class POPBuffer
    
    Parameters:
    
    value - long value to insert
  - putLongArray
```
public void putLongArray(long[] value)
```
    Description copied from class: POPBuffer
    
    Insert a long array into the buffer
    
    Specified by:
    
    putLongArray in class POPBuffer
    
    Parameters:
    
    value - long array to insert
  - putString
```
public void putString(java.lang.String value)
```
    Description copied from class: POPBuffer
    
    Insert a string into the buffer
    
    Specified by:
    
    putString in class POPBuffer
    
    Parameters:
    
    value - string value to insert
  - reset
```
public void reset()
```
    Description copied from class: POPBuffer
    
    Erase the buffer and set the pointer to the beginning
    
    Specified by:
    
    reset in class POPBuffer
  - resetToReceive
```
public void resetToReceive()
```
    Description copied from class: POPBuffer
    
    Reset the buffer before reception of a new message
    
    Specified by:
    
    resetToReceive in class POPBuffer
  - getTranslatedInteger
```
public int getTranslatedInteger(byte[] value)
```
    Description copied from class: POPBuffer
    
    Get a integer value of the byte array
    
    Specified by:
    
    getTranslatedInteger in class POPBuffer
    
    Parameters:
    
    value - The byte array to translate
    
    Returns:
    
    The integer
  - packMessageHeader
```
public int packMessageHeader()
```
    Description copied from class: POPBuffer
    
    Pack the message header into the buffer
    
    Specified by:
    
    packMessageHeader in class POPBuffer
    
    Returns:
    
    number of byte used for the message header
  - getShort
```
public short getShort()
```
    Description copied from class: POPBuffer
    
    Retrieve a short from the buffer
    
    Specified by:
    
    getShort in class POPBuffer
    
    Returns:
    
    short retrieved in the buffer
  - getShortArray
```
public short[] getShortArray(int length)
```
    Description copied from class: POPBuffer
    
    Retrieve a short array from the buffer
    
    Specified by:
    
    getShortArray in class POPBuffer
    
    Parameters:
    
    length - length of the array to retrieve
    
    Returns:
    
    short array retrieved in the buffer
  - putShort
```
public void putShort(short value)
```
    Description copied from class: POPBuffer
    
    Insert a short into the buffer
    
    Specified by:
    
    putShort in class POPBuffer
    
    Parameters:
    
    value - short value to insert
  - putShortArray
```
public void putShortArray(short[] value)
```
    Description copied from class: POPBuffer
    
    Insert a short array into the buffer
    
    Specified by:
    
    putShortArray in class POPBuffer
    
    Parameters:
    
    value - short array to insert
  - getCharArray
```
public char[] getCharArray(int length)
```
    Description copied from class: POPBuffer
    
    Retrieve a char array from the buffer
    
    Specified by:
    
    getCharArray in class POPBuffer
    
    Parameters:
    
    length - length of the array to retrieve
    
    Returns:
    
    char array retrieved in the buffer
  - putCharArray
```
public void putCharArray(char[] value)
```
    Description copied from class: POPBuffer
    
    Insert a char array into the buffer
    
    Specified by:
    
    putCharArray in class POPBuffer
    
    Parameters:
    
    value - char array to insert

Class BufferPlugin

Field Summary

Fields inherited from class ch.icosys.popjava.core.buffer.POPBuffer

Constructor Summary

Method Summary

Methods inherited from class ch.icosys.popjava.core.buffer.POPBuffer

Methods inherited from class java.lang.Object

Constructor Detail

BufferPlugin

Method Detail

array

extractHeader

get

getBoolean

getBooleanArray

getByteArray

getChar

getDouble

getDoubleArray

getFloat

getFloatArray

getInt

getIntArray

getLong

getLongArray

getString

put

put

put

putBoolean

putBooleanArray

putByteArray

putChar

putDouble

putDoubleArray

putFloat

putFloatArray

putInt

putIntArray

putLong

putLongArray

putString

reset

resetToReceive

getTranslatedInteger

packMessageHeader

getShort

getShortArray

putShort

putShortArray

getCharArray

putCharArray