org.springframework.data.redis.support.collections.AbstractRedisCollection Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of org.apache.servicemix.bundles.spring-data-redis
Show all versions of org.apache.servicemix.bundles.spring-data-redis
This OSGi bundle wraps ${pkgArtifactId} ${pkgVersion} jar files.
/*
* Copyright 2011-2020 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.springframework.data.redis.support.collections;
import java.util.AbstractCollection;
import java.util.Collection;
import java.util.Date;
import java.util.concurrent.TimeUnit;
import org.springframework.data.redis.core.RedisOperations;
import org.springframework.lang.Nullable;
/**
* Base implementation for {@link 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
* @author Christoph Strobl
* @author Mark Paluch
*/
public abstract class AbstractRedisCollection extends AbstractCollection implements RedisCollection {
public static final String ENCODING = "UTF-8";
private volatile String key;
private final RedisOperations operations;
/**
* Constructs a new {@link AbstractRedisCollection} instance.
*
* @param key Redis key of this collection.
* @param operations {@link RedisOperations} for the value type of this collection.
*/
public AbstractRedisCollection(String key, RedisOperations operations) {
this.key = key;
this.operations = operations;
}
/*
* (non-Javadoc)
* @see org.springframework.data.redis.core.BoundKeyOperations#getKey()
*/
@Override
public String getKey() {
return key;
}
/*
* (non-Javadoc)
* @see org.springframework.data.redis.support.collections.RedisStore#getOperations()
*/
@Override
public RedisOperations getOperations() {
return operations;
}
/*
* (non-Javadoc)
* @see java.util.AbstractCollection#addAll(java.util.Collection)
*/
@Override
public boolean addAll(Collection c) {
boolean modified = false;
for (E e : c) {
modified |= add(e);
}
return modified;
}
/*
* (non-Javadoc)
* @see java.util.AbstractCollection#containsAll(java.util.Collection)
*/
@Override
public boolean containsAll(Collection c) {
boolean contains = true;
for (Object object : c) {
contains &= contains(object);
}
return contains;
}
/*
* (non-Javadoc)
* @see java.util.AbstractCollection#removeAll(java.util.Collection)
*/
@Override
public boolean removeAll(Collection c) {
boolean modified = false;
for (Object object : c) {
modified |= remove(object);
}
return modified;
}
/*
* (non-Javadoc)
* @see org.springframework.data.redis.core.BoundKeyOperations#expire(long, java.util.concurrent.TimeUnit)
*/
@Override
public Boolean expire(long timeout, TimeUnit unit) {
return operations.expire(key, timeout, unit);
}
/*
* (non-Javadoc)
* @see org.springframework.data.redis.core.BoundKeyOperations#expireAt(java.util.Date)
*/
@Override
public Boolean expireAt(Date date) {
return operations.expireAt(key, date);
}
/*
* (non-Javadoc)
* @see org.springframework.data.redis.core.BoundKeyOperations#getExpire()
*/
@Override
public Long getExpire() {
return operations.getExpire(key);
}
/*
* (non-Javadoc)
* @see org.springframework.data.redis.core.BoundKeyOperations#persist()
*/
@Override
public Boolean persist() {
return operations.persist(key);
}
/*
* (non-Javadoc)
* @see org.springframework.data.redis.core.BoundKeyOperations#rename(java.lang.Object)
*/
@Override
public void rename(final String newKey) {
if (!this.isEmpty()) {
CollectionUtils.rename(key, newKey, operations);
}
key = newKey;
}
protected void checkResult(@Nullable Object obj) {
if (obj == null) {
throw new IllegalStateException("Cannot read collection with Redis connection in pipeline/multi-exec mode");
}
}
/*
* (non-Javadoc)
* @see java.lang.Object#equals(java.lang.Object)
*/
@Override
public boolean equals(Object o) {
if (o == this)
return true;
if (o instanceof RedisStore) {
return key.equals(((RedisStore) o).getKey());
}
if (o instanceof AbstractRedisCollection) {
return o.hashCode() == hashCode();
}
return false;
}
/*
* (non-Javadoc)
* @see java.lang.Object#hashCode()
*/
@Override
public int hashCode() {
int result = 17 + getClass().hashCode();
result = result * 31 + key.hashCode();
return result;
}
/*
* (non-Javadoc)
* @see java.util.AbstractCollection#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("RedisStore for key:");
sb.append(getKey());
return sb.toString();
}
}