org.springframework.data.redis.support.collections

Class AbstractRedisCollection<E>

java.lang.Object

java.util.AbstractCollection<E>

org.springframework.data.redis.support.collections.AbstractRedisCollection<E>

All Implemented Interfaces:

Iterable<E>, Collection<E>, BoundKeyOperations<String>, RedisCollection<E>, RedisStore

Direct Known Subclasses:

DefaultRedisList, DefaultRedisSet, DefaultRedisZSet

public abstract class AbstractRedisCollection<E>
extends AbstractCollection<E>
implements RedisCollection<E>

Base implementation for RedisCollection. Provides a skeletal implementation. Note that the collection support works only with normal, non-pipeline/multi-exec connections as it requires a reply to be sent right away.

Author:

Costin Leau, Christoph Strobl, Mark Paluch

Field Summary

Fields

Modifier and Type	Field and Description
static String	ENCODING

Constructor Summary

Constructors

Constructor and Description
AbstractRedisCollection(String key, RedisOperations<String,E> operations) Constructs a new AbstractRedisCollection instance.

Method Summary

Modifier and Type	Method and Description
boolean	addAll(Collection<? extends E> c)
protected void	checkResult(Object obj)
boolean	containsAll(Collection<?> c)
boolean	equals(Object o)
Boolean	expire(long timeout, TimeUnit unit) Sets the key time-to-live/expiration.
Boolean	expireAt(Date date) Sets the key time-to-live/expiration.
Long	getExpire() Returns the expiration of this key.
String	getKey() Returns the key associated with this entity.
RedisOperations<String,E>	getOperations() Returns the underlying Redis operations used by the backing implementation.
int	hashCode()
Boolean	persist() Removes the expiration (if any) of the key.
boolean	removeAll(Collection<?> c)
void	rename(String newKey) Renames the key.
String	toString()

Methods inherited from class java.util.AbstractCollection

add, clear, contains, isEmpty, iterator, remove, retainAll, size, toArray, toArray

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.springframework.data.redis.core.BoundKeyOperations

expire, expireAt, getType

Methods inherited from interface java.util.Collection

parallelStream, removeIf, spliterator, stream

Methods inherited from interface java.lang.Iterable

forEach

Field Detail

ENCODING

public static final String ENCODING

See Also:

Constant Field Values

Constructor Detail

AbstractRedisCollection

public AbstractRedisCollection(String key,
                               RedisOperations<String,E> operations)

Constructs a new AbstractRedisCollection instance.

Parameters:

key - Redis key of this collection.

operations - RedisOperations for the value type of this collection.

Method Detail

getKey

public String getKey()

Description copied from interface: BoundKeyOperations

Returns the key associated with this entity.

Specified by:

getKey in interface BoundKeyOperations<String>

Returns:

key associated with the implementing entity

getOperations

public RedisOperations<String,E> getOperations()

Description copied from interface: RedisStore

Returns the underlying Redis operations used by the backing implementation.

Specified by:

getOperations in interface RedisStore

Returns:

operations never null.

addAll

public boolean addAll(Collection<? extends E> c)

Specified by:

addAll in interface Collection<E>

Overrides:

addAll in class AbstractCollection<E>

containsAll

public boolean containsAll(Collection<?> c)

Specified by:

containsAll in interface Collection<E>

Overrides:

containsAll in class AbstractCollection<E>

removeAll

public boolean removeAll(Collection<?> c)

Specified by:

removeAll in interface Collection<E>

Overrides:

removeAll in class AbstractCollection<E>

expire

public Boolean expire(long timeout,
                      TimeUnit unit)

Description copied from interface: BoundKeyOperations

Sets the key time-to-live/expiration.

Specified by:

expire in interface BoundKeyOperations<String>

Parameters:

timeout - expiration value

unit - expiration unit

Returns:

true if expiration was set, false otherwise. null when used in pipeline / transaction.

expireAt

public Boolean expireAt(Date date)

Description copied from interface: BoundKeyOperations

Sets the key time-to-live/expiration.

Specified by:

expireAt in interface BoundKeyOperations<String>

Parameters:

date - expiration date

Returns:

true if expiration was set, false otherwise. null when used in pipeline / transaction.

getExpire

public Long getExpire()

Description copied from interface: BoundKeyOperations

Returns the expiration of this key.

Specified by:

getExpire in interface BoundKeyOperations<String>

Returns:

expiration value (in seconds). null when used in pipeline / transaction.

persist

public Boolean persist()

Description copied from interface: BoundKeyOperations

Removes the expiration (if any) of the key.

Specified by:

persist in interface BoundKeyOperations<String>

Returns:

true if expiration was removed, false otherwise. null when used in pipeline / transaction.

rename

public void rename(String newKey)

Description copied from interface: BoundKeyOperations

Renames the key.
Note: The new name for empty collections will be propagated on add of first element.

Specified by:

rename in interface BoundKeyOperations<String>

Parameters:

newKey - new key. Must not be null.

checkResult

protected void checkResult(@Nullable
                           Object obj)

equals

public boolean equals(Object o)

Specified by:

equals in interface Collection<E>

Overrides:

equals in class Object

hashCode

public int hashCode()

Specified by:

hashCode in interface Collection<E>

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class AbstractCollection<E>