Skip navigation links
A C D E G I 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
Deprecated.
AbstractCache(CacheConfiguration) - 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
 
AbstractCacheConfigurationLoader(CacheConfiguration, Environment, String) - Constructor for class org.xwiki.cache.util.AbstractCacheConfigurationLoader
 
AbstractCacheEntryListener<T> - Class in org.xwiki.cache.event
Empty implementations of the CacheEntryListener interface to make it easy for code wanting to listen to events to only override the method(s) corresponding to the event(s) listened to.
AbstractCacheEntryListener() - Constructor for class org.xwiki.cache.event.AbstractCacheEntryListener
 
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.util.AbstractCache
 

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
The default constructor.
CacheConfiguration(String) - Constructor for class org.xwiki.cache.config.CacheConfiguration
 
CacheConfiguration(EntryEvictionConfiguration) - Constructor for class org.xwiki.cache.config.CacheConfiguration
Creates CacheConfiguration instance with given eviction configuration.
CacheConfiguration(String, EntryEvictionConfiguration) - Constructor for class org.xwiki.cache.config.CacheConfiguration
Creates CacheConfiguration instance with given eviction configuration and id.
CacheControl - Interface in org.xwiki.cache
Control the caches behavior in the current context.
CacheEntry<T> - Interface in org.xwiki.cache
Represents a cache entry with it's key, value, etc.
cacheEntryAdded(CacheEntryEvent<T>) - Method in class org.xwiki.cache.event.AbstractCacheEntryListener
 
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 class org.xwiki.cache.event.AbstractCacheEntryListener
 
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 class org.xwiki.cache.event.AbstractCacheEntryListener
 
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.
createNewLocalCache(CacheConfiguration) - Method in interface org.xwiki.cache.CacheManager
Find the local cache implementation component to use and create a new cache.
createTempDir() - Method in class org.xwiki.cache.util.AbstractCacheConfigurationLoader
 

D

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.util.AbstractCache
 
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
 
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.
getConfigurationId() - Method in class org.xwiki.cache.config.CacheConfiguration
 
getDefaultCache() - Method in interface org.xwiki.cache.CacheManagerConfiguration
 
getDefaultLocalCache() - Method in interface org.xwiki.cache.CacheManagerConfiguration
 
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
 
getLifespan() - Method in class org.xwiki.cache.eviction.LRUEvictionConfiguration
 
getLocalCacheFactory() - Method in interface org.xwiki.cache.CacheManager
Lookup the local cache creation component with provided hint return it.
getLRUEvictionConfiguration() - Method in class org.xwiki.cache.config.LRUCacheConfiguration
 
getMaxEntries() - Method in class org.xwiki.cache.eviction.LRUEvictionConfiguration
 
getMaxIdle() - Method in class org.xwiki.cache.eviction.LRUEvictionConfiguration
 
getTimeToLive() - Method in class org.xwiki.cache.eviction.EntryEvictionConfiguration
 
getValue() - Method in interface org.xwiki.cache.CacheEntry
 

I

isCacheReadAllowed(Date) - Method in interface org.xwiki.cache.CacheControl
 
isCacheReadAllowed(ChronoLocalDateTime<?>) - Method in interface org.xwiki.cache.CacheControl
 
isCacheReadAllowed() - Method in interface org.xwiki.cache.CacheControl
 

L

LIFESPAN_ID - Static variable in class org.xwiki.cache.eviction.LRUEvictionConfiguration
 
LRUCacheConfiguration - Class in org.xwiki.cache.config
Cache configuration using LRU eviction method.
LRUCacheConfiguration() - Constructor for class org.xwiki.cache.config.LRUCacheConfiguration
Creates new LRUCacheConfiguration instance with empty (null) configurationId, default size of 100 and time to live 0.
LRUCacheConfiguration(String) - Constructor for class org.xwiki.cache.config.LRUCacheConfiguration
Creates new LRUCacheConfiguration instance with given configurationId, default max size of 100 and time to live 0.
LRUCacheConfiguration(String, int) - Constructor for class org.xwiki.cache.config.LRUCacheConfiguration
Creates new LRUCacheConfiguration instance with given configurationId and max size, and default time to live 0.
LRUCacheConfiguration(String, int, int) - Constructor for class org.xwiki.cache.config.LRUCacheConfiguration
Creates new LRUCacheConfiguration instance with given configurationId, max size and time to live.
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.
LRUEvictionConfiguration(int) - Constructor for class org.xwiki.cache.eviction.LRUEvictionConfiguration
Create a new EntryEvictionConfiguration with given capacity, eviction will be 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.

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.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.
removeAll() - Method in interface org.xwiki.cache.Cache
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.util.AbstractCache
 

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.
setAlgorithm(EntryEvictionConfiguration.Algorithm) - Method in class org.xwiki.cache.eviction.EntryEvictionConfiguration
 
setCacheReadAllowed(boolean) - Method in interface org.xwiki.cache.CacheControl
 
setConfigurationId(String) - Method in class org.xwiki.cache.config.CacheConfiguration
 
setLifespan(int) - Method in class org.xwiki.cache.eviction.LRUEvictionConfiguration
 
setMaxEntries(int) - Method in class org.xwiki.cache.eviction.LRUEvictionConfiguration
 
setMaxIdle(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
 

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 I L M N O R S T V 
Skip navigation links

Copyright © 2004–2019 XWiki. All rights reserved.