com.communote.server.core.common.caching

Class IdBasedRangeCacheKey

java.lang.Object

com.communote.server.core.common.caching.IdBasedCacheKey

com.communote.server.core.common.caching.IdBasedRangeCacheKey

All Implemented Interfaces:

CacheKey

Direct Known Subclasses:

FollowCacheKey

public class IdBasedRangeCacheKey
extends IdBasedCacheKey

A CacheKey to identify cached items by an ID and a positive range. This is for instance useful for caching items of a specific range and which are owned by an entity that can be identified with the ID. The items to cache must be identifiable by a positive digit.

Author:

Communote GmbH - http://www.communote.com/

Constructor Summary

Constructors

Constructor and Description
IdBasedRangeCacheKey(Long id) Creates a cache key encapsulating the ID.
IdBasedRangeCacheKey(Long id, long rangeStart, long rangeEnd) Creates a cache key for an ID and a range

Method Summary

Modifier and Type	Method and Description
String	getCacheKeyString() String representation of the cache key which will be used for caching.
long	getRangeEnd()
long	getRangeStart()

Methods inherited from class com.communote.server.core.common.caching.IdBasedCacheKey

getId, isUniquePerClient

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

IdBasedRangeCacheKey

public IdBasedRangeCacheKey(Long id)

Creates a cache key encapsulating the ID. The range is set to [-1, -1]

Parameters:

id - the ID to be cached; must not be null

IdBasedRangeCacheKey

public IdBasedRangeCacheKey(Long id,
                            long rangeStart,
                            long rangeEnd)

Creates a cache key for an ID and a range

Parameters:

id - the ID to be cached; must not be null

rangeStart - the start of the range of the items to be cached. Negative numbers are normalized to -1. A possible interpretation of -1 would be to ignore this boundary.

rangeEnd - the end of the range of the items to be cached. Negative numbers are normalized to -1. A possible interpretation of -1 would be to ignore this boundary.

Method Detail

getCacheKeyString

public String getCacheKeyString()

String representation of the cache key which will be used for caching.

Specified by:

getCacheKeyString in interface CacheKey

Overrides:

getCacheKeyString in class IdBasedCacheKey

Returns:

the string representation

getRangeEnd

public long getRangeEnd()

Returns:

the end of the range of the items to be cached

getRangeStart

public long getRangeStart()

Returns:

the start of the range of the items to be cached