AbsLockDecorator (Redis Lock 1.1.0 API)

java.lang.Object
- io.github.spring.tools.redis.decorator.AbsLockDecorator

所有已实现的接口:

ILock, ILockTemplate, ILockWritable, IRedisLock, AutoCloseable, Lock

直接已知子类:

ReentrantLockDecorator
```
public abstract class AbsLockDecorator
extends Object
implements IRedisLock, ILockWritable
```
共享锁包装器

版本:

1.2.0

作者:

Fenghu.Shi

字段概要

字段
限定符和类型字段和说明

protected IRedisLock delegate
处理实例

static int ORDER_DEFAULT
默认的序号
- 从接口继承的字段 io.github.spring.tools.redis.capable.ILockWritable
  DEFAULT_LOCK_SECONDS, DEFAULT_SLEEP_MAX_MILLS, DEFAULT_SLEEP_MIN_MILLS, DEFAULT_SPIN_TIME

字段
限定符和类型	字段和说明
`protected IRedisLock`	`delegate` 处理实例
`static int`	`ORDER_DEFAULT` 默认的序号

构造器概要

构造器
构造器和说明

AbsLockDecorator(IRedisLock delegate)
构造一个包装器实例

构造器
构造器和说明
`AbsLockDecorator(IRedisLock delegate)` 构造一个包装器实例

方法概要

所有方法实例方法抽象方法具体方法
限定符和类型	方法和说明
`protected void`	`debugMessage(String message)` 来一个 debug 消息
`protected void`	`errorMessage(String message)` 来一个 error 消息
`<T extends AbsLockDecorator> T`	`getDecoratorByClass(Class<T> clazz)` 获取特定 class 类型的装饰者实例
`String`	`getKey()` 获取锁的key
`RedisLockClient`	`getLockClient()` 获取锁的客户端
`int`	`getLockSeconds()` 需要锁定的时间
`protected abstract org.slf4j.Logger`	`getLogger()` 获取 logger 对象
`RedisLockReleaseStatus`	`getReleaseStatus()` 获取释放状态
`int`	`getSleepMaxMills()` 获取最大休眠时间
`int`	`getSleepMinMills()` 获取最小休眠时间，毫秒
`int`	`getSpinTimes()` 获取自旋次数
`RedisLockStatus`	`getStatus()` 获取所的状态
`protected void`	`infoMessage(String message)` 来一个 info 消息
`boolean`	`interrupted()` 取消当前锁，只对 NEW 状态可用
`boolean`	`isFinished()` 流程结束
`boolean`	`needUnlock()` 是否需要解锁
`void`	`setKey(String key)` 设置 key
`void`	`setLockSeconds(int lockSeconds)` 设置锁定时间，单位秒
`void`	`setReleaseStatus(RedisLockReleaseStatus releaseStatus)` 设置 release 状态
`void`	`setSleepMaxMills(int sleepMaxMills)` 设置休眠最大时间，单位毫秒
`void`	`setSleepMinMills(int sleepMinMills)` 设置休眠最小时间，单位毫秒
`void`	`setSpinTimes(int spinTimes)` 设置自旋次数
`void`	`setStatus(RedisLockStatus status)` 设置状态
`boolean`	`tryLock()`
`boolean`	`tryLock(long time, TimeUnit unit)`
`void`	`unlock()`
`void`	`unlocked(boolean release)` 成功并设置状态

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

从接口继承的方法 io.github.spring.tools.redis.capable.ILock
close, execute, isLocked, isRollback, lock, lockInterruptibly, newCondition

从接口继承的方法 io.github.spring.tools.redis.capable.ILockTemplate
execute, execute, execute, execute, execute

从接口继承的方法 io.github.spring.tools.redis.capable.ILockWritable
getSleepMills, inStates, isStatus

- 字段详细资料
  - delegate
```
protected IRedisLock delegate
```
    处理实例
  - ORDER_DEFAULT
```
public static final int ORDER_DEFAULT
```
    默认的序号
    
    另请参阅:
    
    常量字段值
- 构造器详细资料
  - AbsLockDecorator
```
public AbsLockDecorator(IRedisLock delegate)
```
    构造一个包装器实例
    
    参数:
    
    delegate - 实际执行者
- 方法详细资料
  - setStatus
```
public void setStatus(RedisLockStatus status)
```
    设置状态
    
    指定者:
    
    setStatus 在接口中 ILockWritable
    
    参数:
    
    status -
  - getStatus
```
public RedisLockStatus getStatus()
```
    从接口复制的说明: ILock
    
    获取所的状态
    
    指定者:
    
    getStatus 在接口中 ILock
    
    指定者:
    
    getStatus 在接口中 ILockWritable
    
    返回:
    
    当前状态
  - getKey
```
public String getKey()
```
    从接口复制的说明: ILock
    
    获取锁的key
    
    指定者:
    
    getKey 在接口中 ILock
    
    返回:
    
    当前 key
  - setKey
```
public void setKey(String key)
```
    从接口复制的说明: ILockWritable
    
    设置 key
    
    指定者:
    
    setKey 在接口中 ILockWritable
    
    参数:
    
    key - 要设置的key
  - getLockSeconds
```
public int getLockSeconds()
```
    从接口复制的说明: ILock
    
    需要锁定的时间
    
    指定者:
    
    getLockSeconds 在接口中 ILock
    
    指定者:
    
    getLockSeconds 在接口中 ILockWritable
    
    返回:
    
    当前设置的时间
  - needUnlock
```
public boolean needUnlock()
```
    从接口复制的说明: ILockWritable
    
    是否需要解锁
    
    指定者:
    
    needUnlock 在接口中 ILockWritable
    
    返回:
    
    是否需要解锁
  - isFinished
```
public boolean isFinished()
```
    从接口复制的说明: ILock
    
    流程结束
    
    指定者:
    
    isFinished 在接口中 ILock
    
    返回:
    
    是否结束
  - interrupted
```
public boolean interrupted()
```
    从接口复制的说明: ILock
    
    取消当前锁，只对 NEW 状态可用
    
    指定者:
    
    interrupted 在接口中 ILock
    
    返回:
    
    是否取消成功
  - getDecoratorByClass
```
public final <T extends AbsLockDecorator> T getDecoratorByClass(Class<T> clazz)
```
    获取特定 class 类型的装饰者实例
    
    类型参数:
    
    T - 类型
    
    参数:
    
    clazz - 类名
    
    返回:
    
    结果
  - getLogger
```
protected abstract org.slf4j.Logger getLogger()
```
    获取 logger 对象
    
    返回:
    
    对象
  - debugMessage
```
protected void debugMessage(String message)
```
    来一个 debug 消息
    
    参数:
    
    message - 消息
  - infoMessage
```
protected void infoMessage(String message)
```
    来一个 info 消息
    
    参数:
    
    message - 消息
  - errorMessage
```
protected void errorMessage(String message)
```
    来一个 error 消息
    
    参数:
    
    message - 消息
  - setLockSeconds
```
public void setLockSeconds(int lockSeconds)
```
    从接口复制的说明: ILockWritable
    
    设置锁定时间，单位秒
    
    指定者:
    
    setLockSeconds 在接口中 ILockWritable
    
    参数:
    
    lockSeconds - 要设置的锁定时长
  - unlocked
```
public void unlocked(boolean release)
```
    从接口复制的说明: ILockWritable
    
    成功并设置状态
    
    指定者:
    
    unlocked 在接口中 ILockWritable
    
    参数:
    
    release - 是否释放成功
  - getReleaseStatus
```
public RedisLockReleaseStatus getReleaseStatus()
```
    从接口复制的说明: ILock
    
    获取释放状态
    
    指定者:
    
    getReleaseStatus 在接口中 ILock
    
    返回:
    
    当期那状态
  - setReleaseStatus
```
public void setReleaseStatus(RedisLockReleaseStatus releaseStatus)
```
    从接口复制的说明: ILockWritable
    
    设置 release 状态
    
    指定者:
    
    setReleaseStatus 在接口中 ILockWritable
    
    参数:
    
    releaseStatus - 释放状态
  - setSleepMinMills
```
public void setSleepMinMills(int sleepMinMills)
```
    从接口复制的说明: ILockWritable
    
    设置休眠最小时间，单位毫秒
    
    指定者:
    
    setSleepMinMills 在接口中 ILockWritable
    
    参数:
    
    sleepMinMills - 最小休眠时间
  - getSleepMinMills
```
public int getSleepMinMills()
```
    从接口复制的说明: ILock
    
    获取最小休眠时间，毫秒
    
    指定者:
    
    getSleepMinMills 在接口中 ILock
    
    指定者:
    
    getSleepMinMills 在接口中 ILockWritable
    
    返回:
    
    当前最小休眠时间
  - setSleepMaxMills
```
public void setSleepMaxMills(int sleepMaxMills)
```
    从接口复制的说明: ILockWritable
    
    设置休眠最大时间，单位毫秒
    
    指定者:
    
    setSleepMaxMills 在接口中 ILockWritable
  - getSleepMaxMills
```
public int getSleepMaxMills()
```
    从接口复制的说明: ILock
    
    获取最大休眠时间
    
    指定者:
    
    getSleepMaxMills 在接口中 ILock
    
    指定者:
    
    getSleepMaxMills 在接口中 ILockWritable
    
    返回:
  - setSpinTimes
```
public void setSpinTimes(int spinTimes)
```
    从接口复制的说明: ILockWritable
    
    设置自旋次数
    
    指定者:
    
    setSpinTimes 在接口中 ILockWritable
  - getSpinTimes
```
public int getSpinTimes()
```
    从接口复制的说明: ILock
    
    获取自旋次数
    
    指定者:
    
    getSpinTimes 在接口中 ILock
    
    指定者:
    
    getSpinTimes 在接口中 ILockWritable
    
    返回:
  - tryLock
```
public boolean tryLock()
```
    指定者:
    
    tryLock 在接口中 Lock
  - tryLock
```
public boolean tryLock(long time,
                       TimeUnit unit)
                throws InterruptedException
```
    指定者:
    
    tryLock 在接口中 Lock
    
    抛出:
    
    InterruptedException
  - getLockClient
```
public RedisLockClient getLockClient()
```
    从接口复制的说明: ILockWritable
    
    获取锁的客户端
    
    指定者:
    
    getLockClient 在接口中 ILockWritable
    
    返回:
  - unlock
```
public void unlock()
```
    指定者:
    
    unlock 在接口中 Lock

类 AbsLockDecorator

字段概要

从接口继承的字段 io.github.spring.tools.redis.capable.ILockWritable

构造器概要

方法概要

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

从接口继承的方法 io.github.spring.tools.redis.capable.ILock

从接口继承的方法 io.github.spring.tools.redis.capable.ILockTemplate

从接口继承的方法 io.github.spring.tools.redis.capable.ILockWritable

字段详细资料

delegate

ORDER_DEFAULT

构造器详细资料

AbsLockDecorator

方法详细资料

setStatus

getStatus

getKey

setKey

getLockSeconds

needUnlock

isFinished

interrupted

getDecoratorByClass

getLogger

debugMessage

infoMessage

errorMessage

setLockSeconds

unlocked

getReleaseStatus

setReleaseStatus

setSleepMinMills

getSleepMinMills

setSleepMaxMills

getSleepMaxMills

setSpinTimes

getSpinTimes

tryLock

tryLock

getLockClient

unlock