Package org.redisson

Class RedissonHyperLogLog<V>

java.lang.Object

org.redisson.RedissonObject

org.redisson.RedissonHyperLogLog<V>

Type Parameters:

V - value

All Implemented Interfaces:

RExpirable, RExpirableAsync, RHyperLogLog<V>, RHyperLogLogAsync<V>, RObject, RObjectAsync

public class RedissonHyperLogLog<V>
extends RedissonObject
implements RHyperLogLog<V>

Author:

Nikita Koksharov

Field Summary

Fields inherited from class org.redisson.RedissonObject

codec, commandExecutor, name

Constructor Summary

Constructors

Constructor	Description
RedissonHyperLogLog(Codec codec, CommandAsyncExecutor commandExecutor, String name)
RedissonHyperLogLog(CommandAsyncExecutor commandExecutor, String name)

Method Summary

Modifier and Type	Method	Description
boolean	add(V obj)	Adds element into this structure.
boolean	addAll(Collection<V> objects)	Adds all elements contained in objects collection into this structure
RFuture<Boolean>	addAllAsync(Collection<V> objects)	Adds all elements contained in objects collection into this structure
RFuture<Boolean>	addAsync(V obj)	Adds element into this structure.
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)
long	count()	Returns approximated number of unique elements added into this structure.
RFuture<Long>	countAsync()	Returns approximated number of unique elements added into this structure.
long	countWith(String... otherLogNames)	Returns approximated number of unique elements added into this instances and other instances defined through otherLogNames.
RFuture<Long>	countWithAsync(String... otherLogNames)	Returns approximated number of unique elements added into this instances and other instances defined through otherLogNames.
boolean	expire(long timeToLive, TimeUnit timeUnit)	Set a timeout for object.
boolean	expire(Instant instant)	Set an expire date for object.
RFuture<Boolean>	expireAsync(long timeToLive, TimeUnit timeUnit)	Set a timeout for object in async mode.
protected RFuture<Boolean>	expireAsync(long timeToLive, TimeUnit timeUnit, String... keys)
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... keys)
RFuture<Boolean>	expireAtAsync(Date timestamp)	Use RExpirableAsync.expireAsync(Instant) instead
void	mergeWith(String... otherLogNames)	Merges multiple instances into this instance.
RFuture<Void>	mergeWithAsync(String... otherLogNames)	Merges multiple instances into this instance.
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

Methods inherited from class org.redisson.RedissonObject

addListener, addListener, addListenerAsync, addListenerAsync, copy, copyAsync, delete, deleteAsync, 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, removeListenersAsync, rename, renameAsync, renamenx, renamenxAsync, restore, restore, restoreAndReplace, restoreAndReplace, restoreAndReplaceAsync, restoreAndReplaceAsync, restoreAsync, restoreAsync, setName, sizeInMemory, sizeInMemoryAsync, 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 org.redisson.api.RExpirable

clearExpire, expire, expire, expireAt, expireAt, remainTimeToLive

Methods inherited from interface org.redisson.api.RExpirableAsync

clearExpireAsync, expireAsync, expireAsync, expireAtAsync, expireAtAsync, 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, deleteAsync, dumpAsync, getIdleTimeAsync, isExistsAsync, migrateAsync, moveAsync, removeListenerAsync, renameAsync, renamenxAsync, restoreAndReplaceAsync, restoreAndReplaceAsync, restoreAsync, restoreAsync, sizeInMemoryAsync, touchAsync, unlinkAsync

Constructor Detail

RedissonHyperLogLog

public RedissonHyperLogLog(CommandAsyncExecutor commandExecutor,
                           String name)

RedissonHyperLogLog

public RedissonHyperLogLog(Codec codec,
                           CommandAsyncExecutor commandExecutor,
                           String name)

Method Detail

add

public boolean add(V obj)

Description copied from interface: RHyperLogLog

Adds element into this structure.

Specified by:

add in interface RHyperLogLog<V>

Parameters:

obj - - element to add

Returns:

true if object has been added or false if it was already added

addAll

public boolean addAll(Collection<V> objects)

Description copied from interface: RHyperLogLog

Adds all elements contained in objects collection into this structure

Specified by:

addAll in interface RHyperLogLog<V>

Parameters:

objects - - elements to add

Returns:

true if at least one object has been added or false if all were already added

count

public long count()

Description copied from interface: RHyperLogLog

Returns approximated number of unique elements added into this structure.

Specified by:

count in interface RHyperLogLog<V>

Returns:

approximated number of unique elements added into this structure

countWith

public long countWith(String... otherLogNames)

Description copied from interface: RHyperLogLog

Returns approximated number of unique elements added into this instances and other instances defined through otherLogNames.

Specified by:

countWith in interface RHyperLogLog<V>

Parameters:

otherLogNames - - name of instances

Returns:

number

mergeWith

public void mergeWith(String... otherLogNames)

Description copied from interface: RHyperLogLog

Merges multiple instances into this instance.

Specified by:

mergeWith in interface RHyperLogLog<V>

Parameters:

otherLogNames - - name of instances

addAsync

public RFuture<Boolean> addAsync(V obj)

Description copied from interface: RHyperLogLogAsync

Adds element into this structure.

Specified by:

addAsync in interface RHyperLogLogAsync<V>

Parameters:

obj - - element to add

Returns:

true if object has been added or false if it was already added

addAllAsync

public RFuture<Boolean> addAllAsync(Collection<V> objects)

Description copied from interface: RHyperLogLogAsync

Adds all elements contained in objects collection into this structure

Specified by:

addAllAsync in interface RHyperLogLogAsync<V>

Parameters:

objects - - elements to add

Returns:

true if at least one object has been added or false if all were already added

countAsync

public RFuture<Long> countAsync()

Description copied from interface: RHyperLogLogAsync

Returns approximated number of unique elements added into this structure.

Specified by:

countAsync in interface RHyperLogLogAsync<V>

Returns:

approximated number of unique elements added into this structure

countWithAsync

public RFuture<Long> countWithAsync(String... otherLogNames)

Description copied from interface: RHyperLogLogAsync

Returns approximated number of unique elements added into this instances and other instances defined through otherLogNames.

Specified by:

countWithAsync in interface RHyperLogLogAsync<V>

Parameters:

otherLogNames - - name of instances

Returns:

number

mergeWithAsync

public RFuture<Void> mergeWithAsync(String... otherLogNames)

Description copied from interface: RHyperLogLogAsync

Merges multiple instances into this instance.

Specified by:

mergeWithAsync in interface RHyperLogLogAsync<V>

Parameters:

otherLogNames - - name of instances

Returns:

void

expire

public boolean expire(long timeToLive,
                      TimeUnit timeUnit)

Description copied from interface: RExpirable

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

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

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

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

Set an expire date for 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

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

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

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

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

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.

expireAsync

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

expireAtAsync

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

clearExpireAsync

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