Provides a contract to access a caching system. More...

Inheritance diagram for Deveel.Data.Caching.ICache:

Public Member Functions
bool	TryGet (object key, out object value)
	Tries to get an object for the given key from the underlying cache system. More...

bool	Set (object key, object value)
	Sets an object into the underlying caching system. More...

object	Remove (object key)
	Removes an object from the cache. More...

void	Clear ()
	Clears all the cached items within the underlying system. More...

Detailed Description

Provides a contract to access a caching system.

Definition at line 25 of file ICache.cs.

Member Function Documentation

void Deveel.Data.Caching.ICache.Clear ( )

Clears all the cached items within the underlying system.

object Deveel.Data.Caching.ICache.Remove ( object key )

Removes an object from the cache.

Parameters

key	The key referencing the object to remove from the cache.

Returns: Returns the value of the object removed from the cache, or null if the key was not found or the value stored was null.

bool Deveel.Data.Caching.ICache.Set	(	object	key,
		object	value
	)

Sets an object into the underlying caching system.

Parameters

key	The key used to identify the object to store.
value	The object value to store into the cache.

Returns: Returns true if the given value was newly added, or false if an object for the given key was previously set and the method only sets a new value.

bool Deveel.Data.Caching.ICache.TryGet	(	object	key,
		out object	value
	)

Tries to get an object for the given key from the underlying cache system.

Parameters

key	The key of the object to return.
value	The value corresponding to the provided key, obtained from the underlying cache. This value can also be `null` if it was not possible to find the key given in the cache.

Returns: Returns true if the corresponding key was found in the underlying cache, otherwise false.

The documentation for this interface was generated from the following file:

/var/calculate/remote/distfiles/egit-src/deveeldb.git/src/deveeldb/Deveel.Data.Caching/ICache.cs