Some comments added

pull/22/head
Nikita 11 years ago
parent d49b35b16f
commit 9e1bef2964

@ -17,7 +17,6 @@ package org.redisson;
import java.util.Iterator; import java.util.Iterator;
import java.util.List; import java.util.List;
import java.util.ListIterator;
import java.util.NoSuchElementException; import java.util.NoSuchElementException;
import org.redisson.connection.ConnectionManager; import org.redisson.connection.ConnectionManager;
@ -26,11 +25,11 @@ import org.redisson.core.RDeque;
import com.lambdaworks.redis.RedisConnection; import com.lambdaworks.redis.RedisConnection;
/** /**
* * Distributed and concurrent implementation of {@link java.util.Queue}
* *
* @author Nikita Koksharov * @author Nikita Koksharov
* *
* @param <V> * @param <V> the type of elements held in this collection
*/ */
public class RedissonDeque<V> extends RedissonQueue<V> implements RDeque<V> { public class RedissonDeque<V> extends RedissonQueue<V> implements RDeque<V> {

@ -33,7 +33,7 @@ import com.lambdaworks.redis.RedisConnection;
* *
* @author Nikita Koksharov * @author Nikita Koksharov
* *
* @param <V> value * @param <V> the type of elements held in this collection
*/ */
public class RedissonList<V> extends RedissonExpirable implements RList<V> { public class RedissonList<V> extends RedissonExpirable implements RList<V> {

@ -23,11 +23,11 @@ import org.redisson.core.RQueue;
import com.lambdaworks.redis.RedisConnection; import com.lambdaworks.redis.RedisConnection;
/** /**
* Distributed and concurrent implementation of {@link java.util.List} * Distributed and concurrent implementation of {@link java.util.Queue}
* *
* @author Nikita Koksharov * @author Nikita Koksharov
* *
* @param <V> value * @param <V> the type of elements held in this collection
*/ */
public class RedissonQueue<V> extends RedissonList<V> implements RQueue<V> { public class RedissonQueue<V> extends RedissonList<V> implements RQueue<V> {

@ -18,10 +18,11 @@ package org.redisson.core;
import java.util.Deque; import java.util.Deque;
/** /**
* {@link java.util.Deque} backed by Redis
* *
* @author Nikita Koksharov * @author Nikita Koksharov
* *
* @param <V> * @param <V> the type of elements held in this collection
*/ */
public interface RDeque<V> extends Deque<V>, RExpirable { public interface RDeque<V> extends Deque<V>, RExpirable {

@ -18,6 +18,12 @@ package org.redisson.core;
import java.util.Date; import java.util.Date;
import java.util.concurrent.TimeUnit; import java.util.concurrent.TimeUnit;
/**
* Interface with expiration support for Redisson objects.
*
* @author Nikita Koksharov
*
*/
public interface RExpirable extends RObject { public interface RExpirable extends RObject {
boolean expire(long timeToLive, TimeUnit timeUnit); boolean expire(long timeToLive, TimeUnit timeUnit);
@ -26,8 +32,19 @@ public interface RExpirable extends RObject {
boolean expireAt(Date timestamp); boolean expireAt(Date timestamp);
/**
* Remove the existing timeout of Redisson object
*
* @return <code>true</code> if timeout was removed
* <code>false</code> if object does not exist or does not have an associated timeout
*/
boolean clearExpire(); boolean clearExpire();
/**
* Remaining time in seconds to live of Redisson object that has a timeout
*
* @return time in seconds
*/
long remainTimeToLive(); long remainTimeToLive();
} }

@ -22,7 +22,7 @@ import java.util.List;
* *
* @author Nikita Koksharov * @author Nikita Koksharov
* *
* @param <V> value * @param <V> the type of elements held in this collection
*/ */
public interface RList<V> extends List<V>, RExpirable { public interface RList<V> extends List<V>, RExpirable {

@ -18,11 +18,11 @@ package org.redisson.core;
import java.util.Queue; import java.util.Queue;
/** /**
* Distributed and concurrent implementation of {@link java.util.List} * {@link java.util.Queue} backed by Redis
* *
* @author Nikita Koksharov * @author Nikita Koksharov
* *
* @param <V> value * @param <V> the type of elements held in this collection
*/ */
public interface RQueue<V> extends Queue<V>, RExpirable { public interface RQueue<V> extends Queue<V>, RExpirable {

Loading…
Cancel
Save