MysqlPacket (mysql-jdbc 1.0 API)

java.lang.Object
- com.heimuheimu.mysql.jdbc.packet.MysqlPacket

```
public class MysqlPacket
extends java.lang.Object
```
MYSQL 服务端与客户端之间进行通信的数据包，由 4 个字节的头部信息和可变长度的内容信息组成。
更多信息请参考： MySQL Packets

说明：MysqlPacket 类是非线程安全的，不允许多个线程使用同一个实例。

作者:

heimuheimu

构造器概要

构造器
构造器和说明

MysqlPacket(int sequenceId, byte[] payload)
构造一个 MYSQL 服务端与客户端之间进行通信的数据包。

构造器
构造器和说明
`MysqlPacket(int sequenceId, byte[] payload)` 构造一个 MYSQL 服务端与客户端之间进行通信的数据包。

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法和说明
`byte[]`	`buildMysqlPacketBytes()` 根据已写入的内容信息，生成 MYSQL 数据包字节数组，MYSQL 数据包格式定义： MySQL Packets
`static int`	`getBytesLengthForLengthEncodedInteger(long value)` 将该无符号整数转换为 "Protocol::LengthEncodedInteger" 类型所需的字节长度。
`byte[]`	`getPayload()` 获得内容信息字节数组。
`int`	`getPosition()` 获得下一个被读取字节的索引位置。
`int`	`getSequenceId()` 获得数据包序号。
`boolean`	`hasRemaining()` 判断 position 的值是否小于 payload 的长度。
`byte[]`	`readFixedLengthBytes(int length)` 读取固定长度的字节数组。
`long`	`readFixedLengthInteger(int length)` 读取 "Protocol::FixedLengthInteger" 类型的无符号整数，长度允许的范围为: [1, 8]。
`java.lang.String`	`readFixedLengthString(int length, java.nio.charset.Charset charset)` 读取 "Protocol::FixedLengthString" 类型的字符串，该方法不会返回 `null`。
`long`	`readLengthEncodedInteger()` 读取 "Protocol::LengthEncodedInteger" 类型的无符号整数。
`java.lang.String`	`readLengthEncodedString(java.nio.charset.Charset charset)` 读取 "Protocol::LengthEncodedString" 类型的字符串，该方法不会返回 `null`。
`java.lang.String`	`readNullTerminatedString(java.nio.charset.Charset charset)` 读取 "Protocol::NullTerminatedString" 类型的字符串。
`java.lang.String`	`readRestOfPacketString(java.nio.charset.Charset charset)` 读取 "Protocol::RestOfPacketString" 类型的字符串，可能返回 `null`。
`void`	`setPosition(int position)` 设置下一个被读取字节的索引位置。
`java.lang.String`	`toString()`
`MysqlPacket`	`writeFixedLengthBytes(byte[] src)` 写入固定长度的字节数组。
`MysqlPacket`	`writeFixedLengthInteger(int length, long value)` 以字节形式写入 "Protocol::FixedLengthInteger" 类型的无符号整数。
`MysqlPacket`	`writeLengthEncodedInteger(long value)` 以字节形式写入 "Protocol::LengthEncodedInteger" 类型的无符号整数。
`MysqlPacket`	`writeLengthEncodedString(byte[] text)` 以字节形式写入 "Protocol::LengthEncodedString" 类型的字符串。
`MysqlPacket`	`writeNullTerminatedString(byte[] text)` 以字节形式写入 "Protocol::NullTerminatedString" 类型的字符串。

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- 构造器详细资料
  - MysqlPacket
```
public MysqlPacket(int sequenceId,
                   byte[] payload)
```
    构造一个 MYSQL 服务端与客户端之间进行通信的数据包。
    
    参数:
    
    sequenceId - 数据包序号
    
    payload - 内容信息
- 方法详细资料
  - getSequenceId
```
public int getSequenceId()
```
    获得数据包序号。
    
    返回:
    
    数据包序号
  - getPayload
```
public byte[] getPayload()
```
    获得内容信息字节数组。
    注意：请勿直接修改内容信息字节数组中的内容。
    
    返回:
    
    内容信息字节数组
  - getPosition
```
public int getPosition()
```
    获得下一个被读取字节的索引位置。
    
    返回:
    
    下一个被读取字节的索引位置
  - setPosition
```
public void setPosition(int position)
```
    设置下一个被读取字节的索引位置。
    
    参数:
    
    position - 下一个被读取字节的索引位置
  - hasRemaining
```
public boolean hasRemaining()
```
    判断 position 的值是否小于 payload 的长度。
    
    返回:
    
    position 的值是否小于 payload 的长度
  - readFixedLengthBytes
```
public byte[] readFixedLengthBytes(int length)
                            throws java.lang.IndexOutOfBoundsException,
                                   java.lang.IllegalArgumentException
```
    读取固定长度的字节数组。
    
    参数:
    
    length - 字节长度
    
    返回:
    
    固定长度的字节数组
    
    抛出:
    
    java.lang.ArrayIndexOutOfBoundsException - 如果访问数组越界，将会抛出此异常
    
    java.lang.IllegalArgumentException - 如果 length 小于 0，将会抛出此异常
    
    java.lang.IndexOutOfBoundsException
  - readFixedLengthInteger
```
public long readFixedLengthInteger(int length)
                            throws java.lang.ArrayIndexOutOfBoundsException,
                                   java.lang.IllegalArgumentException
```
    读取 "Protocol::FixedLengthInteger" 类型的无符号整数，长度允许的范围为: [1, 8]。
    更多信息请参考： Protocol::FixedLengthInteger
    
    参数:
    
    length - 字节长度
    
    返回:
    
    无符号整数
    
    抛出:
    
    java.lang.ArrayIndexOutOfBoundsException - 如果访问数组越界，将会抛出此异常
    
    java.lang.IllegalArgumentException - 如果 length 的值没有在允许的范围内，将会抛出此异常
  - readLengthEncodedInteger
```
public long readLengthEncodedInteger()
                              throws java.lang.ArrayIndexOutOfBoundsException
```
    读取 "Protocol::LengthEncodedInteger" 类型的无符号整数。
    更多信息请参考： Protocol::LengthEncodedInteger
    
    返回:
    
    无符号整数
    
    抛出:
    
    java.lang.ArrayIndexOutOfBoundsException - 如果访问数组越界，将会抛出此异常
  - readNullTerminatedString
```
public java.lang.String readNullTerminatedString(java.nio.charset.Charset charset)
                                          throws java.lang.ArrayIndexOutOfBoundsException
```
    读取 "Protocol::NullTerminatedString" 类型的字符串。
    更多信息请参考： Protocol::NullTerminatedString
    
    参数:
    
    charset - 字符集编码
    
    返回:
    
    "Protocol::NullTerminatedString" 类型的字符串
    
    抛出:
    
    java.lang.ArrayIndexOutOfBoundsException - 如果访问数组越界，将会抛出此异常
  - readLengthEncodedString
```
public java.lang.String readLengthEncodedString(java.nio.charset.Charset charset)
                                         throws java.lang.ArrayIndexOutOfBoundsException
```
    读取 "Protocol::LengthEncodedString" 类型的字符串，该方法不会返回 null。
    更多信息请参考： Protocol::LengthEncodedString
    
    参数:
    
    charset - 字符集编码
    
    返回:
    
    "Protocol::LengthEncodedString" 类型的字符串
    
    抛出:
    
    java.lang.ArrayIndexOutOfBoundsException - 如果访问数组越界，将会抛出此异常
  - readFixedLengthString
```
public java.lang.String readFixedLengthString(int length,
                                              java.nio.charset.Charset charset)
                                       throws java.lang.ArrayIndexOutOfBoundsException,
                                              java.lang.IllegalArgumentException
```
    读取 "Protocol::FixedLengthString" 类型的字符串，该方法不会返回 null。
    更多信息请参考： Protocol::FixedLengthString
    
    参数:
    
    length - 字符串长度
    
    charset - 字符集编码
    
    返回:
    
    "Protocol::FixedLengthString" 类型的字符串
    
    抛出:
    
    java.lang.ArrayIndexOutOfBoundsException - 如果访问数组越界，将会抛出此异常
    
    java.lang.IllegalArgumentException - 如果 length 小于 0，将会抛出此异常
  - readRestOfPacketString
```
public java.lang.String readRestOfPacketString(java.nio.charset.Charset charset)
```
    读取 "Protocol::RestOfPacketString" 类型的字符串，可能返回 null。
    更多信息请参考： Protocol::RestOfPacketString
    
    参数:
    
    charset - 字符编码
    
    返回:
    
    "Protocol::FixedLengthString" 类型的字符串
  - writeFixedLengthBytes
```
public MysqlPacket writeFixedLengthBytes(byte[] src)
                                  throws java.lang.IndexOutOfBoundsException,
                                         java.lang.NullPointerException
```
    写入固定长度的字节数组。
    
    参数:
    
    src - 需要写入的字节数组，不允许为 null
    
    返回:
    
    当前 MysqlPacket 实例
    
    抛出:
    
    java.lang.IndexOutOfBoundsException - 如果访问数组越界，将会抛出此异常
    
    java.lang.NullPointerException - 如果 src 为 null，将会抛出此异常
  - writeFixedLengthInteger
```
public MysqlPacket writeFixedLengthInteger(int length,
                                           long value)
                                    throws java.lang.ArrayIndexOutOfBoundsException,
                                           java.lang.IllegalArgumentException
```
    以字节形式写入 "Protocol::FixedLengthInteger" 类型的无符号整数。
    更多信息请参考： Protocol::FixedLengthInteger
    
    参数:
    
    length - 字节长度
    
    value - 无符号整数
    
    返回:
    
    当前 MysqlPacket 实例
    
    抛出:
    
    java.lang.ArrayIndexOutOfBoundsException - 如果访问数组越界，将会抛出此异常
    
    java.lang.IllegalArgumentException - 如果 length 或 value 的值没有在允许的范围内，将会抛出此异常
  - writeLengthEncodedInteger
```
public MysqlPacket writeLengthEncodedInteger(long value)
                                      throws java.lang.ArrayIndexOutOfBoundsException,
                                             java.lang.IllegalArgumentException
```
    以字节形式写入 "Protocol::LengthEncodedInteger" 类型的无符号整数。
    更多信息请参考： Protocol::LengthEncodedInteger
    
    参数:
    
    value - 无符号整数
    
    返回:
    
    当前 MysqlPacket 实例
    
    抛出:
    
    java.lang.ArrayIndexOutOfBoundsException - 如果访问数组越界，将会抛出此异常
    
    java.lang.IllegalArgumentException - 如果 value 的值为负数，将会抛出此异常
  - writeNullTerminatedString
```
public MysqlPacket writeNullTerminatedString(byte[] text)
                                      throws java.lang.ArrayIndexOutOfBoundsException,
                                             java.lang.IllegalArgumentException
```
    以字节形式写入 "Protocol::NullTerminatedString" 类型的字符串。
    更多信息请参考： Protocol::NullTerminatedString
    
    参数:
    
    text - 字符串字节数组
    
    返回:
    
    当前 MysqlPacket 实例
    
    抛出:
    
    java.lang.ArrayIndexOutOfBoundsException - 如果访问数组越界，将会抛出此异常
    
    java.lang.IllegalArgumentException - 如果 text 为 null，将会抛出此异常
  - writeLengthEncodedString
```
public MysqlPacket writeLengthEncodedString(byte[] text)
                                     throws java.lang.ArrayIndexOutOfBoundsException,
                                            java.lang.IllegalArgumentException
```
    以字节形式写入 "Protocol::LengthEncodedString" 类型的字符串。
    
    参数:
    
    text - 字符串字节数组
    
    返回:
    
    当前 MysqlPacket 实例
    
    抛出:
    
    java.lang.ArrayIndexOutOfBoundsException - 如果访问数组越界，将会抛出此异常
    
    java.lang.IllegalArgumentException - 如果 text 为 null，将会抛出此异常
  - buildMysqlPacketBytes
```
public byte[] buildMysqlPacketBytes()
                             throws java.lang.IllegalArgumentException
```
    根据已写入的内容信息，生成 MYSQL 数据包字节数组，MYSQL 数据包格式定义： MySQL Packets
    
    返回:
    
    MYSQL 数据包字节数组
    
    抛出:
    
    java.lang.IllegalArgumentException - 如果已写入的内容信息为空，即 getPosition() 为 0，将会抛出此异常
  - toString
```
public java.lang.String toString()
```
    覆盖:
    
    toString 在类中 java.lang.Object
  - getBytesLengthForLengthEncodedInteger
```
public static int getBytesLengthForLengthEncodedInteger(long value)
```
    将该无符号整数转换为 "Protocol::LengthEncodedInteger" 类型所需的字节长度。
    更多信息请参考： Protocol::LengthEncodedInteger
    
    参数:
    
    value - 无符号整数
    
    返回:
    
    转换为 "Protocol::LengthEncodedInteger" 类型所需的字节长度
    
    另请参阅:
    
    writeLengthEncodedInteger(long)

类 MysqlPacket

构造器概要

方法概要

从类继承的方法 java.lang.Object

构造器详细资料

MysqlPacket

方法详细资料

getSequenceId

getPayload

getPosition

setPosition

hasRemaining

readFixedLengthBytes

readFixedLengthInteger

readLengthEncodedInteger

readNullTerminatedString

readLengthEncodedString

readFixedLengthString

readRestOfPacketString

writeFixedLengthBytes

writeFixedLengthInteger

writeLengthEncodedInteger

writeNullTerminatedString

writeLengthEncodedString

buildMysqlPacketBytes

toString

getBytesLengthForLengthEncodedInteger