CapabilitiesFlagsUtil (mysql-jdbc 1.0 API)

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

```
public class CapabilitiesFlagsUtil
extends java.lang.Object
```
提供 Mysql 客户端可使用的特性数值解析和生成方法，更多信息请参考： Capabilities Flags
说明：CapabilitiesFlagsUtil 类是线程安全的，可在多个线程中使用同一个实例。

作者:

heimuheimu

字段概要

字段
限定符和类型	字段和说明
`static int`	`INDEX_CLIENT_CAN_HANDLE_EXPIRED_PASSWORDS` "CLIENT_CAN_HANDLE_EXPIRED_PASSWORDS" 特性对应的比特位索引位置
`static int`	`INDEX_CLIENT_COMPRESS` "CLIENT_COMPRESS " 特性对应的比特位索引位置
`static int`	`INDEX_CLIENT_CONNECT_ATTRS` "CLIENT_CONNECT_ATTRS" 特性对应的比特位索引位置
`static int`	`INDEX_CLIENT_CONNECT_WITH_DB` "CLIENT_CONNECT_WITH_DB" 特性对应的比特位索引位置
`static int`	`INDEX_CLIENT_DEPRECATE_EOF` "CLIENT_DEPRECATE_EOF" 特性对应的比特位索引位置
`static int`	`INDEX_CLIENT_FOUND_ROWS` "CLIENT_FOUND_ROWS" 特性对应的比特位索引位置
`static int`	`INDEX_CLIENT_IGNORE_SIGPIPE` "CLIENT_IGNORE_SIGPIPE" 特性对应的比特位索引位置
`static int`	`INDEX_CLIENT_IGNORE_SPACE` "CLIENT_IGNORE_SPACE" 特性对应的比特位索引位置
`static int`	`INDEX_CLIENT_INTERACTIVE` "CLIENT_INTERACTIVE" 特性对应的比特位索引位置
`static int`	`INDEX_CLIENT_LOCAL_FILES` "CLIENT_LOCAL_FILES" 特性对应的比特位索引位置
`static int`	`INDEX_CLIENT_LONG_FLAG` "CLIENT_LONG_FLAG" 特性对应的比特位索引位置
`static int`	`INDEX_CLIENT_LONG_PASSWORD` "CLIENT_LONG_PASSWORD" 特性对应的比特位索引位置
`static int`	`INDEX_CLIENT_MULTI_RESULTS` "CLIENT_MULTI_RESULTS" 特性对应的比特位索引位置
`static int`	`INDEX_CLIENT_MULTI_STATEMENTS` "CLIENT_MULTI_STATEMENTS" 特性对应的比特位索引位置
`static int`	`INDEX_CLIENT_NO_SCHEMA` "CLIENT_NO_SCHEMA " 特性对应的比特位索引位置
`static int`	`INDEX_CLIENT_ODBC` "CLIENT_ODBC" 特性对应的比特位索引位置
`static int`	`INDEX_CLIENT_OPTIONAL_RESULTSET_METADATA` "CLIENT_OPTIONAL_RESULTSET_METADATA" 特性对应的比特位索引位置
`static int`	`INDEX_CLIENT_PLUGIN_AUTH` "CLIENT_PLUGIN_AUTH" 特性对应的比特位索引位置
`static int`	`INDEX_CLIENT_PLUGIN_AUTH_LENENC_CLIENT_DATA` "CLIENT_PLUGIN_AUTH_LENENC_CLIENT_DATA" 特性对应的比特位索引位置
`static int`	`INDEX_CLIENT_PROTOCOL_41` "CLIENT_PROTOCOL_41" 特性对应的比特位索引位置
`static int`	`INDEX_CLIENT_PS_MULTI_RESULTS` "CLIENT_PS_MULTI_RESULTS" 特性对应的比特位索引位置
`static int`	`INDEX_CLIENT_REMEMBER_OPTIONS` "CLIENT_REMEMBER_OPTIONS" 特性对应的比特位索引位置
`static int`	`INDEX_CLIENT_RESERVED` "CLIENT_RESERVED" 特性对应的比特位索引位置
`static int`	`INDEX_CLIENT_RESERVED2` "CLIENT_RESERVED2" 特性对应的比特位索引位置
`static int`	`INDEX_CLIENT_SESSION_TRACK` "CLIENT_SESSION_TRACK" 特性对应的比特位索引位置
`static int`	`INDEX_CLIENT_SSL` "CLIENT_SSL" 特性对应的比特位索引位置
`static int`	`INDEX_CLIENT_SSL_VERIFY_SERVER_CERT` "CLIENT_SSL_VERIFY_SERVER_CERT" 特性对应的比特位索引位置
`static int`	`INDEX_CLIENT_TRANSACTIONS` "CLIENT_TRANSACTIONS" 特性对应的比特位索引位置

构造器概要

构造器
构造器和说明

CapabilitiesFlagsUtil()

构造器
构造器和说明
`CapabilitiesFlagsUtil()`

方法概要

所有方法静态方法具体方法
限定符和类型	方法和说明
`static long`	`disableCapability(long capabilitiesFlags, int capabilityIndex)` 关闭指定的 Mysql 客户端特性，并保留特性数值的其它特性设置。
`static long`	`enableCapability(long capabilitiesFlags, int capabilityIndex)` 开启指定的 Mysql 客户端特性，并保留特性数值的其它特性设置。
`static java.lang.String`	`getCapabilityName(int capabilityIndex)` 根据 Mysql 客户端特性比特位索引位置获得对应的名称，该方法不会返回 `null`。
`static java.util.List<java.lang.String>`	`getEnabledCapabilitiesNames(long capabilitiesFlags)` 返回 Mysql 客户端可使用的特性数值中已开启的特性名称列表，该方法不会返回 `null`。
`static boolean`	`isCapabilityEnabled(long capabilitiesFlags, int capabilityIndex)` 判断指定的 Mysql 客户端特性是否开启。

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

- 字段详细资料
  - INDEX_CLIENT_LONG_PASSWORD
```
public static final int INDEX_CLIENT_LONG_PASSWORD
```
    "CLIENT_LONG_PASSWORD" 特性对应的比特位索引位置
    
    另请参阅:
    
    常量字段值
  - INDEX_CLIENT_FOUND_ROWS
```
public static final int INDEX_CLIENT_FOUND_ROWS
```
    "CLIENT_FOUND_ROWS" 特性对应的比特位索引位置
    
    另请参阅:
    
    常量字段值
  - INDEX_CLIENT_LONG_FLAG
```
public static final int INDEX_CLIENT_LONG_FLAG
```
    "CLIENT_LONG_FLAG" 特性对应的比特位索引位置
    
    另请参阅:
    
    常量字段值
  - INDEX_CLIENT_CONNECT_WITH_DB
```
public static final int INDEX_CLIENT_CONNECT_WITH_DB
```
    "CLIENT_CONNECT_WITH_DB" 特性对应的比特位索引位置
    
    另请参阅:
    
    常量字段值
  - INDEX_CLIENT_NO_SCHEMA
```
public static final int INDEX_CLIENT_NO_SCHEMA
```
    "CLIENT_NO_SCHEMA " 特性对应的比特位索引位置
    
    另请参阅:
    
    常量字段值
  - INDEX_CLIENT_COMPRESS
```
public static final int INDEX_CLIENT_COMPRESS
```
    "CLIENT_COMPRESS " 特性对应的比特位索引位置
    
    另请参阅:
    
    常量字段值
  - INDEX_CLIENT_ODBC
```
public static final int INDEX_CLIENT_ODBC
```
    "CLIENT_ODBC" 特性对应的比特位索引位置
    
    另请参阅:
    
    常量字段值
  - INDEX_CLIENT_LOCAL_FILES
```
public static final int INDEX_CLIENT_LOCAL_FILES
```
    "CLIENT_LOCAL_FILES" 特性对应的比特位索引位置
    
    另请参阅:
    
    常量字段值
  - INDEX_CLIENT_IGNORE_SPACE
```
public static final int INDEX_CLIENT_IGNORE_SPACE
```
    "CLIENT_IGNORE_SPACE" 特性对应的比特位索引位置
    
    另请参阅:
    
    常量字段值
  - INDEX_CLIENT_PROTOCOL_41
```
public static final int INDEX_CLIENT_PROTOCOL_41
```
    "CLIENT_PROTOCOL_41" 特性对应的比特位索引位置
    
    另请参阅:
    
    常量字段值
  - INDEX_CLIENT_INTERACTIVE
```
public static final int INDEX_CLIENT_INTERACTIVE
```
    "CLIENT_INTERACTIVE" 特性对应的比特位索引位置
    
    另请参阅:
    
    常量字段值
  - INDEX_CLIENT_SSL
```
public static final int INDEX_CLIENT_SSL
```
    "CLIENT_SSL" 特性对应的比特位索引位置
    
    另请参阅:
    
    常量字段值
  - INDEX_CLIENT_IGNORE_SIGPIPE
```
public static final int INDEX_CLIENT_IGNORE_SIGPIPE
```
    "CLIENT_IGNORE_SIGPIPE" 特性对应的比特位索引位置
    
    另请参阅:
    
    常量字段值
  - INDEX_CLIENT_TRANSACTIONS
```
public static final int INDEX_CLIENT_TRANSACTIONS
```
    "CLIENT_TRANSACTIONS" 特性对应的比特位索引位置
    
    另请参阅:
    
    常量字段值
  - INDEX_CLIENT_RESERVED
```
public static final int INDEX_CLIENT_RESERVED
```
    "CLIENT_RESERVED" 特性对应的比特位索引位置
    
    另请参阅:
    
    常量字段值
  - INDEX_CLIENT_RESERVED2
```
public static final int INDEX_CLIENT_RESERVED2
```
    "CLIENT_RESERVED2" 特性对应的比特位索引位置
    
    另请参阅:
    
    常量字段值
  - INDEX_CLIENT_MULTI_STATEMENTS
```
public static final int INDEX_CLIENT_MULTI_STATEMENTS
```
    "CLIENT_MULTI_STATEMENTS" 特性对应的比特位索引位置
    
    另请参阅:
    
    常量字段值
  - INDEX_CLIENT_MULTI_RESULTS
```
public static final int INDEX_CLIENT_MULTI_RESULTS
```
    "CLIENT_MULTI_RESULTS" 特性对应的比特位索引位置
    
    另请参阅:
    
    常量字段值
  - INDEX_CLIENT_PS_MULTI_RESULTS
```
public static final int INDEX_CLIENT_PS_MULTI_RESULTS
```
    "CLIENT_PS_MULTI_RESULTS" 特性对应的比特位索引位置
    
    另请参阅:
    
    常量字段值
  - INDEX_CLIENT_PLUGIN_AUTH
```
public static final int INDEX_CLIENT_PLUGIN_AUTH
```
    "CLIENT_PLUGIN_AUTH" 特性对应的比特位索引位置
    
    另请参阅:
    
    常量字段值
  - INDEX_CLIENT_CONNECT_ATTRS
```
public static final int INDEX_CLIENT_CONNECT_ATTRS
```
    "CLIENT_CONNECT_ATTRS" 特性对应的比特位索引位置
    
    另请参阅:
    
    常量字段值
  - INDEX_CLIENT_PLUGIN_AUTH_LENENC_CLIENT_DATA
```
public static final int INDEX_CLIENT_PLUGIN_AUTH_LENENC_CLIENT_DATA
```
    "CLIENT_PLUGIN_AUTH_LENENC_CLIENT_DATA" 特性对应的比特位索引位置
    
    另请参阅:
    
    常量字段值
  - INDEX_CLIENT_CAN_HANDLE_EXPIRED_PASSWORDS
```
public static final int INDEX_CLIENT_CAN_HANDLE_EXPIRED_PASSWORDS
```
    "CLIENT_CAN_HANDLE_EXPIRED_PASSWORDS" 特性对应的比特位索引位置
    
    另请参阅:
    
    常量字段值
  - INDEX_CLIENT_SESSION_TRACK
```
public static final int INDEX_CLIENT_SESSION_TRACK
```
    "CLIENT_SESSION_TRACK" 特性对应的比特位索引位置
    
    另请参阅:
    
    常量字段值
  - INDEX_CLIENT_DEPRECATE_EOF
```
public static final int INDEX_CLIENT_DEPRECATE_EOF
```
    "CLIENT_DEPRECATE_EOF" 特性对应的比特位索引位置
    
    另请参阅:
    
    常量字段值
  - INDEX_CLIENT_OPTIONAL_RESULTSET_METADATA
```
public static final int INDEX_CLIENT_OPTIONAL_RESULTSET_METADATA
```
    "CLIENT_OPTIONAL_RESULTSET_METADATA" 特性对应的比特位索引位置
    
    另请参阅:
    
    常量字段值
  - INDEX_CLIENT_SSL_VERIFY_SERVER_CERT
```
public static final int INDEX_CLIENT_SSL_VERIFY_SERVER_CERT
```
    "CLIENT_SSL_VERIFY_SERVER_CERT" 特性对应的比特位索引位置
    
    另请参阅:
    
    常量字段值
  - INDEX_CLIENT_REMEMBER_OPTIONS
```
public static final int INDEX_CLIENT_REMEMBER_OPTIONS
```
    "CLIENT_REMEMBER_OPTIONS" 特性对应的比特位索引位置
    
    另请参阅:
    
    常量字段值
- 构造器详细资料
  - CapabilitiesFlagsUtil
```
public CapabilitiesFlagsUtil()
```
- 方法详细资料
  - isCapabilityEnabled
```
public static boolean isCapabilityEnabled(long capabilitiesFlags,
                                          int capabilityIndex)
                                   throws java.lang.IllegalArgumentException
```
    判断指定的 Mysql 客户端特性是否开启。
    
    参数:
    
    capabilitiesFlags - Mysql 客户端可使用的特性数值
    
    capabilityIndex - 特性对应的比特位索引位置，允许的值为：[0, 31]
    
    返回:
    
    是否开启
    
    抛出:
    
    java.lang.IllegalArgumentException - 如果特性对应的比特位索引位置没有在允许的范围内，将会抛出此异常
  - enableCapability
```
public static long enableCapability(long capabilitiesFlags,
                                    int capabilityIndex)
                             throws java.lang.IllegalArgumentException
```
    开启指定的 Mysql 客户端特性，并保留特性数值的其它特性设置。
    
    参数:
    
    capabilitiesFlags - Mysql 客户端可使用的特性数值
    
    capabilityIndex - 特性对应的比特位索引位置，允许的值为：[0, 31]
    
    返回:
    
    开启指定的 Mysql 客户端特性后的特性数值
    
    抛出:
    
    java.lang.IllegalArgumentException - 如果特性对应的比特位索引位置没有在允许的范围内，将会抛出此异常
  - disableCapability
```
public static long disableCapability(long capabilitiesFlags,
                                     int capabilityIndex)
                              throws java.lang.IllegalArgumentException
```
    关闭指定的 Mysql 客户端特性，并保留特性数值的其它特性设置。
    
    参数:
    
    capabilitiesFlags - Mysql 客户端可使用的特性数值
    
    capabilityIndex - 特性对应的比特位索引位置，允许的值为：[0, 31]
    
    返回:
    
    关闭指定的 Mysql 客户端特性后的特性数值
    
    抛出:
    
    java.lang.IllegalArgumentException - 如果特性对应的比特位索引位置没有在允许的范围内，将会抛出此异常
  - getCapabilityName
```
public static java.lang.String getCapabilityName(int capabilityIndex)
                                          throws java.lang.IllegalArgumentException
```
    根据 Mysql 客户端特性比特位索引位置获得对应的名称，该方法不会返回 null。
    
    参数:
    
    capabilityIndex - 特性对应的比特位索引位置，允许的值为：[0, 31]
    
    返回:
    
    特性名称
    
    抛出:
    
    java.lang.IllegalArgumentException - 如果特性对应的比特位索引位置没有在允许的范围内，将会抛出此异常
  - getEnabledCapabilitiesNames
```
public static java.util.List<java.lang.String> getEnabledCapabilitiesNames(long capabilitiesFlags)
```
    返回 Mysql 客户端可使用的特性数值中已开启的特性名称列表，该方法不会返回 null。
    
    参数:
    
    capabilitiesFlags - Mysql 客户端可使用的特性数值
    
    返回:
    
    开启的特性名称列表

类 CapabilitiesFlagsUtil

字段概要

构造器概要

方法概要

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

字段详细资料

INDEX_CLIENT_LONG_PASSWORD

INDEX_CLIENT_FOUND_ROWS

INDEX_CLIENT_LONG_FLAG

INDEX_CLIENT_CONNECT_WITH_DB

INDEX_CLIENT_NO_SCHEMA

INDEX_CLIENT_COMPRESS

INDEX_CLIENT_ODBC

INDEX_CLIENT_LOCAL_FILES

INDEX_CLIENT_IGNORE_SPACE

INDEX_CLIENT_PROTOCOL_41

INDEX_CLIENT_INTERACTIVE

INDEX_CLIENT_SSL

INDEX_CLIENT_IGNORE_SIGPIPE

INDEX_CLIENT_TRANSACTIONS

INDEX_CLIENT_RESERVED

INDEX_CLIENT_RESERVED2

INDEX_CLIENT_MULTI_STATEMENTS

INDEX_CLIENT_MULTI_RESULTS

INDEX_CLIENT_PS_MULTI_RESULTS

INDEX_CLIENT_PLUGIN_AUTH

INDEX_CLIENT_CONNECT_ATTRS

INDEX_CLIENT_PLUGIN_AUTH_LENENC_CLIENT_DATA

INDEX_CLIENT_CAN_HANDLE_EXPIRED_PASSWORDS

INDEX_CLIENT_SESSION_TRACK

INDEX_CLIENT_DEPRECATE_EOF

INDEX_CLIENT_OPTIONAL_RESULTSET_METADATA

INDEX_CLIENT_SSL_VERIFY_SERVER_CERT

INDEX_CLIENT_REMEMBER_OPTIONS

构造器详细资料

CapabilitiesFlagsUtil

方法详细资料

isCapabilityEnabled

enableCapability

disableCapability

getCapabilityName

getEnabledCapabilitiesNames