org.voovan.tools.collection

Class RingBuffer<T>

java.lang.Object

org.voovan.tools.collection.RingBuffer<T>

public class RingBuffer<T>
extends Object

无锁环形队列

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_SIZE
Object[]	elements

Constructor Summary

Constructors

Constructor and Description
RingBuffer() 使用默认容量构造一个环形缓冲区
RingBuffer(int capacity) 使用指定容量构造一个环形缓冲区

Method Summary

Modifier and Type	Method and Description
int	avaliable() 缓冲区可写空间
void	clear() 清理缓冲区
T	get(int offset) 获得基于索引位置的数据
int	get(T[] t, int offset, int length) 读取所有缓冲区的数据 不影响读写位置
int	getCapacity() 获得容量
int	getReadPositon() 获得读指针位置
int	getWritePositon() 获得写指针位置
Boolean	isEmpty() 缓冲区空判断
Boolean	isFull() 缓冲区满判断
T	pop() 读取一个 byte
int	pop(T[] ts, int offset, int length) 读取缓冲区的数据
boolean	push(T t) 增加一个对象
int	push(T[] ts, int offset, int length) 写入一个 byte[] 数据
int	remaining() 缓冲区可用数据量
void	skip(int offset) 读指针跳过特定的偏移量
Object[]	toArray() 读取所有缓冲区的数据 不影响读写位置
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

DEFAULT_SIZE

public static final int DEFAULT_SIZE

See Also:

Constant Field Values

elements

public Object[] elements

Constructor Detail

RingBuffer

public RingBuffer()

使用默认容量构造一个环形缓冲区

RingBuffer

public RingBuffer(int capacity)

使用指定容量构造一个环形缓冲区

Parameters:

capacity - 分配的容量

Method Detail

getReadPositon

public int getReadPositon()

获得读指针位置

Returns:

读指针位置

getWritePositon

public int getWritePositon()

获得写指针位置

Returns:

写指针位置

getCapacity

public int getCapacity()

获得容量

Returns:

容量

skip

public void skip(int offset)

读指针跳过特定的偏移量

Parameters:

offset - 偏移量

isEmpty

public Boolean isEmpty()

缓冲区空判断

Returns:

true: 缓冲区无可用数据, false: 缓冲区有可用数据

isFull

public Boolean isFull()

缓冲区满判断

Returns:

true: 缓冲区已满, false: 缓冲区未满

clear

public void clear()

清理缓冲区

get

public T get(int offset)

获得基于索引位置的数据

Parameters:

offset - 偏移量

Returns:

byte 数据

get

public int get(T[] t,
               int offset,
               int length)

读取所有缓冲区的数据 不影响读写位置

Parameters:

t - 用于读取数据的 byte 数组

offset - 偏移量

length - 数据长度

Returns:

读取数据大小

toArray

public Object[] toArray()

读取所有缓冲区的数据 不影响读写位置

Returns:

读取数据

pop

public T pop()

读取一个 byte

Returns:

byte 数据

push

public boolean push(T t)

增加一个对象

Parameters:

t - 对象

Returns:

true: 成功, false: 失败

push

public int push(T[] ts,
                int offset,
                int length)

写入一个 byte[] 数据

Parameters:

ts - T[] 对象

offset - 针对 byte[] 的偏移量

length - 写入数据的长度

Returns:

写入数据长度

remaining

public int remaining()

缓冲区可用数据量

Returns:

缓冲区可用数据量

avaliable

public int avaliable()

缓冲区可写空间

Returns:

缓冲区可写空间

pop

public int pop(T[] ts,
               int offset,
               int length)

读取缓冲区的数据

Parameters:

ts - 用于读取数据的 byte 数组

offset - 偏移量

length - 读取数据的长度

Returns:

读取数据大小

toString

public String toString()

Overrides:

toString in class Object