org.b3log.latke.cache

Interface Cache

All Known Implementing Classes:

AbstractCache, CaffeineCache, NoneCache, RedisCache

public interface Cache

This is the top interface of cache like structures.

This cache can not hold null key or value.

Version:

3.1.0.0, Jun 8, 2019

Author:

Liang Ding

Method Summary

Modifier and Type	Method and Description
void	clear() Clear all cached objects.
boolean	contains(String key) Checks whether an object specified by the given key is in cache.
JSONObject	get(String key) Gets a object by the specified key.
String	getName() Gets the name of this cache.
void	put(String key, JSONObject value) Puts the specified object into this cache.
void	remove(Collection<String> keys) Remove objects by the specified keys.
void	remove(String key) Removes a object by the specified key.
void	setName(String name) Sets the name of this cache with the specified name.

Method Detail

setName

void setName(String name)

Sets the name of this cache with the specified name.

Parameters:

name - the specified name

getName

String getName()

Gets the name of this cache.

Returns:

name of this cache

contains

boolean contains(String key)

Checks whether an object specified by the given key is in cache.

Parameters:

key - the given key

Returns:

true if it is in cache, returns false otherwise

put

void put(String key,
         JSONObject value)

Puts the specified object into this cache.

Throws IllegalArgumentException if the specified key or value is null.

Parameters:

key - the key of the specified object

value - the specified object

get

JSONObject get(String key)

Gets a object by the specified key.

Returns null if the specified key is null.

Parameters:

key - the specified key

Returns:

if found, returns the object, otherwise returns null

remove

void remove(String key)

Removes a object by the specified key.

Parameters:

key - the specified key

remove

void remove(Collection<String> keys)

Remove objects by the specified keys.

Parameters:

keys - the specified keys

clear

void clear()

Clear all cached objects.