co.abit.prime.cache

Interface CacheItem

All Known Implementing Classes:

SimpleCacheItem

public interface CacheItem

Field Summary

Fields

Modifier and Type	Field and Description
static String	CHARSET_UTF8
static String	DEFAULT_CHARSET

Method Summary

Modifier and Type	Method and Description
default void	expireAfter(java.time.Duration duration) Sets period of time which items will be expired
default void	expireAfter(Long duration) Sets period of time which items will be expired
Long	getExpiration() Returns time which item will be expired
String	getKey() Returns key of item
Object	getValue() Returns value of item
default <T> T	getValue(Class<T> className) Get value as an instance
static CacheItem	newInstance(String key) Creates and returns a new instance of CacheItem with key
static CacheItem	newInstance(String key, Object value) Creates and returns a new instance of CacheItem with key
static CacheItem	newInstance(String key, Object value, Long expiration) Creates and returns a new instance of CacheItem with key
void	setExpiration(Long expiration) Sets time which item will be expired
void	setKey(String key) Sets key of item
void	setValue(Object value) Sets value of item

Field Detail

CHARSET_UTF8

static final String CHARSET_UTF8

See Also:

Constant Field Values

DEFAULT_CHARSET

static final String DEFAULT_CHARSET

See Also:

Constant Field Values

Method Detail

getKey

String getKey()

Returns key of item

Returns:

a string represents for key

setKey

void setKey(String key)

Sets key of item

Parameters:

key - a string represents for key

getValue

Object getValue()

Returns value of item

Returns:

an object represents for item's value

getValue

default <T> T getValue(Class<T> className)

Get value as an instance

Type Parameters:

T - object type to return

Parameters:

className - a string represents for class's name

Returns:

an instance of T

Throws:

UnsupportedClassException - if value cannot convert to proposed class

setValue

void setValue(Object value)

Sets value of item

Parameters:

value - an object represents for item's value

getExpiration

Long getExpiration()

Returns time which item will be expired

Returns:

a long value represents for expiration time

setExpiration

void setExpiration(Long expiration)

Sets time which item will be expired

Parameters:

expiration - a long value represents for expiration time

expireAfter

default void expireAfter(Long duration)

Sets period of time which items will be expired

Parameters:

duration - a long value represents for period time (in milliseconds)

expireAfter

default void expireAfter(java.time.Duration duration)

Sets period of time which items will be expired

Parameters:

duration - a Duration object represents for period time

See Also:

Duration

newInstance

static CacheItem newInstance(String key)

Creates and returns a new instance of CacheItem with key

Parameters:

key - a string represents for cache's key

Returns:

an instance of CacheItem

newInstance

static CacheItem newInstance(String key,
                             Object value)

Creates and returns a new instance of CacheItem with key

Parameters:

key - a string represents for cache's key

value - an object represents of value

Returns:

an instance of CacheItem

newInstance

static CacheItem newInstance(String key,
                             Object value,
                             Long expiration)

Creates and returns a new instance of CacheItem with key

Parameters:

key - a string represents for cache's key

value - an object represents of value

expiration - a Long value represents of expiration

Returns:

an instance of CacheItem