net.java.html.lib.angular.ng

Class ICacheObject

java.lang.Object

net.java.html.lib.Objs

net.java.html.lib.angular.ng.ICacheObject

Direct Known Subclasses:

ITemplateCacheService

public class ICacheObject
extends Objs

Nested Class Summary

Nested classes/interfaces inherited from class net.java.html.lib.Objs

Objs.Constructor<T extends Objs>, Objs.Property<T>

Field Summary

Fields inherited from class net.java.html.lib.Objs

prototype

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ICacheObject(Objs.Constructor<?> c, Object js)

Method Summary

Modifier and Type	Method and Description
static ICacheObject	$as(Object obj)
void	destroy() Destroys the Cache object entirely, removing it from the $cacheFactory set.
<T> T	get(String key) Retrieves named data stored in the Cache object.
Objs	info() Retrieve information regarding a particular Cache.
<T> T	put(String key) Inserts a named entry into the Cache object to be retrieved later, and incrementing the size of the cache if the key was not already present in the cache.
<T> T	put(String key, T value) Inserts a named entry into the Cache object to be retrieved later, and incrementing the size of the cache if the key was not already present in the cache.
void	remove(String key) Removes an entry from the Cache object.
void	removeAll() Clears the cache object of any entries.

Methods inherited from class net.java.html.lib.Objs

$as, $cast, $delete, $get, $js, $set, create, create, defineProperties, defineProperty, freeze, getOwnPropertyDescriptor, getOwnPropertyNames, getPrototypeOf, hasOwnProperty, isExtensible, isFrozen, isPrototypeOf, isSealed, keys, newObject, newObject, preventExtensions, propertyIsEnumerable, seal, toLocaleString, toString, valueOf

Methods inherited from class java.lang.Object

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

Constructor Detail

ICacheObject

protected ICacheObject(Objs.Constructor<?> c,
                       Object js)

Method Detail

$as

public static ICacheObject $as(Object obj)

destroy

public void destroy()

Destroys the Cache object entirely, removing it from the $cacheFactory set.

get

public <T> T get(String key)

Retrieves named data stored in the Cache object.

Parameters:

key - the key of the data to be retrieved

info

public Objs info()

Retrieve information regarding a particular Cache.

put

public <T> T put(String key,
                 T value)

Inserts a named entry into the Cache object to be retrieved later, and incrementing the size of the cache if the key was not already present in the cache. If behaving like an LRU cache, it will also remove stale entries from the set. It will not insert undefined values into the cache.

Parameters:

key - the key under which the cached data is stored.

value - the value to store alongside the key. If it is undefined, the key will not be stored.

put

public <T> T put(String key)

Inserts a named entry into the Cache object to be retrieved later, and incrementing the size of the cache if the key was not already present in the cache. If behaving like an LRU cache, it will also remove stale entries from the set. It will not insert undefined values into the cache.

Parameters:

key - the key under which the cached data is stored.

value - the value to store alongside the key. If it is undefined, the key will not be stored.

remove

public void remove(String key)

Removes an entry from the Cache object.

Parameters:

key - the key of the entry to be removed

removeAll

public void removeAll()

Clears the cache object of any entries.