Package org.redisson.api

Interface RBitSet

All Superinterfaces:

RBitSetAsync, RExpirable, RExpirableAsync, RObject, RObjectAsync

All Known Implementing Classes:

RedissonBitSet

public interface RBitSet
extends RExpirable, RBitSetAsync

Vector of bits that grows as needed.

Author:

Nikita Koksharov

Method Summary

Modifier and Type	Method	Description
long	and(String... bitSetNames)	Executes AND operation over this object and specified bitsets.
long	andOr(String... bitSetNames)	Executes bitwise ANDOR operation over this object and specified bitsets.
BitSet	asBitSet()
long	cardinality()	Returns the number of bits set to one.
void	clear()	Set all bits to zero
boolean	clear(long bitIndex)	Set bit to zero at specified bitIndex
void	clear(long fromIndex, long toIndex)	Set all bits to zero from fromIndex (inclusive) to toIndex (exclusive)
long	diff(String... bitSetNames)	Executes bitwise DIFF operation over this object and specified bitsets.
long	diffInverse(String... bitSetNames)	Executes bitwise DIFF1 operation over this object and specified bitsets.
boolean	get(long bitIndex)	Returns true if bit set to one and false overwise.
boolean[]	get(long... bitIndexes)	Returns a boolean array where each element of the array corresponds to the query result of the input parameters.
byte	getByte(long offset)	Returns byte number at specified offset
int	getInteger(long offset)	Returns integer number at specified offset
long	getLong(long offset)	Returns long number at specified offset
short	getShort(long offset)	Returns short number at specified offset
long	getSigned(int size, long offset)	Returns signed number at specified offset and size
long	getUnsigned(int size, long offset)	Returns unsigned number at specified offset and size
byte	incrementAndGetByte(long offset, byte increment)	Increments current byte value on defined increment value at specified offset and returns result.
int	incrementAndGetInteger(long offset, int increment)	Increments current integer value on defined increment value at specified offset and returns result.
long	incrementAndGetLong(long offset, long increment)	Increments current long value on defined increment value at specified offset and returns result.
short	incrementAndGetShort(long offset, short increment)	Increments current short value on defined increment value at specified offset and returns result.
long	incrementAndGetSigned(int size, long offset, long increment)	Increments current signed value by defined increment value and size at specified offset and returns result.
long	incrementAndGetUnsigned(int size, long offset, long increment)	Increments current unsigned value by defined increment value and size at specified offset and returns result.
long	length()	Returns "logical size" = index of highest set bit plus one.
long	not()	Executes NOT operation over all bits
long	or(String... bitSetNames)	Executes OR operation over this object and specified bitsets.
boolean	set(long bitIndex)	Set bit to one at specified bitIndex
void	set(long[] indexArray, boolean value)	Set all bits to value which index in indexArray
boolean	set(long bitIndex, boolean value)	Set bit to value at specified bitIndex
void	set(long fromIndex, long toIndex)	Set all bits to one from fromIndex (inclusive) to toIndex (exclusive)
void	set(long fromIndex, long toIndex, boolean value)	Set all bits to value from fromIndex (inclusive) to toIndex (exclusive)
void	set(BitSet bs)	Copy bits state of source BitSet object to this object
byte	setByte(long offset, byte value)	Returns previous value of byte number and replaces it with defined value at specified offset
long	setExclusive(String... bitSetNames)	Executes bitwise ONE operation over this object and specified bitsets.
int	setInteger(long offset, int value)	Returns previous value of integer number and replaces it with defined value at specified offset
long	setLong(long offset, long value)	Returns previous value of long number and replaces it with defined value at specified offset
short	setShort(long offset, short value)	Returns previous value of short number and replaces it with defined value at specified offset
long	setSigned(int size, long offset, long value)	Returns previous value of signed number and replaces it with defined value at specified offset
long	setUnsigned(int size, long offset, long value)	Returns previous value of unsigned number and replaces it with defined value at specified offset
long	size()	Returns number of set bits.
byte[]	toByteArray()
long	xor(String... bitSetNames)	Executes XOR operation over this object and specified bitsets.

Methods inherited from interface org.redisson.api.RBitSetAsync

andAsync, andOrAsync, cardinalityAsync, clearAsync, clearAsync, clearAsync, diffAsync, diffInverseAsync, getAsync, getAsync, getByteAsync, getIntegerAsync, getLongAsync, getShortAsync, getSignedAsync, getUnsignedAsync, incrementAndGetByteAsync, incrementAndGetIntegerAsync, incrementAndGetLongAsync, incrementAndGetShortAsync, incrementAndGetSignedAsync, incrementAndGetUnsignedAsync, lengthAsync, notAsync, orAsync, setAsync, setAsync, setAsync, setAsync, setAsync, setAsync, setByteAsync, setExclusiveAsync, setIntegerAsync, setLongAsync, setShortAsync, setSignedAsync, setUnsignedAsync, sizeAsync, toByteArrayAsync, xorAsync

Methods inherited from interface org.redisson.api.RExpirable

clearExpire, expire, expire, expire, expireAt, expireAt, expireIfGreater, expireIfGreater, expireIfLess, expireIfLess, expireIfNotSet, expireIfNotSet, expireIfSet, expireIfSet, getExpireTime, remainTimeToLive

Methods inherited from interface org.redisson.api.RExpirableAsync

clearExpireAsync, expireAsync, expireAsync, expireAsync, expireAtAsync, expireAtAsync, expireIfGreaterAsync, expireIfGreaterAsync, expireIfLessAsync, expireIfLessAsync, expireIfNotSetAsync, expireIfNotSetAsync, expireIfSetAsync, expireIfSetAsync, getExpireTimeAsync, remainTimeToLiveAsync

Methods inherited from interface org.redisson.api.RObject

addListener, copy, copy, copy, copyAndReplace, copyAndReplace, delete, dump, getAccessFrequency, getCodec, getIdleTime, getInternalEncoding, getName, getReferenceCount, isExists, migrate, move, removeListener, rename, renamenx, restore, restore, restoreAndReplace, restoreAndReplace, sizeInMemory, touch, unlink

Methods inherited from interface org.redisson.api.RObjectAsync

addListenerAsync, copyAndReplaceAsync, copyAndReplaceAsync, copyAsync, copyAsync, copyAsync, deleteAsync, dumpAsync, getAccessFrequencyAsync, getIdleTimeAsync, getInternalEncodingAsync, getReferenceCountAsync, isExistsAsync, migrateAsync, moveAsync, removeListenerAsync, renameAsync, renamenxAsync, restoreAndReplaceAsync, restoreAndReplaceAsync, restoreAsync, restoreAsync, sizeInMemoryAsync, touchAsync, unlinkAsync

Method Details

getSigned

long getSigned(int size,
 long offset)

Returns signed number at specified offset and size

Parameters:

size - - size of signed number up to 64 bits

offset - - offset of signed number

Returns:

signed number

setSigned

long setSigned(int size,
 long offset,
 long value)

Returns previous value of signed number and replaces it with defined value at specified offset

Parameters:

size - - size of signed number up to 64 bits

offset - - offset of signed number

value - - value of signed number

Returns:

previous value of signed number

incrementAndGetSigned

long incrementAndGetSigned(int size,
 long offset,
 long increment)

Increments current signed value by defined increment value and size at specified offset and returns result.

Parameters:

size - - size of signed number up to 64 bits

offset - - offset of signed number

increment - - increment value

Returns:

result value

getUnsigned

long getUnsigned(int size,
 long offset)

Returns unsigned number at specified offset and size

Parameters:

size - - size of unsigned number up to 64 bits

offset - - offset of unsigned number

Returns:

unsigned number

setUnsigned

long setUnsigned(int size,
 long offset,
 long value)

Returns previous value of unsigned number and replaces it with defined value at specified offset

Parameters:

size - - size of unsigned number up to 64 bits

offset - - offset of unsigned number

value - - value of unsigned number

Returns:

previous value of unsigned number

incrementAndGetUnsigned

long incrementAndGetUnsigned(int size,
 long offset,
 long increment)

Increments current unsigned value by defined increment value and size at specified offset and returns result.

Parameters:

size - - size of unsigned number up to 64 bits

offset - - offset of unsigned number

increment - - increment value

Returns:

result value

getByte

byte getByte(long offset)

Returns byte number at specified offset

Parameters:

offset - - offset of number

Returns:

number

setByte

byte setByte(long offset,
 byte value)

Returns previous value of byte number and replaces it with defined value at specified offset

Parameters:

offset - - offset of number

value - - value of number

Returns:

previous value of number

incrementAndGetByte

byte incrementAndGetByte(long offset,
 byte increment)

Increments current byte value on defined increment value at specified offset and returns result.

Parameters:

offset - - offset of number

increment - - increment value

Returns:

result value

getShort

short getShort(long offset)

Returns short number at specified offset

Parameters:

offset - - offset of number

Returns:

number

setShort

short setShort(long offset,
 short value)

Returns previous value of short number and replaces it with defined value at specified offset

Parameters:

offset - - offset of number

value - - value of number

Returns:

previous value of number

incrementAndGetShort

short incrementAndGetShort(long offset,
 short increment)

Increments current short value on defined increment value at specified offset and returns result.

Parameters:

offset - - offset of number

increment - - increment value

Returns:

result value

getInteger

int getInteger(long offset)

Returns integer number at specified offset

Parameters:

offset - - offset of number

Returns:

number

setInteger

int setInteger(long offset,
 int value)

Returns previous value of integer number and replaces it with defined value at specified offset

Parameters:

offset - - offset of number

value - - value of number

Returns:

previous value of number

incrementAndGetInteger

int incrementAndGetInteger(long offset,
 int increment)

Increments current integer value on defined increment value at specified offset and returns result.

Parameters:

offset - - offset of number

increment - - increment value

Returns:

result value

getLong

long getLong(long offset)

Returns long number at specified offset

Parameters:

offset - - offset of number

Returns:

number

setLong

long setLong(long offset,
 long value)

Returns previous value of long number and replaces it with defined value at specified offset

Parameters:

offset - - offset of number

value - - value of number

Returns:

previous value of number

incrementAndGetLong

long incrementAndGetLong(long offset,
 long increment)

Increments current long value on defined increment value at specified offset and returns result.

Parameters:

offset - - offset of number

increment - - increment value

Returns:

result value

length

long length()

Returns "logical size" = index of highest set bit plus one. Returns zero if there are no any set bit.

Returns:

"logical size" = index of highest set bit plus one

set

void set(long fromIndex,
 long toIndex,
 boolean value)

Set all bits to value from fromIndex (inclusive) to toIndex (exclusive)

Parameters:

fromIndex - inclusive

toIndex - exclusive

value - true = 1, false = 0

clear

void clear(long fromIndex,
 long toIndex)

Set all bits to zero from fromIndex (inclusive) to toIndex (exclusive)

Parameters:

fromIndex - inclusive

toIndex - exclusive

set

void set(BitSet bs)

Copy bits state of source BitSet object to this object

Parameters:

bs - - BitSet source

set

void set(long[] indexArray,
 boolean value)

Set all bits to value which index in indexArray

Parameters:

indexArray - The index array of bits that needs to be set to value

value - true = 1, false = 0

not

long not()

Executes NOT operation over all bits

Returns:

length in bytes of the destination key

set

void set(long fromIndex,
 long toIndex)

Set all bits to one from fromIndex (inclusive) to toIndex (exclusive)

Parameters:

fromIndex - inclusive

toIndex - exclusive

size

long size()

Returns number of set bits.

Returns:

number of set bits.

get

boolean get(long bitIndex)

Returns true if bit set to one and false overwise.

Parameters:

bitIndex - - index of bit

Returns:

true if bit set to one and false overwise.

get

boolean[] get(long... bitIndexes)

Returns a boolean array where each element of the array corresponds to the query result of the input parameters.

Parameters:

bitIndexes - indexes of bit

Returns:

Returns a boolean array where each element of the array corresponds to the query result of the input parameters.

set

boolean set(long bitIndex)

Set bit to one at specified bitIndex

Parameters:

bitIndex - - index of bit

Returns:

true - if previous value was true, false - if previous value was false

set

boolean set(long bitIndex,
 boolean value)

Set bit to value at specified bitIndex

Parameters:

bitIndex - - index of bit

value - true = 1, false = 0

Returns:

true - if previous value was true, false - if previous value was false

toByteArray

byte[] toByteArray()

cardinality

long cardinality()

Returns the number of bits set to one.

Returns:

number of bits

clear

boolean clear(long bitIndex)

Set bit to zero at specified bitIndex

Parameters:

bitIndex - - index of bit

Returns:

true - if previous value was true, false - if previous value was false

clear

void clear()

Set all bits to zero

asBitSet

BitSet asBitSet()

or

long or(String... bitSetNames)

Executes OR operation over this object and specified bitsets. Stores result into this object.

Parameters:

bitSetNames - - name of stored bitsets

Returns:

length in bytes of the destination key

and

long and(String... bitSetNames)

Executes AND operation over this object and specified bitsets. Stores result into this object.

Parameters:

bitSetNames - - name of stored bitsets

Returns:

length in bytes of the destination key

xor

long xor(String... bitSetNames)

Executes XOR operation over this object and specified bitsets. Stores result into this object.

Parameters:

bitSetNames - - name of stored bitsets

Returns:

length in bytes of the destination key

diff

long diff(String... bitSetNames)

Executes bitwise DIFF operation over this object and specified bitsets. Sets bits that are set in this object but not in any of the other bitsets. Stores result into this object.

Parameters:

bitSetNames - name of stored bitsets

Returns:

length in bytes of the destination key

diffInverse

long diffInverse(String... bitSetNames)

Executes bitwise DIFF1 operation over this object and specified bitsets. Sets bits that are set in one or more of the other bitsets but not in this object. Stores result into this object.

Parameters:

bitSetNames - name of stored bitsets

Returns:

length in bytes of the destination key

andOr

long andOr(String... bitSetNames)

Executes bitwise ANDOR operation over this object and specified bitsets. Sets bits that are set in this object AND also in one or more of the other bitsets. Stores result into this object.

Parameters:

bitSetNames - name of stored bitsets

Returns:

length in bytes of the destination key

setExclusive

long setExclusive(String... bitSetNames)

Executes bitwise ONE operation over this object and specified bitsets. Sets bits that are set in exactly one of the provided bitsets. Stores result into this object.

Parameters:

bitSetNames - name of stored bitsets

Returns:

length in bytes of the destination key