RedisConfigType (dtalk common for redis 0.6.8 API)

java.lang.Object
- java.lang.Enum<RedisConfigType>
- - gu.dtalk.redis.RedisConfigType

所有已实现的接口:

gu.simplemq.IMQConnParameterSupplier, java.io.Serializable, java.lang.Comparable<RedisConfigType>
```
public enum RedisConfigType
extends java.lang.Enum<RedisConfigType>
implements gu.simplemq.IMQConnParameterSupplier
```
redis连接配置参数

作者:

guyadong

枚举常量概要

枚举常量
枚举常量和说明

CLOUD

CUSTOM
自定义配置

LAN

LOCALHOST

枚举常量
枚举常量和说明
`CLOUD`
`CUSTOM` 自定义配置
`LAN`
`LOCALHOST`

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法和说明
`com.google.common.net.HostAndPort`	`getHostAndPort()`
`gu.simplemq.MessageQueueType`	`getImplType()`
`java.util.Map<java.lang.String,java.lang.Object>`	`getMQConnParameters()`
`static RedisConfigType`	`lookupConnect(java.lang.Integer timeoutMills)` 按照如下优先顺序测试配置的redis连接，返回第一个能建立有效连接的配置，否则抛出异常 `CUSTOM` `LAN` `CLOUD` `LOCALHOST`
`static RedisConfigType`	`lookupConnectUnchecked(java.lang.Integer timeoutMills)` 与`#lookupConnect(Long)`功能相似,不同的时当没有找到有效redis连接时,不抛出异常,返回`null`
`java.util.Map<gu.simplemq.redis.JedisPoolLazy.PropName,java.lang.Object>`	`readRedisParam()` 根据SPI加载的`RedisConfigProvider`实例提供的参数创建Redis连接参数如果`findConfigProvider()`返回`null`则返回`null`
`static void`	`resetActiveConfigType()` 复位`activeConfigType`为`null` 为避免`#lookupConnect(Long)`方法被多次执行，当`activeConfigType`不为`null`时直接返回`activeConfigType`的值，如果希望再次执行`#lookupConnect(Long)`方法，可先调用此方法设置`activeConfigType`为`null`
`void`	`saveRedisParam(java.util.Map<gu.simplemq.redis.JedisPoolLazy.PropName,java.lang.Object> param)` 保存redis参数到当前类型对应的`RedisConfigProvider`实例
`boolean`	`testConnect(java.lang.Integer timeoutMills)` 测试redis连接
`java.lang.String`	`toString()`
`static RedisConfigType`	`valueOf(java.lang.String name)` 返回带有指定名称的该类型的枚举常量。
`static RedisConfigType[]`	`values()` 按照声明该枚举类型的常量的顺序, 返回包含这些常量的数组。

从类继承的方法 java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

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

- 枚举常量详细资料
  - CUSTOM
```
public static final RedisConfigType CUSTOM
```
    自定义配置
  - LAN
```
public static final RedisConfigType LAN
```
  - CLOUD
```
public static final RedisConfigType CLOUD
```
  - LOCALHOST
```
public static final RedisConfigType LOCALHOST
```
- 方法详细资料
  - values
```
public static RedisConfigType[] values()
```
    按照声明该枚举类型的常量的顺序, 返回包含这些常量的数组。该方法可用于迭代常量, 如下所示:
```
for (RedisConfigType c : RedisConfigType.values())
    System.out.println(c);
```
    返回:
    
    按照声明该枚举类型的常量的顺序返回的包含这些常量的数组
  - valueOf
```
public static RedisConfigType valueOf(java.lang.String name)
```
    返回带有指定名称的该类型的枚举常量。字符串必须与用于声明该类型的枚举常量的标识符完全匹配。(不允许有多余的空格字符。)
    
    参数:
    
    name - 要返回的枚举常量的名称。
    
    返回:
    
    返回带有指定名称的枚举常量
    
    抛出:
    
    java.lang.IllegalArgumentException - 如果该枚举类型没有带有指定名称的常量
    
    java.lang.NullPointerException - 如果参数为空值
  - getHostAndPort
```
public com.google.common.net.HostAndPort getHostAndPort()
```
    指定者:
    
    getHostAndPort 在接口中 gu.simplemq.IMQConnParameterSupplier
  - readRedisParam
```
public java.util.Map<gu.simplemq.redis.JedisPoolLazy.PropName,java.lang.Object> readRedisParam()
```
    根据SPI加载的RedisConfigProvider实例提供的参数创建Redis连接参数
    如果findConfigProvider()返回null则返回null
    
    返回:
    
    Redis连接参数
  - getMQConnParameters
```
public java.util.Map<java.lang.String,java.lang.Object> getMQConnParameters()
```
    指定者:
    
    getMQConnParameters 在接口中 gu.simplemq.IMQConnParameterSupplier
  - getImplType
```
public final gu.simplemq.MessageQueueType getImplType()
```
    指定者:
    
    getImplType 在接口中 gu.simplemq.IMQConnParameterSupplier
  - saveRedisParam
```
public void saveRedisParam(java.util.Map<gu.simplemq.redis.JedisPoolLazy.PropName,java.lang.Object> param)
```
    保存redis参数到当前类型对应的RedisConfigProvider实例
    
    参数:
    
    param - redis参数
  - resetActiveConfigType
```
public static void resetActiveConfigType()
```
    复位activeConfigType为null
    为避免#lookupConnect(Long)方法被多次执行，当activeConfigType不为null时直接返回activeConfigType的值，如果希望再次执行#lookupConnect(Long)方法，可先调用此方法设置activeConfigType为null
  - testConnect
```
public boolean testConnect(java.lang.Integer timeoutMills)
```
    测试redis连接
    
    参数:
    
    timeoutMills - 连接超时(毫秒),为null或小于等于0使用默认值
    
    返回:
    
    连接成功返回true,否则返回false
  - lookupConnect
```
public static RedisConfigType lookupConnect(java.lang.Integer timeoutMills)
                                     throws gu.simplemq.exceptions.SmqNotFoundConnectionException
```
    按照如下优先顺序测试配置的redis连接，返回第一个能建立有效连接的配置，否则抛出异常
    - CUSTOM
    - LAN
    - CLOUD
    - LOCALHOST
    参数:
    
    timeoutMills - 连接超时(毫秒),为null或小于等于0使用默认值
    
    返回:
    
    activeConfigType不为null时直接返回activeConfigType的值
    
    抛出:
    
    gu.simplemq.exceptions.SmqNotFoundConnectionException - 没有找到有效redis连接
  - lookupConnectUnchecked
```
public static RedisConfigType lookupConnectUnchecked(java.lang.Integer timeoutMills)
```
    与#lookupConnect(Long)功能相似,不同的时当没有找到有效redis连接时,不抛出异常,返回null
    
    参数:
    
    timeoutMills - 连接超时(毫秒),为null或小于等于0使用默认值
    
    返回:
    
    返回第一个能建立有效连接的配置,否则返回null
  - toString
```
public java.lang.String toString()
```
    覆盖:
    
    toString 在类中 java.lang.Enum<RedisConfigType>

枚举 RedisConfigType

枚举常量概要

方法概要

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

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

枚举常量详细资料

CUSTOM

LAN

CLOUD

LOCALHOST

方法详细资料

values

valueOf

getHostAndPort

readRedisParam

getMQConnParameters

getImplType

saveRedisParam

resetActiveConfigType

testConnect

lookupConnect

lookupConnectUnchecked

toString