A C D E G L M N O R S T V

A

AbstractCache<T> - Class in org.xwiki.cache.util

Base class for Cache implementations.

AbstractCache() - Constructor for class org.xwiki.cache.util.AbstractCache

AbstractCacheConfigurationLoader - Class in org.xwiki.cache.util

Base class to load cache configuration.

AbstractCacheConfigurationLoader(CacheConfiguration, String) - Constructor for class org.xwiki.cache.util.AbstractCacheConfigurationLoader

addCacheEntryListener(CacheEntryListener<T>) - Method in interface org.xwiki.cache.Cache

Add the provided listener to the cache to catch events on entries like add, remove etc.

addCacheEntryListener(CacheEntryListener<T>) - Method in class org.xwiki.cache.internal.DefaultCache

Add the provided listener to the cache to catch events on entries like add, remove etc.

addCacheEntryListener(CacheEntryListener<T>) - Method in class org.xwiki.cache.util.AbstractCache

Add the provided listener to the cache to catch events on entries like add, remove etc.

C

Cache<T> - Interface in org.xwiki.cache

Cache interface.

CacheConfiguration - Class in org.xwiki.cache.config

Contains all informations used to create the cache.

CacheConfiguration() - Constructor for class org.xwiki.cache.config.CacheConfiguration

CacheEntry<T> - Interface in org.xwiki.cache

Represents a cache entry with it's key, value, etc.

cacheEntryAdded(CacheEntryEvent<T>) - Method in interface org.xwiki.cache.event.CacheEntryListener

Called when a new value is inserted in the cache.

CacheEntryEvent<T> - Interface in org.xwiki.cache.event

Base object used to contains informations when sending cache entry events.

CacheEntryListener<T> - Interface in org.xwiki.cache.event

cacheEntryListeners - Variable in class org.xwiki.cache.util.AbstractCache

The list of listener to called when events appends on a cache entry.

cacheEntryModified(CacheEntryEvent<T>) - Method in interface org.xwiki.cache.event.CacheEntryListener

Called when an existing value is overwritten in the cache.

cacheEntryRemoved(CacheEntryEvent<T>) - Method in interface org.xwiki.cache.event.CacheEntryListener

Called when an existing value is removed from the cache.

CacheEvent<T> - Interface in org.xwiki.cache.event

CacheException - Exception in org.xwiki.cache

Any exception raised in the XWiki Cache component must raise an exception of this type.

CacheException(String) - Constructor for exception org.xwiki.cache.CacheException

Constructs a new exception with the specified detail message.

CacheException(String, Throwable) - Constructor for exception org.xwiki.cache.CacheException

Constructs a new exception with the specified detail message and cause.

CacheFactory - Interface in org.xwiki.cache

This interface is implemented by a XWiki cache component implementation to provide cache creation.

CacheManager - Interface in org.xwiki.cache

Choose the cache component to use for cache or local cache.

CacheManagerConfiguration - Interface in org.xwiki.cache

Get CacheManager configuration.

configuration - Variable in class org.xwiki.cache.util.AbstractCache

The configuration used to create the cache.

CONFIGURATIONID - Static variable in class org.xwiki.cache.eviction.EntryEvictionConfiguration

The key use to access eviction configuration in the CacheConfiguration.

createNewCache(CacheConfiguration) - Method in interface org.xwiki.cache.CacheManager

Find the cache implementation component to use and create a new cache.

createNewCache(CacheConfiguration) - Method in class org.xwiki.cache.internal.DefaultCacheManager

Find the cache implementation component to use and create a new cache.

createNewCache(CacheConfiguration, String) - Method in class org.xwiki.cache.internal.DefaultCacheManager

Lookup the cache component with provided hint and create a new cache.

createNewLocalCache(CacheConfiguration) - Method in interface org.xwiki.cache.CacheManager

Find the local cache implementation component to use and create a new cache.

createNewLocalCache(CacheConfiguration) - Method in class org.xwiki.cache.internal.DefaultCacheManager

Find the local cache implementation component to use and create a new cache.

createTempDir() - Method in class org.xwiki.cache.util.AbstractCacheConfigurationLoader

D

DefaultCache<T> - Class in org.xwiki.cache.internal

Default implementation of Cache.

DefaultCache() - Constructor for class org.xwiki.cache.internal.DefaultCache

DefaultCacheFactory - Class in org.xwiki.cache.internal

Default implementation of CacheFactory.

DefaultCacheFactory() - Constructor for class org.xwiki.cache.internal.DefaultCacheFactory

DefaultCacheManager - Class in org.xwiki.cache.internal

The default implementation of CacheManager.

DefaultCacheManager() - Constructor for class org.xwiki.cache.internal.DefaultCacheManager

DefaultCacheManagerConfiguration - Class in org.xwiki.cache.internal

Default implementation of CacheManagerConfiguration.

DefaultCacheManagerConfiguration() - Constructor for class org.xwiki.cache.internal.DefaultCacheManagerConfiguration

DisposableCacheValue - Interface in org.xwiki.cache

If the value inserted in the cache implement this interface, the DisposableCacheValue.dispose() method will be called to release all resource used by this data when it is removed from the cache.

dispose() - Method in interface org.xwiki.cache.Cache

Release all the resources this cache use.

dispose() - Method in interface org.xwiki.cache.DisposableCacheValue

dispose() - Method in class org.xwiki.cache.internal.DefaultCache

Release all the resources this cache use.

dispose() - Method in class org.xwiki.cache.util.AbstractCache

Release all the resources this cache use.

disposeCacheValue(T) - Method in class org.xwiki.cache.util.AbstractCache

Dispose the value being removed from the cache.

E

EntryEvictionConfiguration - Class in org.xwiki.cache.eviction

This configuration class is used to add constraints in the configuration of the cache to create.

EntryEvictionConfiguration() - Constructor for class org.xwiki.cache.eviction.EntryEvictionConfiguration

EntryEvictionConfiguration.Algorithm - Enum in org.xwiki.cache.eviction

The ordering/storing algorithm used by the cache.

G

get(String) - Method in interface org.xwiki.cache.Cache

get(String) - Method in class org.xwiki.cache.internal.DefaultCache

getAlgorithm() - Method in class org.xwiki.cache.eviction.EntryEvictionConfiguration

getCache() - Method in interface org.xwiki.cache.CacheEntry

getCache() - Method in interface org.xwiki.cache.event.CacheEvent

getCacheConfiguration() - Method in class org.xwiki.cache.util.AbstractCacheConfigurationLoader

getCacheFactory() - Method in interface org.xwiki.cache.CacheManager

Lookup the cache creation component with provided hint return it.

getCacheFactory() - Method in class org.xwiki.cache.internal.DefaultCacheManager

Lookup the cache creation component with provided hint return it.

getCacheFactory(String) - Method in class org.xwiki.cache.internal.DefaultCacheManager

Lookup the cache creation component with provided hint return it.

getConfigurationId() - Method in class org.xwiki.cache.config.CacheConfiguration

getDefaultCache() - Method in interface org.xwiki.cache.CacheManagerConfiguration

getDefaultCache() - Method in class org.xwiki.cache.internal.DefaultCacheManagerConfiguration

getDefaultLocalCache() - Method in interface org.xwiki.cache.CacheManagerConfiguration

getDefaultLocalCache() - Method in class org.xwiki.cache.internal.DefaultCacheManagerConfiguration

getDefaultPropsId() - Method in class org.xwiki.cache.util.AbstractCacheConfigurationLoader

getEntry() - Method in interface org.xwiki.cache.event.CacheEntryEvent

getKey() - Method in interface org.xwiki.cache.CacheEntry

getLocalCacheFactory() - Method in interface org.xwiki.cache.CacheManager

Lookup the local cache creation component with provided hint return it.

getLocalCacheFactory() - Method in class org.xwiki.cache.internal.DefaultCacheManager

Lookup the local cache creation component with provided hint return it.

getMaxEntries() - Method in class org.xwiki.cache.eviction.LRUEvictionConfiguration

getSize() - Method in class org.xwiki.cache.internal.DefaultCache

getTimeToLive() - Method in class org.xwiki.cache.eviction.EntryEvictionConfiguration

getValue() - Method in interface org.xwiki.cache.CacheEntry

L

LRUEvictionConfiguration - Class in org.xwiki.cache.eviction

An helper for EntryEvictionConfiguration.Algorithm.NONE cache algorithm.

LRUEvictionConfiguration() - Constructor for class org.xwiki.cache.eviction.LRUEvictionConfiguration

Create a new EntryEvictionConfiguration based on LRU algorithm.

M

MAXENTRIES_ID - Static variable in class org.xwiki.cache.eviction.LRUEvictionConfiguration

The key to access the maximum entries the cache can contain.

N

newCache(CacheConfiguration) - Method in interface org.xwiki.cache.CacheFactory

Create and return a custom cache.

newCache(CacheConfiguration) - Method in class org.xwiki.cache.internal.DefaultCacheFactory

Create and return a custom cache.

O

org.xwiki.cache - package org.xwiki.cache

org.xwiki.cache.config - package org.xwiki.cache.config

org.xwiki.cache.event - package org.xwiki.cache.event

org.xwiki.cache.eviction - package org.xwiki.cache.eviction

org.xwiki.cache.internal - package org.xwiki.cache.internal

org.xwiki.cache.util - package org.xwiki.cache.util

R

remove(String) - Method in interface org.xwiki.cache.Cache

Remove the entry associated with the provided key from the cache.

remove(String) - Method in class org.xwiki.cache.internal.DefaultCache

Remove the entry associated with the provided key from the cache.

removeAll() - Method in interface org.xwiki.cache.Cache

Remove all the entries the cache contains.

removeAll() - Method in class org.xwiki.cache.internal.DefaultCache

Remove all the entries the cache contains.

removeCacheEntryListener(CacheEntryListener<T>) - Method in interface org.xwiki.cache.Cache

Remove the provided listener from the list of listeners.

removeCacheEntryListener(CacheEntryListener<T>) - Method in class org.xwiki.cache.internal.DefaultCache

Remove the provided listener from the list of listeners.

removeCacheEntryListener(CacheEntryListener<T>) - Method in class org.xwiki.cache.util.AbstractCache

Remove the provided listener from the list of listeners.

S

sendEntryAddedEvent(CacheEntryEvent<T>) - Method in class org.xwiki.cache.util.AbstractCache

Helper method to send event when a new cache entry is inserted.

sendEntryModifiedEvent(CacheEntryEvent<T>) - Method in class org.xwiki.cache.util.AbstractCache

Helper method to send event when a cache entry is modified.

sendEntryRemovedEvent(CacheEntryEvent<T>) - Method in class org.xwiki.cache.util.AbstractCache

Helper method to send event when an existing cache entry is removed.

set(String, T) - Method in interface org.xwiki.cache.Cache

Add a new value or overwrite the existing one associated with the provided key.

set(String, T) - Method in class org.xwiki.cache.internal.DefaultCache

Add a new value or overwrite the existing one associated with the provided key.

setAlgotithm(EntryEvictionConfiguration.Algorithm) - Method in class org.xwiki.cache.eviction.EntryEvictionConfiguration

setConfigurationId(String) - Method in class org.xwiki.cache.config.CacheConfiguration

setMaxEntries(int) - Method in class org.xwiki.cache.eviction.LRUEvictionConfiguration

setTimeToLive(int) - Method in class org.xwiki.cache.eviction.EntryEvictionConfiguration

T

TIMETOLIVE_ID - Static variable in class org.xwiki.cache.eviction.EntryEvictionConfiguration

The key used to access time to live duration in the EntryEvictionConfiguration.

V

valueOf(String) - Static method in enum org.xwiki.cache.eviction.EntryEvictionConfiguration.Algorithm

Returns the enum constant of this type with the specified name.

values() - Static method in enum org.xwiki.cache.eviction.EntryEvictionConfiguration.Algorithm

Returns an array containing the constants of this enum type, in the order they are declared.

A C D E G L M N O R S T V