RedisList (exp-libs-db 2.0.0 API)

java.lang.Object
- exp.libs.db.redis.bean.RedisList<E>

public class RedisList<E extends Serializable>
extends Object

 Redis-List对象.
 模仿LinkedList的使用习惯进行封装.
 ------------------------------
 
 使用样例:
 
 final String LIST_IN_REDIS_KEY = "list在Redis中的键名（自定义且需唯一）";
 RedisClient redis = new RedisClient("127.0.0.1", 6379);    // redis连接客户端（支持单机/集群）
 
 RedisList<自定义对象> list = new RedisList<自定义对象>(LIST_IN_REDIS_KEY, redis);
 list.add(element);
 list.addAll(elements);
 list.isEmpty();
 list.size();
 list.getAll();
 list.remove(element);
 list.clear();
 
 redis.close(); // 断开redis连接

PROJECT : exp-libs
SUPPORT : https://exp-blog.com

从以下版本开始:: JDK 1.8+
版本:: 2022-03-06
作者:: EXP: exp.lqb@foxmail.com

字段概要

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

protected static org.slf4j.Logger log
日志器

protected RedisClient redis
Redis连接客户端对象

字段
限定符和类型	字段和说明
`protected static org.slf4j.Logger`	`log` 日志器
`protected RedisClient`	`redis` Redis连接客户端对象

构造器概要

构造器
构造器和说明

RedisList(String listName, RedisClient redis)
构造函数

构造器
构造器和说明
`RedisList(String listName, RedisClient redis)` 构造函数

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`boolean`	`add(E e)` 实时在redis缓存中向此列表添加一个元素（添加到尾部）
`boolean`	`addAll(E... es)` 实时在redis缓存中向此列表添加若干个元素（添加到尾部）
`boolean`	`addAll(List<E> es)` 实时在redis缓存中向此列表添加若干个元素（添加到尾部）
`boolean`	`addToHead(E e)` 实时在redis缓存中向此列表添加一个元素（添加到头部）
`boolean`	`addToTail(E e)` 实时在redis缓存中向此列表添加一个元素（添加到尾部）
`boolean`	`clear()` 实时在redis缓存中删除此列表
`E`	`get(long index)` 实时在redis缓存中查询此列表中的一个元素
`List<E>`	`getAll()` 实时在redis缓存中查询此列表的所有元素
`boolean`	`isEmpty()` 实时在redis缓存中检查此列表是否为空
`long`	`remove(E... es)` 实时在redis缓存中删除此列表的若干个元素
`protected void`	`setTypeObj()`
`protected void`	`setTypeStr()`
`long`	`size()` 实时在redis缓存中查询此列表的大小
`protected boolean`	`typeIsNone()`
`protected boolean`	`typeIsObj()`
`protected boolean`	`typeIsStr()`

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

- 字段详细资料
  - log
```
protected static final org.slf4j.Logger log
```
    日志器
  - redis
```
protected RedisClient redis
```
    Redis连接客户端对象
- 构造器详细资料
  - RedisList
```
public RedisList(String listName,
                 RedisClient redis)
```
    构造函数
    
    参数:
    
    listName - 此列表在redis中的键名（需确保不为空）
    
    redis - redis客户端连接对象（需确保可用）
- 方法详细资料
  - isEmpty
```
public boolean isEmpty()
```
    实时在redis缓存中检查此列表是否为空
    
    返回:
    
    true:为空; false:非空
  - size
```
public long size()
```
    实时在redis缓存中查询此列表的大小
    
    返回:
    
    列表的大小
  - add
```
public boolean add(E e)
```
    实时在redis缓存中向此列表添加一个元素（添加到尾部）
    
    参数:
    
    e - 新元素
    
    返回:
    
    true:添加成功; false:添加失败
  - addToHead
```
public boolean addToHead(E e)
```
    实时在redis缓存中向此列表添加一个元素（添加到头部）
    
    参数:
    
    e - 新元素
    
    返回:
    
    true:添加成功; false:添加失败
  - addToTail
```
public boolean addToTail(E e)
```
    实时在redis缓存中向此列表添加一个元素（添加到尾部）
    
    参数:
    
    e - 新元素
    
    返回:
    
    true:添加成功; false:添加失败
  - addAll
```
public boolean addAll(E... es)
```
    实时在redis缓存中向此列表添加若干个元素（添加到尾部）
    
    参数:
    
    es - 新元素集
    
    返回:
    
    true:添加成功; false:添加失败
  - addAll
```
public boolean addAll(List<E> es)
```
    实时在redis缓存中向此列表添加若干个元素（添加到尾部）
    
    参数:
    
    es - 新元素集
    
    返回:
    
    true:添加成功; false:添加失败
  - get
```
public E get(long index)
```
    实时在redis缓存中查询此列表中的一个元素
    
    参数:
    
    index - 被查询的元素索引（第一个元素为0, 最后一个元素为-1, 正数索引为从前向后数, 负数索引为从后向前数）
    
    返回:
    
    对应的值（若不存在返回null）
  - getAll
```
public List<E> getAll()
```
    实时在redis缓存中查询此列表的所有元素
    
    返回:
    
    所有元素集（即使为空也只会返回空表，不会返回null）
  - remove
```
public long remove(E... es)
```
    实时在redis缓存中删除此列表的若干个元素
    
    参数:
    
    es - 被删除的元素集
    
    返回:
    
    已成功删除的数量
  - clear
```
public boolean clear()
```
    实时在redis缓存中删除此列表
    
    返回:
    
    true:删除成功; false:删除失败
  - typeIsNone
```
protected boolean typeIsNone()
```
  - typeIsStr
```
protected boolean typeIsStr()
```
  - typeIsObj
```
protected boolean typeIsObj()
```
  - setTypeStr
```
protected void setTypeStr()
```
  - setTypeObj
```
protected void setTypeObj()
```

类 RedisList<E extends Serializable>

字段概要

构造器概要

方法概要

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

字段详细资料

log

redis

构造器详细资料

RedisList

方法详细资料

isEmpty

size

add

addToHead

addToTail

addAll

addAll

get

getAll

remove

clear

typeIsNone

typeIsStr

typeIsObj

setTypeStr

setTypeObj