Buffer (oceanbase-client 2.4.0 API)

java.lang.Object
- com.oceanbase.jdbc.internal.com.read.Buffer

```
public class Buffer
extends Object
```

Field Summary

Fields
Modifier and Type Field and Description

byte[] buf

static byte[] EMPTY_BYTE_ARRAY

int limit

int position

Fields
Modifier and Type	Field and Description
`byte[]`	`buf`
`static byte[]`	`EMPTY_BYTE_ARRAY`
`int`	`limit`
`int`	`position`

Constructor Summary

Constructors
Constructor and Description

Buffer()

Buffer(byte[] buf)
Constructor with default limit and offset.

Buffer(byte[] buf, int limit)

Constructors
Constructor and Description
`Buffer()`
`Buffer(byte[] buf)` Constructor with default limit and offset.
`Buffer(byte[] buf, int limit)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`checkRemainder(long need)`
`int`	`fastSkipLenString()`
`byte`	`getByte()` Read current buffer byte without incrementing position.
`byte`	`getByteAt(int position)`
`byte[]`	`getByteBuffer()` Returns the array of bytes this Buffer is using to read from.
`byte[]`	`getBytes(int len)`
`byte[]`	`getBytes(int offset, int len)`
`Buffer`	`getLengthEncodedBuffer()` Get next data bytes from length encoded prefix.
`byte[]`	`getLengthEncodedBytes()` Get next data bytes with length encoded prefix.
`long`	`getLengthEncodedNumeric()` Get next binary data length.
`int`	`getLimit()`
`int`	`getPosition()`
`int`	`read24bitword()`
`byte`	`readByte()` Reads a byte from the buffer.
`byte[]`	`readBytes(int numberOfBytes)` Read raw data.
`byte[]`	`readBytesNullEnd()` Reads a byte array from the buffer, looks for a 0 to end the array.
`long`	`readFieldLength()`
`int`	`readInt()`
`int`	`readInt2()` Read a int (2 bytes) from the buffer.
`int`	`readInt3()` Read 24 bit integer.
`int`	`readInt4()` Read a int (4 bytes) from the buffer.
`int`	`readIntV1()`
`byte[]`	`readLenByteArray(int offset)`
`long`	`readLong()`
`long`	`readLong4()` Read a long (4 bytes) from the buffer.
`long`	`readLong8()` Read a long (8 bytes) from the buffer.
`long`	`readLongLongV1()`
`long`	`readLongV1()`
`int`	`readnBytes()`
`byte[]`	`readRawBytes(int numberOfBytes)`
`short`	`readShort()` Read a short (2 bytes) from the buffer.
`String`	`readString(int numberOfBytes)` Read String with defined length.
`String`	`readStringLengthEncoded(Charset charset)` Reads length-encoded string.
`String`	`readStringNullEnd(Charset charset)` Reads a string from the buffer, looks for a 0 to end the string.
`int`	`remaining()`
`void`	`setPosition(int position)`
`void`	`skipByte()`
`void`	`skipBytes(int bytesToSkip)`
`void`	`skipLengthEncodedBytes()` Skip next length encode binary data.
`void`	`skipLengthEncodedNumeric()` Skip length encoded numeric
`void`	`writeByte(byte b)`
`void`	`writeBytes(byte[] bytes, int off, int length)`
`void`	`writeBytes(byte header, byte[] bytes)` Write bytes.
`void`	`writeInt(int num)`
`void`	`writeIntV2(int num)`
`void`	`writeLength(long length)` Write length.
`void`	`writeLongFromHighToLow(long num)`
`void`	`writeLongFromLowToHigh(long num)`
`void`	`writeLongInt(int num)`
`void`	`writeNBytes(long num, int n)`
`void`	`writeShort(short num)`
`void`	`writeShortV2(short num)`
`void`	`writeString(String str)`
`void`	`writeStringLength(byte[] bytes)` Write value with length encoded prefix.
`void`	`writeStringLength(String value, Charset charset)` Write value with length encoded prefix.
`void`	`writeStringSmallLength(byte[] value)` Write value with length encoded prefix.

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

- Field Detail
  - buf
```
public byte[] buf
```
  - position
```
public int position
```
  - limit
```
public int limit
```
  - EMPTY_BYTE_ARRAY
```
public static final byte[] EMPTY_BYTE_ARRAY
```
- Constructor Detail
  - Buffer
```
public Buffer(byte[] buf,
              int limit)
```
  - Buffer
```
public Buffer(byte[] buf)
```
    Constructor with default limit and offset.
    
    Parameters:
    
    buf - byte array
  - Buffer
```
public Buffer()
```
- Method Detail
  - remaining
```
public int remaining()
```
  - checkRemainder
```
public void checkRemainder(long need)
                    throws IOException
```
    Throws:
    
    IOException
  - readStringNullEnd
```
public String readStringNullEnd(Charset charset)
```
    Reads a string from the buffer, looks for a 0 to end the string.
    
    Parameters:
    
    charset - the charset to use, for example ASCII
    
    Returns:
    
    the read string
  - readBytesNullEnd
```
public byte[] readBytesNullEnd()
```
    Reads a byte array from the buffer, looks for a 0 to end the array.
    
    Returns:
    
    the read array
  - readString
```
public String readString(int numberOfBytes)
```
    Read String with defined length.
    
    Parameters:
    
    numberOfBytes - raw data length.
    
    Returns:
    
    String value
  - readShort
```
public short readShort()
```
    Read a short (2 bytes) from the buffer.
    
    Returns:
    
    an short
  - readInt2
```
public int readInt2()
```
    Read a int (2 bytes) from the buffer.
    
    Returns:
    
    a int
  - readIntV1
```
public int readIntV1()
```
  - readInt3
```
public int readInt3()
```
    Read 24 bit integer.
    
    Returns:
    
    length
  - read24bitword
```
public int read24bitword()
```
  - readInt4
```
public int readInt4()
```
    Read a int (4 bytes) from the buffer.
    
    Returns:
    
    a int
  - readInt
```
public int readInt()
```
  - readnBytes
```
public int readnBytes()
```
  - readLong4
```
public long readLong4()
```
    Read a long (4 bytes) from the buffer.
    
    Returns:
    
    a long
  - readLongV1
```
public long readLongV1()
```
  - readLong8
```
public long readLong8()
```
    Read a long (8 bytes) from the buffer.
    
    Returns:
    
    a long
  - readLongLongV1
```
public long readLongLongV1()
```
  - readLong
```
public long readLong()
```
  - readByte
```
public byte readByte()
```
    Reads a byte from the buffer.
    
    Returns:
    
    the byte
  - readLenByteArray
```
public byte[] readLenByteArray(int offset)
```
  - getByte
```
public byte getByte()
```
    Read current buffer byte without incrementing position.
    
    Returns:
    
    the byte
  - skipByte
```
public void skipByte()
```
  - getByteAt
```
public byte getByteAt(int position)
```
  - readBytes
```
public byte[] readBytes(int numberOfBytes)
```
    Read raw data.
    
    Parameters:
    
    numberOfBytes - raw data length.
    
    Returns:
    
    raw data
  - readRawBytes
```
public byte[] readRawBytes(int numberOfBytes)
```
  - getBytes
```
public byte[] getBytes(int len)
```
  - getBytes
```
public byte[] getBytes(int offset,
                       int len)
```
  - skipBytes
```
public void skipBytes(int bytesToSkip)
```
  - getLengthEncodedBytes
```
public byte[] getLengthEncodedBytes()
```
    Get next data bytes with length encoded prefix.
    
    Returns:
    
    the raw binary data
  - skipLengthEncodedBytes
```
public void skipLengthEncodedBytes()
```
    Skip next length encode binary data.
  - getLengthEncodedNumeric
```
public long getLengthEncodedNumeric()
```
    Get next binary data length.
    
    Returns:
    
    length of next binary data
  - skipLengthEncodedNumeric
```
public void skipLengthEncodedNumeric()
```
    Skip length encoded numeric
  - getLengthEncodedBuffer
```
public Buffer getLengthEncodedBuffer()
```
    Get next data bytes from length encoded prefix.
    
    Returns:
    
    buffer
  - readStringLengthEncoded
```
public String readStringLengthEncoded(Charset charset)
```
    Reads length-encoded string.
    
    Parameters:
    
    charset - the charset to use, for example ASCII
    
    Returns:
    
    the read string
  - fastSkipLenString
```
public int fastSkipLenString()
```
  - readFieldLength
```
public final long readFieldLength()
```
  - writeByte
```
public void writeByte(byte b)
```
  - writeBytes
```
public void writeBytes(byte[] bytes,
                       int off,
                       int length)
```
  - writeBytes
```
public void writeBytes(byte header,
                       byte[] bytes)
```
    Write bytes.
    
    Parameters:
    
    header - header byte
    
    bytes - command bytes
  - writeShort
```
public void writeShort(short num)
```
  - writeShortV2
```
public void writeShortV2(short num)
```
  - writeLongInt
```
public void writeLongInt(int num)
```
  - writeInt
```
public void writeInt(int num)
```
  - writeIntV2
```
public void writeIntV2(int num)
```
  - writeNBytes
```
public void writeNBytes(long num,
                        int n)
```
  - writeLongFromLowToHigh
```
public void writeLongFromLowToHigh(long num)
```
  - writeLongFromHighToLow
```
public void writeLongFromHighToLow(long num)
```
  - writeString
```
public void writeString(String str)
```
  - writeStringLength
```
public void writeStringLength(String value,
                              Charset charset)
```
    Write value with length encoded prefix.
    
    Parameters:
    
    value - value to write
  - writeStringLength
```
public void writeStringLength(byte[] bytes)
```
    Write value with length encoded prefix.
    
    Parameters:
    
    bytes - value to write
  - writeStringSmallLength
```
public void writeStringSmallLength(byte[] value)
```
    Write value with length encoded prefix. value length MUST be less than 251 char
    
    Parameters:
    
    value - value to write
  - writeLength
```
public void writeLength(long length)
```
    Write length.
    
    Parameters:
    
    length - length
  - getPosition
```
public int getPosition()
```
  - setPosition
```
public void setPosition(int position)
```
  - getLimit
```
public int getLimit()
```
  - getByteBuffer
```
public byte[] getByteBuffer()
```
    Returns the array of bytes this Buffer is using to read from.
    
    Returns:
    
    byte array being read from

Class Buffer

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

buf

position

limit

EMPTY_BYTE_ARRAY

Constructor Detail

Buffer

Buffer

Buffer

Method Detail

remaining

checkRemainder

readStringNullEnd

readBytesNullEnd

readString

readShort

readInt2

readIntV1

readInt3

read24bitword

readInt4

readInt

readnBytes

readLong4

readLongV1

readLong8

readLongLongV1

readLong

readByte

readLenByteArray

getByte

skipByte

getByteAt

readBytes

readRawBytes

getBytes

getBytes

skipBytes

getLengthEncodedBytes

skipLengthEncodedBytes

getLengthEncodedNumeric

skipLengthEncodedNumeric

getLengthEncodedBuffer

readStringLengthEncoded

fastSkipLenString

readFieldLength

writeByte

writeBytes

writeBytes

writeShort

writeShortV2

writeLongInt

writeInt

writeIntV2

writeNBytes

writeLongFromLowToHigh

writeLongFromHighToLow

writeString

writeStringLength

writeStringLength

writeStringSmallLength

writeLength

getPosition

setPosition

getLimit

getByteBuffer