Package org.redisson

Class RedissonTimeSeries<V>

java.lang.Object

org.redisson.RedissonObject

org.redisson.RedissonTimeSeries<V>

All Implemented Interfaces:

Iterable<V>, RDestroyable, RExpirable, RExpirableAsync, RObject, RObjectAsync, RTimeSeries<V>, RTimeSeriesAsync<V>

public class RedissonTimeSeries<V>
extends RedissonObject
implements RTimeSeries<V>

Author:

Nikita Koksharov

Field Summary

Fields inherited from class org.redisson.RedissonObject

codec, commandExecutor, name

Constructor Summary

Constructors

Constructor	Description
RedissonTimeSeries(Codec codec, EvictionScheduler evictionScheduler, CommandAsyncExecutor connectionManager, String name)
RedissonTimeSeries(EvictionScheduler evictionScheduler, CommandAsyncExecutor connectionManager, String name)

Method Summary

Modifier and Type	Method	Description
void	add(long timestamp, V value)	Adds element to this time-series collection by specified timestamp.
void	add(long timestamp, V value, long timeToLive, TimeUnit timeUnit)	Adds element to this time-series collection by specified timestamp.
void	addAll(Map<Long,V> objects)	Adds all elements contained in the specified map to this time-series collection.
void	addAll(Map<Long,V> objects, long timeToLive, TimeUnit timeUnit)	Adds all elements contained in the specified map to this time-series collection.
RFuture<Void>	addAllAsync(Map<Long,V> objects)	Adds all elements contained in the specified map to this time-series collection.
RFuture<Void>	addAllAsync(Map<Long,V> objects, long timeToLive, TimeUnit timeUnit)	Adds all elements contained in the specified map to this time-series collection.
RFuture<Void>	addAsync(long timestamp, V object)	Adds element to this time-series collection by specified timestamp.
RFuture<Void>	addAsync(long timestamp, V object, long timeToLive, TimeUnit timeUnit)	Adds element to this time-series collection by specified timestamp.
boolean	clearExpire()	Clear an expire timeout or expire date for object.
RFuture<Boolean>	clearExpireAsync()	Clear an expire timeout or expire date for object in async mode.
protected RFuture<Boolean>	clearExpireAsync(String... keys)
RFuture<Boolean>	deleteAsync()	Delete object in async mode
void	destroy()	Destroys object when it's not necessary anymore.
Collection<TimeSeriesEntry<V>>	entryRange(long startTimestamp, long endTimestamp)	Returns ordered entries of this time-series collection within timestamp range.
Collection<TimeSeriesEntry<V>>	entryRange(long startTimestamp, long endTimestamp, int limit)	Returns ordered entries of this time-series collection within timestamp range.
RFuture<Collection<TimeSeriesEntry<V>>>	entryRangeAsync(long startTimestamp, long endTimestamp)	Returns ordered entries of this time-series collection within timestamp range.
RFuture<Collection<TimeSeriesEntry<V>>>	entryRangeAsync(long startTimestamp, long endTimestamp, int limit)	Returns ordered entries of this time-series collection within timestamp range.
Collection<TimeSeriesEntry<V>>	entryRangeReversed(long startTimestamp, long endTimestamp)	Returns entries of this time-series collection in reverse order within timestamp range.
Collection<TimeSeriesEntry<V>>	entryRangeReversed(long startTimestamp, long endTimestamp, int limit)	Returns entries of this time-series collection in reverse order within timestamp range.
RFuture<Collection<TimeSeriesEntry<V>>>	entryRangeReversedAsync(long startTimestamp, long endTimestamp)	Returns entries of this time-series collection in reverse order within timestamp range.
RFuture<Collection<TimeSeriesEntry<V>>>	entryRangeReversedAsync(long startTimestamp, long endTimestamp, int limit)	Returns entries of this time-series collection in reverse order within timestamp range.
boolean	expire(long timeToLive, TimeUnit timeUnit)	Use RExpirable.expire(Duration) instead
boolean	expire(Duration duration)	Sets a timeout for this object.
boolean	expire(Instant instant)	Sets an expiration date for this object.
RFuture<Boolean>	expireAsync(long timeToLive, TimeUnit timeUnit)	Use RExpirableAsync.expireAsync(Duration) instead
RFuture<Boolean>	expireAsync(long timeToLive, TimeUnit timeUnit, String param, String... keys)
RFuture<Boolean>	expireAsync(Duration duration)	Set a timeout for object.
RFuture<Boolean>	expireAsync(Instant instant)	Set an expire date for object.
boolean	expireAt(long timestamp)	Use RExpirable.expire(Instant) instead
boolean	expireAt(Date timestamp)	Use RExpirable.expire(Instant) instead
RFuture<Boolean>	expireAtAsync(long timestamp)	Use RExpirableAsync.expireAsync(Instant) instead
protected RFuture<Boolean>	expireAtAsync(long timestamp, String param, String... keys)
RFuture<Boolean>	expireAtAsync(Date timestamp)	Use RExpirableAsync.expireAsync(Instant) instead
boolean	expireIfGreater(Duration duration)	Sets a timeout for this object only if it's greater than timeout set before.
boolean	expireIfGreater(Instant time)	Sets an expiration date for this object only if it's greater than expiration date set before.
RFuture<Boolean>	expireIfGreaterAsync(Duration duration)
RFuture<Boolean>	expireIfGreaterAsync(Instant time)
boolean	expireIfLess(Duration duration)	Sets a timeout for this object only if it's less than timeout set before.
boolean	expireIfLess(Instant time)	Sets an expiration date for this object only if it's less than expiration date set before.
RFuture<Boolean>	expireIfLessAsync(Duration duration)
RFuture<Boolean>	expireIfLessAsync(Instant time)
boolean	expireIfNotSet(Duration duration)	Sets a timeout for this object only if it hasn't been set before.
boolean	expireIfNotSet(Instant time)	Sets an expiration date for this object only if it hasn't been set before.
RFuture<Boolean>	expireIfNotSetAsync(Duration duration)
RFuture<Boolean>	expireIfNotSetAsync(Instant time)
boolean	expireIfSet(Duration duration)	Sets a timeout for this object only if it has been already set.
boolean	expireIfSet(Instant time)	Sets an expiration date for this object only if it has been already set.
RFuture<Boolean>	expireIfSetAsync(Duration duration)
RFuture<Boolean>	expireIfSetAsync(Instant time)
V	first()	Returns the head element or null if this time-series collection is empty.
Collection<V>	first(int count)	Returns the head elements of this time-series collection.
RFuture<V>	firstAsync()	Returns the head element or null if this time-series collection is empty.
RFuture<Collection<V>>	firstAsync(int count)	Returns the head elements of this time-series collection.
Long	firstTimestamp()	Returns timestamp of the head timestamp or null if this time-series collection is empty.
RFuture<Long>	firstTimestampAsync()	Returns timestamp of the head timestamp or null if this time-series collection is empty.
V	get(long timestamp)	Returns object by specified timestamp or null if it doesn't exist.
RFuture<V>	getAsync(long timestamp)	Returns object by specified timestamp or null if it doesn't exist.
long	getExpireTime()	Expiration time of Redisson object that has a timeout
RFuture<Long>	getExpireTimeAsync()	Expiration time of Redisson object that has a timeout
Iterator<V>	iterator()
Iterator<V>	iterator(int count)	Returns an iterator over elements in this time-series collection.
V	last()	Returns the tail element or null if this time-series collection is empty.
Collection<V>	last(int count)	Returns the tail elements of this time-series collection.
RFuture<V>	lastAsync()	Returns the tail element or null if this time-series collection is empty.
RFuture<Collection<V>>	lastAsync(int count)	Returns the tail elements of this time-series collection.
Long	lastTimestamp()	Returns timestamp of the tail element or null if this time-series collection is empty.
RFuture<Long>	lastTimestampAsync()	Returns timestamp of the tail element or null if this time-series collection is empty.
V	pollFirst()	Removes and returns the head element or null if this time-series collection is empty.
Collection<V>	pollFirst(int count)	Removes and returns the head elements or null if this time-series collection is empty.
RFuture<V>	pollFirstAsync()	Removes and returns the head element or null if this time-series collection is empty.
RFuture<Collection<V>>	pollFirstAsync(int count)	Removes and returns the head elements or null if this time-series collection is empty.
V	pollLast()	Removes and returns the tail element or null if this time-series collection is empty.
Collection<V>	pollLast(int count)	Removes and returns the tail elements or null if this time-series collection is empty.
RFuture<V>	pollLastAsync()	Removes and returns the tail element or null if this time-series collection is empty.
RFuture<Collection<V>>	pollLastAsync(int count)	Removes and returns the tail elements or null if this time-series collection is empty.
Collection<V>	range(long startTimestamp, long endTimestamp)	Returns ordered elements of this time-series collection within timestamp range.
Collection<V>	range(long startTimestamp, long endTimestamp, int limit)	Returns ordered elements of this time-series collection within timestamp range.
RFuture<Collection<V>>	rangeAsync(long startTimestamp, long endTimestamp)	Returns ordered elements of this time-series collection within timestamp range.
RFuture<Collection<V>>	rangeAsync(long startTimestamp, long endTimestamp, int limit)	Returns ordered elements of this time-series collection within timestamp range.
Collection<V>	rangeReversed(long startTimestamp, long endTimestamp)	Returns elements of this time-series collection in reverse order within timestamp range.
Collection<V>	rangeReversed(long startTimestamp, long endTimestamp, int limit)	Returns elements of this time-series collection in reverse order within timestamp range.
RFuture<Collection<V>>	rangeReversedAsync(long startTimestamp, long endTimestamp)	Returns elements of this time-series collection in reverse order within timestamp range.
RFuture<Collection<V>>	rangeReversedAsync(long startTimestamp, long endTimestamp, int limit)	Returns elements of this time-series collection in reverse order within timestamp range.
long	remainTimeToLive()	Remaining time to live of Redisson object that has a timeout
RFuture<Long>	remainTimeToLiveAsync()	Remaining time to live of Redisson object that has a timeout
boolean	remove(long timestamp)	Removes object by specified timestamp.
RFuture<Boolean>	removeAsync(long timestamp)	Removes object by specified timestamp.
int	removeRange(long startTimestamp, long endTimestamp)	Removes values within timestamp range.
RFuture<Integer>	removeRangeAsync(long startTimestamp, long endTimestamp)	Removes values within timestamp range.
ListScanResult<Object>	scanIterator(String name, RedisClient client, long startPos, int count)
RFuture<ListScanResult<Object>>	scanIteratorAsync(String name, RedisClient client, long startPos, int count)
int	size()	Returns size of this set.
RFuture<Integer>	sizeAsync()	Returns size of this set.
RFuture<Long>	sizeInMemoryAsync()	Returns bytes amount used by object in Redis memory.
Stream<V>	stream()	Returns stream of elements in this time-series collection.
Stream<V>	stream(int count)	Returns stream of elements in this time-series collection.

Methods inherited from class org.redisson.RedissonObject

addListener, addListener, addListenerAsync, addListenerAsync, copy, copyAsync, delete, deleteAsync, dump, dumpAsync, encode, encode, encode, encode, encodeMapKey, encodeMapKeys, encodeMapValue, encodeMapValues, get, getCodec, getIdleTime, getIdleTimeAsync, getLockByMapKey, getLockByValue, getName, getRawName, getRawName, isExists, isExistsAsync, migrate, migrateAsync, move, moveAsync, prefixName, removeListener, removeListenerAsync, rename, renameAsync, renamenx, renamenxAsync, restore, restore, restoreAndReplace, restoreAndReplace, restoreAndReplaceAsync, restoreAndReplaceAsync, restoreAsync, restoreAsync, setName, sizeInMemory, sizeInMemoryAsync, sizeInMemoryAsync, suffixName, toSeconds, toStream, touch, touchAsync, unlink, unlinkAsync

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

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

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, delete, dump, getCodec, getIdleTime, getName, isExists, migrate, move, removeListener, rename, renamenx, restore, restore, restoreAndReplace, restoreAndReplace, sizeInMemory, touch, unlink

Methods inherited from interface org.redisson.api.RObjectAsync

addListenerAsync, copyAsync, dumpAsync, getIdleTimeAsync, isExistsAsync, migrateAsync, moveAsync, removeListenerAsync, renameAsync, renamenxAsync, restoreAndReplaceAsync, restoreAndReplaceAsync, restoreAsync, restoreAsync, touchAsync, unlinkAsync

Constructor Detail

RedissonTimeSeries

public RedissonTimeSeries(EvictionScheduler evictionScheduler,
                          CommandAsyncExecutor connectionManager,
                          String name)

RedissonTimeSeries

public RedissonTimeSeries(Codec codec,
                          EvictionScheduler evictionScheduler,
                          CommandAsyncExecutor connectionManager,
                          String name)

Method Detail

add

public void add(long timestamp,
                V value)

Description copied from interface: RTimeSeries

Adds element to this time-series collection by specified timestamp.

Specified by:

add in interface RTimeSeries<V>

Parameters:

timestamp - - object timestamp

value - - object itself

addAsync

public RFuture<Void> addAsync(long timestamp,
                              V object)

Description copied from interface: RTimeSeriesAsync

Adds element to this time-series collection by specified timestamp.

Specified by:

addAsync in interface RTimeSeriesAsync<V>

Parameters:

timestamp - - object timestamp

object - - object itself

Returns:

void

addAll

public void addAll(Map<Long,V> objects)

Description copied from interface: RTimeSeries

Adds all elements contained in the specified map to this time-series collection. Map contains of timestamp mapped by object.

Specified by:

addAll in interface RTimeSeries<V>

Parameters:

objects - - map of elements to add

add

public void add(long timestamp,
                V value,
                long timeToLive,
                TimeUnit timeUnit)

Description copied from interface: RTimeSeries

Adds element to this time-series collection by specified timestamp.

Specified by:

add in interface RTimeSeries<V>

Parameters:

timestamp - - object timestamp

value - - object itself

timeToLive - - time to live interval

timeUnit - - unit of time to live interval

addAsync

public RFuture<Void> addAsync(long timestamp,
                              V object,
                              long timeToLive,
                              TimeUnit timeUnit)

Description copied from interface: RTimeSeriesAsync

Adds element to this time-series collection by specified timestamp.

Specified by:

addAsync in interface RTimeSeriesAsync<V>

Parameters:

timestamp - - object timestamp

object - - object itself

timeToLive - - time to live interval

timeUnit - - unit of time to live interval

Returns:

void

addAll

public void addAll(Map<Long,V> objects,
                   long timeToLive,
                   TimeUnit timeUnit)

Description copied from interface: RTimeSeries

Adds all elements contained in the specified map to this time-series collection. Map contains of timestamp mapped by object.

Specified by:

addAll in interface RTimeSeries<V>

Parameters:

objects - - map of elements to add

timeToLive - - time to live interval

timeUnit - - unit of time to live interval

addAllAsync

public RFuture<Void> addAllAsync(Map<Long,V> objects)

Description copied from interface: RTimeSeriesAsync

Adds all elements contained in the specified map to this time-series collection. Map contains of timestamp mapped by object.

Specified by:

addAllAsync in interface RTimeSeriesAsync<V>

Parameters:

objects - - map of elements to add

Returns:

void

addAllAsync

public RFuture<Void> addAllAsync(Map<Long,V> objects,
                                 long timeToLive,
                                 TimeUnit timeUnit)

Description copied from interface: RTimeSeriesAsync

Adds all elements contained in the specified map to this time-series collection. Map contains of timestamp mapped by object.

Specified by:

addAllAsync in interface RTimeSeriesAsync<V>

Parameters:

objects - - map of elements to add

timeToLive - - time to live interval

timeUnit - - unit of time to live interval

Returns:

void

size

public int size()

Description copied from interface: RTimeSeries

Returns size of this set.

Specified by:

size in interface RTimeSeries<V>

Returns:

size

sizeAsync

public RFuture<Integer> sizeAsync()

Description copied from interface: RTimeSeriesAsync

Returns size of this set.

Specified by:

sizeAsync in interface RTimeSeriesAsync<V>

Returns:

size

get

public V get(long timestamp)

Description copied from interface: RTimeSeries

Returns object by specified timestamp or null if it doesn't exist.

Specified by:

get in interface RTimeSeries<V>

Parameters:

timestamp - - object timestamp

Returns:

object

getAsync

public RFuture<V> getAsync(long timestamp)

Description copied from interface: RTimeSeriesAsync

Returns object by specified timestamp or null if it doesn't exist.

Specified by:

getAsync in interface RTimeSeriesAsync<V>

Parameters:

timestamp - - object timestamp

Returns:

object

remove

public boolean remove(long timestamp)

Description copied from interface: RTimeSeries

Removes object by specified timestamp.

Specified by:

remove in interface RTimeSeries<V>

Parameters:

timestamp - - object timestamp

Returns:

true if an element was removed as a result of this call

removeAsync

public RFuture<Boolean> removeAsync(long timestamp)

Description copied from interface: RTimeSeriesAsync

Removes object by specified timestamp.

Specified by:

removeAsync in interface RTimeSeriesAsync<V>

Parameters:

timestamp - - object timestamp

Returns:

true if an element was removed as a result of this call

last

public V last()

Description copied from interface: RTimeSeries

Returns the tail element or null if this time-series collection is empty.

Specified by:

last in interface RTimeSeries<V>

Returns:

the tail element or null if this time-series collection is empty

lastAsync

public RFuture<V> lastAsync()

Description copied from interface: RTimeSeriesAsync

Returns the tail element or null if this time-series collection is empty.

Specified by:

lastAsync in interface RTimeSeriesAsync<V>

Returns:

the tail element or null if this time-series collection is empty

lastAsync

public RFuture<Collection<V>> lastAsync(int count)

Description copied from interface: RTimeSeriesAsync

Returns the tail elements of this time-series collection.

Specified by:

lastAsync in interface RTimeSeriesAsync<V>

Parameters:

count - - elements amount

Returns:

the tail elements

first

public V first()

Description copied from interface: RTimeSeries

Returns the head element or null if this time-series collection is empty.

Specified by:

first in interface RTimeSeries<V>

Returns:

the head element or null if this time-series collection is empty

firstAsync

public RFuture<V> firstAsync()

Description copied from interface: RTimeSeriesAsync

Returns the head element or null if this time-series collection is empty.

Specified by:

firstAsync in interface RTimeSeriesAsync<V>

Returns:

the head element or null if this time-series collection is empty

firstAsync

public RFuture<Collection<V>> firstAsync(int count)

Description copied from interface: RTimeSeriesAsync

Returns the head elements of this time-series collection.

Specified by:

firstAsync in interface RTimeSeriesAsync<V>

Parameters:

count - - elements amount

Returns:

the head elements

first

public Collection<V> first(int count)

Description copied from interface: RTimeSeries

Returns the head elements of this time-series collection.

Specified by:

first in interface RTimeSeries<V>

Parameters:

count - - elements amount

Returns:

the head elements

last

public Collection<V> last(int count)

Description copied from interface: RTimeSeries

Returns the tail elements of this time-series collection.

Specified by:

last in interface RTimeSeries<V>

Parameters:

count - - elements amount

Returns:

the tail elements

firstTimestamp

public Long firstTimestamp()

Description copied from interface: RTimeSeries

Returns timestamp of the head timestamp or null if this time-series collection is empty.

Specified by:

firstTimestamp in interface RTimeSeries<V>

Returns:

timestamp or null if this time-series collection is empty

firstTimestampAsync

public RFuture<Long> firstTimestampAsync()

Description copied from interface: RTimeSeriesAsync

Returns timestamp of the head timestamp or null if this time-series collection is empty.

Specified by:

firstTimestampAsync in interface RTimeSeriesAsync<V>

Returns:

timestamp or null if this time-series collection is empty

lastTimestamp

public Long lastTimestamp()

Description copied from interface: RTimeSeries

Returns timestamp of the tail element or null if this time-series collection is empty.

Specified by:

lastTimestamp in interface RTimeSeries<V>

Returns:

timestamp or null if this time-series collection is empty

lastTimestampAsync

public RFuture<Long> lastTimestampAsync()

Description copied from interface: RTimeSeriesAsync

Returns timestamp of the tail element or null if this time-series collection is empty.

Specified by:

lastTimestampAsync in interface RTimeSeriesAsync<V>

Returns:

timestamp or null if this time-series collection is empty

removeRange

public int removeRange(long startTimestamp,
                       long endTimestamp)

Description copied from interface: RTimeSeries

Removes values within timestamp range. Including boundary values.

Specified by:

removeRange in interface RTimeSeries<V>

Parameters:

startTimestamp - - start timestamp

endTimestamp - - end timestamp

Returns:

number of removed elements

removeRangeAsync

public RFuture<Integer> removeRangeAsync(long startTimestamp,
                                         long endTimestamp)

Description copied from interface: RTimeSeriesAsync

Removes values within timestamp range. Including boundary values.

Specified by:

removeRangeAsync in interface RTimeSeriesAsync<V>

Parameters:

startTimestamp - - start timestamp

endTimestamp - - end timestamp

Returns:

number of removed elements

range

public Collection<V> range(long startTimestamp,
                           long endTimestamp,
                           int limit)

Description copied from interface: RTimeSeries

Returns ordered elements of this time-series collection within timestamp range. Including boundary values.

Specified by:

range in interface RTimeSeries<V>

Parameters:

startTimestamp - start timestamp

endTimestamp - end timestamp

limit - result size limit

Returns:

elements collection

range

public Collection<V> range(long startTimestamp,
                           long endTimestamp)

Description copied from interface: RTimeSeries

Returns ordered elements of this time-series collection within timestamp range. Including boundary values.

Specified by:

range in interface RTimeSeries<V>

Parameters:

startTimestamp - - start timestamp

endTimestamp - - end timestamp

Returns:

elements collection

entryRange

public Collection<TimeSeriesEntry<V>> entryRange(long startTimestamp,
                                                 long endTimestamp)

Description copied from interface: RTimeSeries

Returns ordered entries of this time-series collection within timestamp range. Including boundary values.

Specified by:

entryRange in interface RTimeSeries<V>

Parameters:

startTimestamp - - start timestamp

endTimestamp - - end timestamp

Returns:

elements collection

entryRangeReversed

public Collection<TimeSeriesEntry<V>> entryRangeReversed(long startTimestamp,
                                                         long endTimestamp)

Description copied from interface: RTimeSeries

Returns entries of this time-series collection in reverse order within timestamp range. Including boundary values.

Specified by:

entryRangeReversed in interface RTimeSeries<V>

Parameters:

startTimestamp - - start timestamp

endTimestamp - - end timestamp

Returns:

elements collection

entryRangeReversedAsync

public RFuture<Collection<TimeSeriesEntry<V>>> entryRangeReversedAsync(long startTimestamp,
                                                                       long endTimestamp)

Description copied from interface: RTimeSeriesAsync

Returns entries of this time-series collection in reverse order within timestamp range. Including boundary values.

Specified by:

entryRangeReversedAsync in interface RTimeSeriesAsync<V>

Parameters:

startTimestamp - - start timestamp

endTimestamp - - end timestamp

Returns:

elements collection

entryRangeAsync

public RFuture<Collection<TimeSeriesEntry<V>>> entryRangeAsync(long startTimestamp,
                                                               long endTimestamp)

Description copied from interface: RTimeSeriesAsync

Returns ordered entries of this time-series collection within timestamp range. Including boundary values.

Specified by:

entryRangeAsync in interface RTimeSeriesAsync<V>

Parameters:

startTimestamp - - start timestamp

endTimestamp - - end timestamp

Returns:

elements collection

rangeReversed

public Collection<V> rangeReversed(long startTimestamp,
                                   long endTimestamp,
                                   int limit)

Description copied from interface: RTimeSeries

Returns elements of this time-series collection in reverse order within timestamp range. Including boundary values.

Specified by:

rangeReversed in interface RTimeSeries<V>

Parameters:

startTimestamp - start timestamp

endTimestamp - end timestamp

limit - result size limit

Returns:

elements collection

rangeAsync

public RFuture<Collection<V>> rangeAsync(long startTimestamp,
                                         long endTimestamp)

Description copied from interface: RTimeSeriesAsync

Returns ordered elements of this time-series collection within timestamp range. Including boundary values.

Specified by:

rangeAsync in interface RTimeSeriesAsync<V>

Parameters:

startTimestamp - - start timestamp

endTimestamp - - end timestamp

Returns:

elements collection

rangeAsync

public RFuture<Collection<V>> rangeAsync(long startTimestamp,
                                         long endTimestamp,
                                         int limit)

Description copied from interface: RTimeSeriesAsync

Returns ordered elements of this time-series collection within timestamp range. Including boundary values.

Specified by:

rangeAsync in interface RTimeSeriesAsync<V>

Parameters:

startTimestamp - start timestamp

endTimestamp - end timestamp

limit - result size limit

Returns:

elements collection

rangeReversed

public Collection<V> rangeReversed(long startTimestamp,
                                   long endTimestamp)

Description copied from interface: RTimeSeries

Returns elements of this time-series collection in reverse order within timestamp range. Including boundary values.

Specified by:

rangeReversed in interface RTimeSeries<V>

Parameters:

startTimestamp - - start timestamp

endTimestamp - - end timestamp

Returns:

elements collection

rangeReversedAsync

public RFuture<Collection<V>> rangeReversedAsync(long startTimestamp,
                                                 long endTimestamp)

Description copied from interface: RTimeSeriesAsync

Returns elements of this time-series collection in reverse order within timestamp range. Including boundary values.

Specified by:

rangeReversedAsync in interface RTimeSeriesAsync<V>

Parameters:

startTimestamp - - start timestamp

endTimestamp - - end timestamp

Returns:

elements collection

rangeReversedAsync

public RFuture<Collection<V>> rangeReversedAsync(long startTimestamp,
                                                 long endTimestamp,
                                                 int limit)

Description copied from interface: RTimeSeriesAsync

Returns elements of this time-series collection in reverse order within timestamp range. Including boundary values.

Specified by:

rangeReversedAsync in interface RTimeSeriesAsync<V>

Parameters:

startTimestamp - start timestamp

endTimestamp - end timestamp

limit - result size limit

Returns:

elements collection

entryRange

public Collection<TimeSeriesEntry<V>> entryRange(long startTimestamp,
                                                 long endTimestamp,
                                                 int limit)

Description copied from interface: RTimeSeries

Returns ordered entries of this time-series collection within timestamp range. Including boundary values.

Specified by:

entryRange in interface RTimeSeries<V>

Parameters:

startTimestamp - start timestamp

endTimestamp - end timestamp

limit - result size limit

Returns:

elements collection

entryRangeAsync

public RFuture<Collection<TimeSeriesEntry<V>>> entryRangeAsync(long startTimestamp,
                                                               long endTimestamp,
                                                               int limit)

Description copied from interface: RTimeSeriesAsync

Returns ordered entries of this time-series collection within timestamp range. Including boundary values.

Specified by:

entryRangeAsync in interface RTimeSeriesAsync<V>

Parameters:

startTimestamp - start timestamp

endTimestamp - end timestamp

limit - result size limit

Returns:

elements collection

entryRangeReversed

public Collection<TimeSeriesEntry<V>> entryRangeReversed(long startTimestamp,
                                                         long endTimestamp,
                                                         int limit)

Description copied from interface: RTimeSeries

Returns entries of this time-series collection in reverse order within timestamp range. Including boundary values.

Specified by:

entryRangeReversed in interface RTimeSeries<V>

Parameters:

startTimestamp - start timestamp

endTimestamp - end timestamp

limit - result size limit

Returns:

elements collection

entryRangeReversedAsync

public RFuture<Collection<TimeSeriesEntry<V>>> entryRangeReversedAsync(long startTimestamp,
                                                                       long endTimestamp,
                                                                       int limit)

Description copied from interface: RTimeSeriesAsync

Returns entries of this time-series collection in reverse order within timestamp range. Including boundary values.

Specified by:

entryRangeReversedAsync in interface RTimeSeriesAsync<V>

Parameters:

startTimestamp - start timestamp

endTimestamp - end timestamp

limit - result size limit

Returns:

elements collection

pollFirst

public Collection<V> pollFirst(int count)

Description copied from interface: RTimeSeries

Removes and returns the head elements or null if this time-series collection is empty.

Specified by:

pollFirst in interface RTimeSeries<V>

Parameters:

count - - elements amount

Returns:

the head element, or null if this time-series collection is empty

pollLast

public Collection<V> pollLast(int count)

Description copied from interface: RTimeSeries

Removes and returns the tail elements or null if this time-series collection is empty.

Specified by:

pollLast in interface RTimeSeries<V>

Parameters:

count - - elements amount

Returns:

the tail element or null if this time-series collection is empty

pollFirstAsync

public RFuture<Collection<V>> pollFirstAsync(int count)

Description copied from interface: RTimeSeriesAsync

Removes and returns the head elements or null if this time-series collection is empty.

Specified by:

pollFirstAsync in interface RTimeSeriesAsync<V>

Parameters:

count - - elements amount

Returns:

the head element, or null if this time-series collection is empty

pollLastAsync

public RFuture<Collection<V>> pollLastAsync(int count)

Description copied from interface: RTimeSeriesAsync

Removes and returns the tail elements or null if this time-series collection is empty.

Specified by:

pollLastAsync in interface RTimeSeriesAsync<V>

Parameters:

count - - elements amount

Returns:

the tail element or null if this time-series collection is empty

pollFirst

public V pollFirst()

Description copied from interface: RTimeSeries

Removes and returns the head element or null if this time-series collection is empty.

Specified by:

pollFirst in interface RTimeSeries<V>

Returns:

the head element, or null if this time-series collection is empty

pollLast

public V pollLast()

Description copied from interface: RTimeSeries

Removes and returns the tail element or null if this time-series collection is empty.

Specified by:

pollLast in interface RTimeSeries<V>

Returns:

the tail element or null if this time-series collection is empty

pollFirstAsync

public RFuture<V> pollFirstAsync()

Description copied from interface: RTimeSeriesAsync

Removes and returns the head element or null if this time-series collection is empty.

Specified by:

pollFirstAsync in interface RTimeSeriesAsync<V>

Returns:

the head element, or null if this time-series collection is empty

pollLastAsync

public RFuture<V> pollLastAsync()

Description copied from interface: RTimeSeriesAsync

Removes and returns the tail element or null if this time-series collection is empty.

Specified by:

pollLastAsync in interface RTimeSeriesAsync<V>

Returns:

the tail element or null if this time-series collection is empty

scanIterator

public ListScanResult<Object> scanIterator(String name,
                                           RedisClient client,
                                           long startPos,
                                           int count)

scanIteratorAsync

public RFuture<ListScanResult<Object>> scanIteratorAsync(String name,
                                                         RedisClient client,
                                                         long startPos,
                                                         int count)

iterator

public Iterator<V> iterator(int count)

Description copied from interface: RTimeSeries

Returns an iterator over elements in this time-series collection. Elements are loaded in batch. Batch size is defined by count param.

Specified by:

iterator in interface RTimeSeries<V>

Parameters:

count - - size of elements batch

Returns:

iterator

iterator

public Iterator<V> iterator()

Specified by:

iterator in interface Iterable<V>

stream

public Stream<V> stream()

Description copied from interface: RTimeSeries

Returns stream of elements in this time-series collection. Elements are loaded in batch. Batch size is 10.

Specified by:

stream in interface RTimeSeries<V>

Returns:

stream of elements

stream

public Stream<V> stream(int count)

Description copied from interface: RTimeSeries

Returns stream of elements in this time-series collection. Elements are loaded in batch. Batch size is defined by count param.

Specified by:

stream in interface RTimeSeries<V>

Parameters:

count - - size of elements batch

Returns:

stream of elements

destroy

public void destroy()

Description copied from interface: RDestroyable

Destroys object when it's not necessary anymore.

Specified by:

destroy in interface RDestroyable

deleteAsync

public RFuture<Boolean> deleteAsync()

Description copied from interface: RObjectAsync

Delete object in async mode

Specified by:

deleteAsync in interface RObjectAsync

Overrides:

deleteAsync in class RedissonObject

Returns:

true if object was deleted false if not

expireAsync

public RFuture<Boolean> expireAsync(long timeToLive,
                                    TimeUnit timeUnit,
                                    String param,
                                    String... keys)

expireAtAsync

protected RFuture<Boolean> expireAtAsync(long timestamp,
                                         String param,
                                         String... keys)

clearExpireAsync

public RFuture<Boolean> clearExpireAsync()

Description copied from interface: RExpirableAsync

Clear an expire timeout or expire date for object in async mode. Object will not be deleted.

Specified by:

clearExpireAsync in interface RExpirableAsync

Returns:

true if the timeout was cleared and false if not

sizeInMemoryAsync

public RFuture<Long> sizeInMemoryAsync()

Description copied from interface: RObjectAsync

Returns bytes amount used by object in Redis memory.

Specified by:

sizeInMemoryAsync in interface RObjectAsync

Overrides:

sizeInMemoryAsync in class RedissonObject

Returns:

size in bytes

expire

public boolean expire(long timeToLive,
                      TimeUnit timeUnit)

Description copied from interface: RExpirable

Use RExpirable.expire(Duration) instead

Specified by:

expire in interface RExpirable

Parameters:

timeToLive - - timeout before object will be deleted

timeUnit - - timeout time unit

Returns:

true if the timeout was set and false if not

expireAsync

public RFuture<Boolean> expireAsync(long timeToLive,
                                    TimeUnit timeUnit)

Description copied from interface: RExpirableAsync

Use RExpirableAsync.expireAsync(Duration) instead

Specified by:

expireAsync in interface RExpirableAsync

Parameters:

timeToLive - - timeout before object will be deleted

timeUnit - - timeout time unit

Returns:

true if the timeout was set and false if not

expireAt

public boolean expireAt(long timestamp)

Description copied from interface: RExpirable

Use RExpirable.expire(Instant) instead

Specified by:

expireAt in interface RExpirable

Parameters:

timestamp - - expire date in milliseconds (Unix timestamp)

Returns:

true if the timeout was set and false if not

expireAtAsync

public RFuture<Boolean> expireAtAsync(long timestamp)

Description copied from interface: RExpirableAsync

Use RExpirableAsync.expireAsync(Instant) instead

Specified by:

expireAtAsync in interface RExpirableAsync

Parameters:

timestamp - - expire date in milliseconds (Unix timestamp)

Returns:

true if the timeout was set and false if not

expire

public boolean expire(Instant instant)

Description copied from interface: RExpirable

Sets an expiration date for this object. When expire date comes the key will automatically be deleted.

Specified by:

expire in interface RExpirable

Parameters:

instant - expire date

Returns:

true if the timeout was set and false if not

expireIfSet

public boolean expireIfSet(Instant time)

Description copied from interface: RExpirable

Sets an expiration date for this object only if it has been already set. When expire date comes the object will automatically be deleted.

Requires Redis 7.0.0 and higher.

Specified by:

expireIfSet in interface RExpirable

Parameters:

time - expire date

Returns:

true if the timeout was set and false if not

expireIfSetAsync

public RFuture<Boolean> expireIfSetAsync(Instant time)

Specified by:

expireIfSetAsync in interface RExpirableAsync

expireIfNotSet

public boolean expireIfNotSet(Instant time)

Description copied from interface: RExpirable

Sets an expiration date for this object only if it hasn't been set before. When expire date comes the object will automatically be deleted.

Requires Redis 7.0.0 and higher.

Specified by:

expireIfNotSet in interface RExpirable

Parameters:

time - expire date

Returns:

true if the timeout was set and false if not

expireIfNotSetAsync

public RFuture<Boolean> expireIfNotSetAsync(Instant time)

Specified by:

expireIfNotSetAsync in interface RExpirableAsync

expireIfGreater

public boolean expireIfGreater(Instant time)

Description copied from interface: RExpirable

Sets an expiration date for this object only if it's greater than expiration date set before. When expire date comes the object will automatically be deleted.

Requires Redis 7.0.0 and higher.

Specified by:

expireIfGreater in interface RExpirable

Parameters:

time - expire date

Returns:

true if the timeout was set and false if not

expireIfGreaterAsync

public RFuture<Boolean> expireIfGreaterAsync(Instant time)

Specified by:

expireIfGreaterAsync in interface RExpirableAsync

expireIfLess

public boolean expireIfLess(Instant time)

Description copied from interface: RExpirable

Sets an expiration date for this object only if it's less than expiration date set before. When expire date comes the object will automatically be deleted.

Requires Redis 7.0.0 and higher.

Specified by:

expireIfLess in interface RExpirable

Parameters:

time - expire date

Returns:

true if the timeout was set and false if not

expireIfLessAsync

public RFuture<Boolean> expireIfLessAsync(Instant time)

Specified by:

expireIfLessAsync in interface RExpirableAsync

expireAsync

public RFuture<Boolean> expireAsync(Instant instant)

Description copied from interface: RExpirableAsync

Set an expire date for object. When expire date comes the key will automatically be deleted.

Specified by:

expireAsync in interface RExpirableAsync

Parameters:

instant - - expire date

Returns:

true if the timeout was set and false if not

expire

public boolean expire(Duration duration)

Description copied from interface: RExpirable

Sets a timeout for this object. After the timeout has expired, the key will automatically be deleted.

Specified by:

expire in interface RExpirable

Parameters:

duration - timeout before object will be deleted

Returns:

true if the timeout was set and false if not

expireAsync

public RFuture<Boolean> expireAsync(Duration duration)

Description copied from interface: RExpirableAsync

Set a timeout for object. After the timeout has expired, the key will automatically be deleted.

Specified by:

expireAsync in interface RExpirableAsync

Parameters:

duration - timeout before object will be deleted

Returns:

true if the timeout was set and false if not

expireAt

public boolean expireAt(Date timestamp)

Description copied from interface: RExpirable

Use RExpirable.expire(Instant) instead

Specified by:

expireAt in interface RExpirable

Parameters:

timestamp - - expire date

Returns:

true if the timeout was set and false if not

expireAtAsync

public RFuture<Boolean> expireAtAsync(Date timestamp)

Description copied from interface: RExpirableAsync

Use RExpirableAsync.expireAsync(Instant) instead

Specified by:

expireAtAsync in interface RExpirableAsync

Parameters:

timestamp - - expire date

Returns:

true if the timeout was set and false if not

expireIfSet

public boolean expireIfSet(Duration duration)

Description copied from interface: RExpirable

Sets a timeout for this object only if it has been already set. After the timeout has expired, the key will automatically be deleted.

Requires Redis 7.0.0 and higher.

Specified by:

expireIfSet in interface RExpirable

Parameters:

duration - timeout before object will be deleted

Returns:

true if the timeout was set and false if not

expireIfSetAsync

public RFuture<Boolean> expireIfSetAsync(Duration duration)

Specified by:

expireIfSetAsync in interface RExpirableAsync

expireIfNotSet

public boolean expireIfNotSet(Duration duration)

Description copied from interface: RExpirable

Sets a timeout for this object only if it hasn't been set before. After the timeout has expired, the key will automatically be deleted.

Requires Redis 7.0.0 and higher.

Specified by:

expireIfNotSet in interface RExpirable

Parameters:

duration - timeout before object will be deleted

Returns:

true if the timeout was set and false if not

expireIfNotSetAsync

public RFuture<Boolean> expireIfNotSetAsync(Duration duration)

Specified by:

expireIfNotSetAsync in interface RExpirableAsync

expireIfGreater

public boolean expireIfGreater(Duration duration)

Description copied from interface: RExpirable

Sets a timeout for this object only if it's greater than timeout set before. After the timeout has expired, the key will automatically be deleted.

Requires Redis 7.0.0 and higher.

Specified by:

expireIfGreater in interface RExpirable

Parameters:

duration - timeout before object will be deleted

Returns:

true if the timeout was set and false if not

expireIfGreaterAsync

public RFuture<Boolean> expireIfGreaterAsync(Duration duration)

Specified by:

expireIfGreaterAsync in interface RExpirableAsync

expireIfLess

public boolean expireIfLess(Duration duration)

Description copied from interface: RExpirable

Sets a timeout for this object only if it's less than timeout set before. After the timeout has expired, the key will automatically be deleted.

Requires Redis 7.0.0 and higher.

Specified by:

expireIfLess in interface RExpirable

Parameters:

duration - timeout before object will be deleted

Returns:

true if the timeout was set and false if not

expireIfLessAsync

public RFuture<Boolean> expireIfLessAsync(Duration duration)

Specified by:

expireIfLessAsync in interface RExpirableAsync

clearExpire

public boolean clearExpire()

Description copied from interface: RExpirable

Clear an expire timeout or expire date for object.

Specified by:

clearExpire in interface RExpirable

Returns:

true if timeout was removed false if object does not exist or does not have an associated timeout

remainTimeToLive

public long remainTimeToLive()

Description copied from interface: RExpirable

Remaining time to live of Redisson object that has a timeout

Specified by:

remainTimeToLive in interface RExpirable

Returns:

time in milliseconds -2 if the key does not exist. -1 if the key exists but has no associated expire.

remainTimeToLiveAsync

public RFuture<Long> remainTimeToLiveAsync()

Description copied from interface: RExpirableAsync

Remaining time to live of Redisson object that has a timeout

Specified by:

remainTimeToLiveAsync in interface RExpirableAsync

Returns:

time in milliseconds -2 if the key does not exist. -1 if the key exists but has no associated expire.

getExpireTime

public long getExpireTime()

Description copied from interface: RExpirable

Expiration time of Redisson object that has a timeout

Requires Redis 7.0.0 and higher.

Specified by:

getExpireTime in interface RExpirable

Returns:

expiration time

getExpireTimeAsync

public RFuture<Long> getExpireTimeAsync()

Description copied from interface: RExpirableAsync

Expiration time of Redisson object that has a timeout

Requires Redis 7.0.0 and higher.

Specified by:

getExpireTimeAsync in interface RExpirableAsync

Returns:

expiration time

clearExpireAsync

protected RFuture<Boolean> clearExpireAsync(String... keys)