Package org.redisson.transaction

Class RedissonTransactionalSetCache<V>

org.redisson.RedissonObject

org.redisson.RedissonSetCache<V>

org.redisson.transaction.RedissonTransactionalSetCache<V>

Type Parameters:

V - value type

All Implemented Interfaces:

<V>, <V>, <V>, RCollectionAsync<V>, RDestroyable, RExpirable, RExpirableAsync, RObject, RObjectAsync, RSetCache<V>, RSetCacheAsync<V>, ScanIterator

public class RedissonTransactionalSetCache<V>
extends RedissonSetCache<V>

Author:

Nikita Koksharov

Field Summary

Fields inherited from class org.redisson.RedissonObject

codec, commandExecutor, name

Constructor Summary

Constructors

Constructor	Description
RedissonTransactionalSetCache(Codec codec, CommandAsyncExecutor commandExecutor, name, <TransactionalOperation> operations, long timeout, executed, transactionId)
RedissonTransactionalSetCache(CommandAsyncExecutor commandExecutor, name, <TransactionalOperation> operations, long timeout, executed, transactionId)

Method Summary

Modifier and Type	Method	Description
>	<? extends V> c)	Adds all elements contained in the specified collection
>	addAsync(V e)	Adds element into this collection.
>	addAsync(V value, long ttl, unit)	Stores value with specified time to live.
protected void	checkState()
boolean	clearExpire()	Clear an expire timeout or expire date for object.
>	clearExpireAsync()	Clear an expire timeout or expire date for object in async mode.
protected >	... keys)
>	o)	Returns true if this collection contains encoded state of the specified element.
boolean	expire(long timeToLive, timeUnit)	Set a timeout for object.
boolean	instant)	Set an expire date for object.
>	expireAsync(long timeToLive, timeUnit)	Set a timeout for object in async mode.
protected >	expireAsync(long timeToLive, timeUnit, ... keys)
>	timestamp)	Set an expire date for object.
boolean	expireAt(long timestamp)	Use RExpirable.expire(Instant) instead
boolean	timestamp)	Use RExpirable.expire(Instant) instead
>	expireAtAsync(long timestamp)	Use RExpirableAsync.expireAsync(Instant) instead
protected >	expireAtAsync(long timestamp, ... keys)
>	timestamp)	Use RExpirableAsync.expireAsync(Instant) instead
<KOut,VOut> RCollectionMapReduce<V,KOut,VOut>	mapReduce()	Returns RMapReduce object associated with this map
>	host, int port, int database, long timeout)	Transfer object from source Redis instance to destination Redis instance in async mode
>	moveAsync(int database)	Move object to another database in async mode
<V>>	readAllAsync()	Read all elements at once
long	remainTimeToLive()	Remaining time to live of Redisson object that has a timeout
>	remainTimeToLiveAsync()	Remaining time to live of Redisson object that has a timeout
>	<?> c)	Removes all of this collection's elements that are also contained in the specified collection.
>	o)	Removes a single instance of the specified element from this collection, if it is present.
>	<?> c)	Retains only the elements in this collection that are contained in the specified collection.
>	name, RedisClient client, long startPos, pattern, int count)

Methods inherited from class org.redisson.RedissonSetCache

add, add, addAll, clear, contains, containsAll, containsAllAsync, destroy, getCountDownLatch, getFairLock, getLock, getPermitExpirableSemaphore, getReadWriteLock, getSemaphore, isEmpty, iterator, iterator, iterator, iterator, readAll, remove, removeAll, retainAll, scanIteratorAsync, size, sizeAsync, stream, stream, stream, toArray, toArray, tryAdd, tryAdd, tryAddAsync, tryAddAsync

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, move, 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.

, , , , , , , , , ,

Methods inherited from interface java.util.

, , ,

Methods inherited from interface java.lang.

Methods inherited from interface org.redisson.api.RExpirable

clearExpire, expire, expire, expireAt, expireAt, remainTimeToLive

Methods inherited from interface org.redisson.api.RExpirableAsync

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, removeListenerAsync, renameAsync, renamenxAsync, restoreAndReplaceAsync, restoreAndReplaceAsync, restoreAsync, restoreAsync, sizeInMemoryAsync, touchAsync, unlinkAsync

Methods inherited from interface java.util.

, ,

Constructor Detail

RedissonTransactionalSetCache

public RedissonTransactionalSetCache(CommandAsyncExecutor commandExecutor,
                                      name,
                                     <TransactionalOperation> operations,
                                     long timeout,
                                      executed,
                                      transactionId)

RedissonTransactionalSetCache

public RedissonTransactionalSetCache(Codec codec,
                                     CommandAsyncExecutor commandExecutor,
                                      name,
                                     <TransactionalOperation> operations,
                                     long timeout,
                                      executed,
                                      transactionId)

Method Detail

expireAsync

public > expireAsync(long timeToLive,
                                     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

expireAtAsync

public > expireAtAsync( 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

expireAsync

public > expireAsync( timestamp)

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:

timestamp - - expire date

Returns:

true if the timeout was set and false if not

expireAtAsync

public > 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

clearExpireAsync

public > 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

moveAsync

public > moveAsync(int database)

Description copied from interface: RObjectAsync

Move object to another database in async mode

Specified by:

moveAsync in interface RObjectAsync

Overrides:

moveAsync in class RedissonObject

Parameters:

database - - number of Redis database

Returns:

true if key was moved false if not

migrateAsync

public > migrateAsync( host,
                                  int port,
                                  int database,
                                  long timeout)

Description copied from interface: RObjectAsync

Transfer object from source Redis instance to destination Redis instance in async mode

Specified by:

migrateAsync in interface RObjectAsync

Overrides:

migrateAsync in class RedissonObject

Parameters:

host - - destination host

port - - destination port

database - - destination database

timeout - - maximum idle time in any moment of the communication with the destination instance in milliseconds

Returns:

void

mapReduce

public <KOut,VOut> RCollectionMapReduce<V,KOut,VOut> mapReduce()

Description copied from interface: RSetCache

Returns RMapReduce object associated with this map

Specified by:

mapReduce in interface RSetCache<V>

Overrides:

mapReduce in class RedissonSetCache<V>

Type Parameters:

KOut - output key

VOut - output value

Returns:

MapReduce instance

scanIterator

public > scanIterator( name,
                                       RedisClient client,
                                       long startPos,
                                        pattern,
                                       int count)

Specified by:

scanIterator in interface ScanIterator

Overrides:

scanIterator in class RedissonSetCache<V>

containsAsync

public > containsAsync( o)

Description copied from interface: RCollectionAsync

Returns true if this collection contains encoded state of the specified element.

Specified by:

containsAsync in interface RCollectionAsync<V>

Overrides:

containsAsync in class RedissonSetCache<V>

Parameters:

o - element whose presence in this collection is to be tested

Returns:

true if this collection contains the specified element and false otherwise

readAllAsync

public <V>> readAllAsync()

Description copied from interface: RSetCacheAsync

Read all elements at once

Specified by:

readAllAsync in interface RSetCacheAsync<V>

Overrides:

readAllAsync in class RedissonSetCache<V>

Returns:

values

addAsync

public > addAsync(V e)

Description copied from interface: RCollectionAsync

Adds element into this collection.

Specified by:

addAsync in interface RCollectionAsync<V>

Overrides:

addAsync in class RedissonSetCache<V>

Parameters:

e - - element to add

Returns:

true if an element was added and false if it is already present

addAsync

public > addAsync(V value,
                                 long ttl,
                                  unit)

Description copied from interface: RSetCacheAsync

Stores value with specified time to live. Value expires after specified time to live.

Specified by:

addAsync in interface RSetCacheAsync<V>

Overrides:

addAsync in class RedissonSetCache<V>

Parameters:

value - to add

ttl - - time to live for key\value entry. If 0 then stores infinitely.

unit - - time unit

Returns:

true if value has been added. false if value already been in collection.

removeAsync

public > removeAsync( o)

Description copied from interface: RCollectionAsync

Removes a single instance of the specified element from this collection, if it is present.

Specified by:

removeAsync in interface RCollectionAsync<V>

Overrides:

removeAsync in class RedissonSetCache<V>

Parameters:

o - element to be removed from this collection, if present

Returns:

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

addAllAsync

public > addAllAsync(<? extends V> c)

Description copied from interface: RCollectionAsync

Adds all elements contained in the specified collection

Specified by:

addAllAsync in interface RCollectionAsync<V>

Overrides:

addAllAsync in class RedissonSetCache<V>

Parameters:

c - - collection of elements to add

Returns:

true if at least one element was added and false if all elements are already present

retainAllAsync

public > retainAllAsync(<?> c)

Description copied from interface: RCollectionAsync

Retains only the elements in this collection that are contained in the specified collection.

Specified by:

retainAllAsync in interface RCollectionAsync<V>

Overrides:

retainAllAsync in class RedissonSetCache<V>

Parameters:

c - collection containing elements to be retained in this collection

Returns:

true if this collection changed as a result of the call

removeAllAsync

public > removeAllAsync(<?> c)

Description copied from interface: RCollectionAsync

Removes all of this collection's elements that are also contained in the specified collection.

Specified by:

removeAllAsync in interface RCollectionAsync<V>

Overrides:

removeAllAsync in class RedissonSetCache<V>

Parameters:

c - collection containing elements to be removed from this collection

Returns:

true if this collection changed as a result of the call

checkState

protected void checkState()

expire

public boolean expire(long timeToLive,
                       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

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

expire

public boolean expire( 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

expireAt

public boolean expireAt( 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

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 > 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 > expireAsync(long timeToLive,
                                        timeUnit,
                                       ... keys)

expireAtAsync

protected > expireAtAsync(long timestamp,
                                         ... keys)

clearExpireAsync

protected > clearExpireAsync(... keys)