SafeBuffer (Hazelcast Root 3.12-BETA-1 API)

java.lang.Object
- com.hazelcast.client.impl.protocol.util.SafeBuffer

All Implemented Interfaces:

ClientProtocolBuffer
```
public class SafeBuffer
extends Object
implements ClientProtocolBuffer
```
Implementation of ClientProtocolBuffer that is used by default in clients. There is another unsafe implementation which is configurable . See UnsafeBuffer.

Constructor Summary

Constructors
Constructor and Description

SafeBuffer(byte[] buffer)

Constructors
Constructor and Description
`SafeBuffer(byte[] buffer)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`byte[]`	`byteArray()` Get the underlying byte[] if one exists.
`int`	`capacity()` Get the capacity of the underlying buffer.
`byte`	`getByte(int index)` Get the value at a given index.
`void`	`getBytes(int index, byte[] dst)` Get from the underlying buffer into a supplied byte array.
`void`	`getBytes(int index, byte[] dst, int offset, int length)` Get bytes from the underlying buffer into a supplied byte array.
`int`	`getInt(int index)` Get the value at a given index.
`long`	`getLong(int index)` Get the value at a given index.
`short`	`getShort(int index)` Get the value at a given index.
`String`	`getStringUtf8(int offset, int length)` Get part of String from bytes encoded in UTF-8 format without a length prefix.
`void`	`putByte(int index, byte value)` Put a value to a given index.
`void`	`putBytes(int index, byte[] src)` Put an array of src into the underlying buffer.
`void`	`putBytes(int index, byte[] src, int offset, int length)` Put an array into the underlying buffer.
`void`	`putBytes(int index, ByteBuffer src, int length)`
`void`	`putInt(int index, int value)` Put a value at a given index.
`void`	`putLong(int index, long value)` Put a value at a given index.
`void`	`putShort(int index, short value)` Put a value to a given index.
`int`	`putStringUtf8(int index, String value)` Encode a String as UTF-8 bytes to the buffer with a length prefix.
`int`	`putStringUtf8(int index, String value, int maxEncodedSize)` Encode a String as UTF-8 bytes the buffer with a length prefix with a maximum encoded size check.
`void`	`wrap(byte[] buffer)` Attach a view to a byte[] for providing direct access.

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

- Constructor Detail
  - SafeBuffer
```
public SafeBuffer(byte[] buffer)
```
- Method Detail
  - putLong
```
public void putLong(int index,
                    long value)
```
    Description copied from interface: ClientProtocolBuffer
    
    Put a value at a given index.
    
    Specified by:
    
    putLong in interface ClientProtocolBuffer
    
    Parameters:
    
    index - The index in bytes where the value is put.
    
    value - The value to put at the given index.
  - putInt
```
public void putInt(int index,
                   int value)
```
    Description copied from interface: ClientProtocolBuffer
    
    Put a value at a given index.
    
    Specified by:
    
    putInt in interface ClientProtocolBuffer
    
    Parameters:
    
    index - The index in bytes where the value is put.
    
    value - The value put at the given index.
  - putShort
```
public void putShort(int index,
                     short value)
```
    Description copied from interface: ClientProtocolBuffer
    
    Put a value to a given index.
    
    Specified by:
    
    putShort in interface ClientProtocolBuffer
    
    Parameters:
    
    index - The index in bytes where the value is put.
    
    value - The value put at the given index.
  - putByte
```
public void putByte(int index,
                    byte value)
```
    Description copied from interface: ClientProtocolBuffer
    
    Put a value to a given index.
    
    Specified by:
    
    putByte in interface ClientProtocolBuffer
    
    Parameters:
    
    index - The index in bytes where the value is put.
    
    value - The value put at the given index.
  - putBytes
```
public void putBytes(int index,
                     byte[] src)
```
    Description copied from interface: ClientProtocolBuffer
    
    Put an array of src into the underlying buffer.
    
    Specified by:
    
    putBytes in interface ClientProtocolBuffer
    
    Parameters:
    
    index - The index in the underlying buffer from which to start the array.
    
    src - The array to be copied into the underlying buffer.
  - putBytes
```
public void putBytes(int index,
                     byte[] src,
                     int offset,
                     int length)
```
    Description copied from interface: ClientProtocolBuffer
    
    Put an array into the underlying buffer.
    
    Specified by:
    
    putBytes in interface ClientProtocolBuffer
    
    Parameters:
    
    index - The index in the underlying buffer from which to start the array.
    
    src - The array to be copied into the underlying buffer.
    
    offset - The offset in the supplied buffer at which to begin the copy.
    
    length - The length of the supplied buffer to copy.
  - putBytes
```
public void putBytes(int index,
                     ByteBuffer src,
                     int length)
```
    Specified by:
    
    putBytes in interface ClientProtocolBuffer
  - putStringUtf8
```
public int putStringUtf8(int index,
                         String value)
```
    Description copied from interface: ClientProtocolBuffer
    
    Encode a String as UTF-8 bytes to the buffer with a length prefix.
    
    Specified by:
    
    putStringUtf8 in interface ClientProtocolBuffer
    
    Parameters:
    
    index - The index at which the String should be encoded.
    
    value - The value of the String to be encoded.
    
    Returns:
    
    The number of bytes put to the buffer.
  - putStringUtf8
```
public int putStringUtf8(int index,
                         String value,
                         int maxEncodedSize)
```
    Description copied from interface: ClientProtocolBuffer
    
    Encode a String as UTF-8 bytes the buffer with a length prefix with a maximum encoded size check.
    
    Specified by:
    
    putStringUtf8 in interface ClientProtocolBuffer
    
    Parameters:
    
    index - The index at which the String should be encoded.
    
    value - The value of the String to be encoded.
    
    maxEncodedSize - The maximum encoded size to be checked before writing to the buffer.
    
    Returns:
    
    The number of bytes put to the buffer.
  - wrap
```
public void wrap(byte[] buffer)
```
    Description copied from interface: ClientProtocolBuffer
    
    Attach a view to a byte[] for providing direct access.
    
    Specified by:
    
    wrap in interface ClientProtocolBuffer
    
    Parameters:
    
    buffer - to which the view is attached.
  - byteArray
```
public byte[] byteArray()
```
    Description copied from interface: ClientProtocolBuffer
    
    Get the underlying byte[] if one exists.
    
    Specified by:
    
    byteArray in interface ClientProtocolBuffer
    
    Returns:
    
    the underlying byte[] if one exists.
  - capacity
```
public int capacity()
```
    Description copied from interface: ClientProtocolBuffer
    
    Get the capacity of the underlying buffer.
    
    Specified by:
    
    capacity in interface ClientProtocolBuffer
    
    Returns:
    
    the capacity of the underlying buffer in bytes.
  - getLong
```
public long getLong(int index)
```
    Description copied from interface: ClientProtocolBuffer
    
    Get the value at a given index.
    
    Specified by:
    
    getLong in interface ClientProtocolBuffer
    
    Parameters:
    
    index - in bytes from which to get.
    
    Returns:
    
    the value for at a given index
  - getInt
```
public int getInt(int index)
```
    Description copied from interface: ClientProtocolBuffer
    
    Get the value at a given index.
    
    Specified by:
    
    getInt in interface ClientProtocolBuffer
    
    Parameters:
    
    index - in bytes from which to get.
    
    Returns:
    
    the value at a given index.
  - getShort
```
public short getShort(int index)
```
    Description copied from interface: ClientProtocolBuffer
    
    Get the value at a given index.
    
    Specified by:
    
    getShort in interface ClientProtocolBuffer
    
    Parameters:
    
    index - in bytes from which to get.
    
    Returns:
    
    the value at a given index.
  - getByte
```
public byte getByte(int index)
```
    Description copied from interface: ClientProtocolBuffer
    
    Get the value at a given index.
    
    Specified by:
    
    getByte in interface ClientProtocolBuffer
    
    Parameters:
    
    index - in bytes from which to get.
    
    Returns:
    
    the value at a given index.
  - getBytes
```
public void getBytes(int index,
                     byte[] dst)
```
    Description copied from interface: ClientProtocolBuffer
    
    Get from the underlying buffer into a supplied byte array. This method will try to fill the supplied byte array.
    
    Specified by:
    
    getBytes in interface ClientProtocolBuffer
    
    Parameters:
    
    index - in the underlying buffer to start from.
    
    dst - into which the dst will be copied.
  - getBytes
```
public void getBytes(int index,
                     byte[] dst,
                     int offset,
                     int length)
```
    Description copied from interface: ClientProtocolBuffer
    
    Get bytes from the underlying buffer into a supplied byte array.
    
    Specified by:
    
    getBytes in interface ClientProtocolBuffer
    
    Parameters:
    
    index - in the underlying buffer to start from.
    
    dst - into which the bytes will be copied.
    
    offset - in the supplied buffer to start the copy
    
    length - of the supplied buffer to use.
  - getStringUtf8
```
public String getStringUtf8(int offset,
                            int length)
```
    Description copied from interface: ClientProtocolBuffer
    
    Get part of String from bytes encoded in UTF-8 format without a length prefix.
    
    Specified by:
    
    getStringUtf8 in interface ClientProtocolBuffer
    
    Parameters:
    
    offset - at which the String begins.
    
    length - of the String in bytes to decode.
    
    Returns:
    
    the String as represented by the UTF-8 encoded bytes.

Class SafeBuffer

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SafeBuffer

Method Detail

putLong

putInt

putShort

putByte

putBytes

putBytes

putBytes

putStringUtf8

putStringUtf8

wrap

byteArray

capacity

getLong

getInt

getShort

getByte

getBytes

getBytes

getStringUtf8