Skip to content
This repository has been archived by the owner on Feb 17, 2022. It is now read-only.

Commit

Permalink
Updated StatelessRedisDao Javadoc
Browse files Browse the repository at this point in the history
  • Loading branch information
Laurence Cartwright committed Jul 3, 2017
1 parent 3eb5de5 commit 14e6e07
Showing 1 changed file with 13 additions and 3 deletions.
16 changes: 13 additions & 3 deletions app/components/common/persistence/StatelessRedisDao.java
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,19 @@
import java.util.concurrent.TimeUnit;

/**
* Base class for a Redis DAO which stores all transaction data in a single Redis hash. Subclasses should primarily use
* the methods defined in this class to access the hash's data, but they are also free to use the pool and perform
* arbitrary commands within Redis as required.
* <p>
* Base class for a stateless Redis DAO which stores all transaction data in a single Redis hash.
* The methods defined in this class to access the hash's data, but they are also free to use the pool and perform
* arbitrary commands within Redis as required.
* </p>
*
* <p>
* "Stateless" meaning the transaction ID must be provided for every method call as it is not inferred from the
* context as in {@link CommonRedisDao}. Compare {@link #writeString} to {@link CommonRedisDao#writeString} for the
* expected difference in method signature.
* </p>
*
* @see CommonRedisDao
*/
public abstract class StatelessRedisDao {

Expand Down

0 comments on commit 14e6e07

Please sign in to comment.