JSR107 API and SPI 1.1.1 · javax.cache.configuration.CompleteConfiguration

Modifier and Type	Method and Description
public Iterable<CacheEntryListenerConfiguration<K, V>>	Returns: an `Iterable` over the `javax.cache.configuration.CacheEntryListenerConfiguration`s getCacheEntryListenerConfigurations() Obtains the `javax.cache.configuration.CacheEntryListenerConfiguration`s for `javax.cache.event.CacheEntryListener`s to be configured on a `javax.cache.Cache`.
public Factory<CacheLoader<K, V>>	Returns: the `javax.cache.configuration.Factory` for the `javax.cache.integration.CacheLoader` or null if none has been set. getCacheLoaderFactory() Gets the `javax.cache.configuration.Factory` for the `javax.cache.integration.CacheLoader`, if any.
public Factory<CacheWriter<? super K, ? super V>>	Returns: the `javax.cache.configuration.Factory` for the `javax.cache.integration.CacheWriter` or null if none has been set. getCacheWriterFactory() Gets the `javax.cache.configuration.Factory` for the `javax.cache.integration.CacheWriter`, if any.
public Factory<ExpiryPolicy>	Returns: the `javax.cache.configuration.Factory` for `javax.cache.expiry.ExpiryPolicy` (must not be `null`) getExpiryPolicyFactory() Gets the `javax.cache.configuration.Factory` for the `javax.cache.expiry.ExpiryPolicy` to be used for caches.
public boolean	Returns: true if management is enabled isManagementEnabled() Checks whether management is enabled on this cache.
public boolean	Returns: `true` when a `javax.cache.Cache` is in "read-through" mode. isReadThrough() Determines if a `javax.cache.Cache` should operate in read-through mode.
public boolean	Returns: true if statistics collection is enabled isStatisticsEnabled() Checks whether statistics collection is enabled in this cache.
public boolean	Returns: `true` when a `javax.cache.Cache` is in "write-through" mode. isWriteThrough() Determines if a `javax.cache.Cache` should operate in write-through mode.

Method Detail

getCacheEntryListenerConfigurations back to summary

getCacheEntryListenerConfigurations	back to summary
public Iterable<CacheEntryListenerConfiguration<K, V>> getCacheEntryListenerConfigurations() Obtains the `javax.cache.configuration.CacheEntryListenerConfiguration`s for `javax.cache.event.CacheEntryListener`s to be configured on a `javax.cache.Cache`. Returns:Iterable<CacheEntryListenerConfiguration<K, V>> an `Iterable` over the `javax.cache.configuration.CacheEntryListenerConfiguration`s

public Iterable<CacheEntryListenerConfiguration<K, V>> getCacheEntryListenerConfigurations()

Obtains the javax.cache.configuration.CacheEntryListenerConfigurations for javax.cache.event.CacheEntryListeners to be configured on a javax.cache.Cache.

Returns:Iterable<CacheEntryListenerConfiguration<K, V>>: an Iterable over the javax.cache.configuration.CacheEntryListenerConfigurations

getCacheLoaderFactory back to summary

getCacheLoaderFactory	back to summary
public Factory<CacheLoader<K, V>> getCacheLoaderFactory() Gets the `javax.cache.configuration.Factory` for the `javax.cache.integration.CacheLoader`, if any. A CacheLoader should be configured for "Read Through" caches to load values when a cache miss occurs using either the `javax.cache.Cache#get(Object)` and/or `javax.cache.Cache#getAll(java.util.Set)` methods. The default value is `null`. Returns:Factory<CacheLoader<K, V>> the `javax.cache.configuration.Factory` for the `javax.cache.integration.CacheLoader` or null if none has been set.

public Factory<CacheLoader<K, V>> getCacheLoaderFactory()

Gets the javax.cache.configuration.Factory for the javax.cache.integration.CacheLoader, if any.

A CacheLoader should be configured for "Read Through" caches to load values when a cache miss occurs using either the javax.cache.Cache#get(Object) and/or javax.cache.Cache#getAll(java.util.Set) methods.

The default value is null.

Returns:Factory<CacheLoader<K, V>>: the javax.cache.configuration.Factory for the javax.cache.integration.CacheLoader or null if none has been set.

getCacheWriterFactory back to summary

getCacheWriterFactory	back to summary
public Factory<CacheWriter<? super K, ? super V>> getCacheWriterFactory() Gets the `javax.cache.configuration.Factory` for the `javax.cache.integration.CacheWriter`, if any. The default value is `null`. Returns:Factory<CacheWriter<? super K, ? super V>> the `javax.cache.configuration.Factory` for the `javax.cache.integration.CacheWriter` or null if none has been set.

public Factory<CacheWriter<? super K, ? super V>> getCacheWriterFactory()

Gets the javax.cache.configuration.Factory for the javax.cache.integration.CacheWriter, if any.

The default value is null.

Returns:Factory<CacheWriter<? super K, ? super V>>: the javax.cache.configuration.Factory for the javax.cache.integration.CacheWriter or null if none has been set.

getExpiryPolicyFactory back to summary

getExpiryPolicyFactory	back to summary
public Factory<ExpiryPolicy> getExpiryPolicyFactory() Gets the `javax.cache.configuration.Factory` for the `javax.cache.expiry.ExpiryPolicy` to be used for caches. The default value is a `javax.cache.configuration.Factory` that will produce a `javax.cache.expiry.EternalExpiryPolicy` instance. Returns:Factory<ExpiryPolicy> the `javax.cache.configuration.Factory` for `javax.cache.expiry.ExpiryPolicy` (must not be `null`)

public Factory<ExpiryPolicy> getExpiryPolicyFactory()

Gets the javax.cache.configuration.Factory for the javax.cache.expiry.ExpiryPolicy to be used for caches.

The default value is a javax.cache.configuration.Factory that will produce a javax.cache.expiry.EternalExpiryPolicy instance.

Returns:Factory<ExpiryPolicy>: the javax.cache.configuration.Factory for javax.cache.expiry.ExpiryPolicy (must not be null)

isManagementEnabled back to summary

isManagementEnabled	back to summary
public boolean isManagementEnabled() Checks whether management is enabled on this cache. The default value is `false`. Returns:boolean true if management is enabled

public boolean isManagementEnabled()

Checks whether management is enabled on this cache.

The default value is false.

Returns:boolean: true if management is enabled

isReadThrough back to summary

isReadThrough	back to summary
public boolean isReadThrough() Determines if a `javax.cache.Cache` should operate in read-through mode. When in "read-through" mode, cache misses that occur due to cache entries not existing as a result of performing a "get" will appropriately cause the configured `javax.cache.integration.CacheLoader` to be invoked. The default value is `false`. Returns:boolean `true` when a `javax.cache.Cache` is in "read-through" mode. See Also `getCacheLoaderFactory()`

public boolean isReadThrough()

Determines if a javax.cache.Cache should operate in read-through mode.

When in "read-through" mode, cache misses that occur due to cache entries not existing as a result of performing a "get" will appropriately cause the configured javax.cache.integration.CacheLoader to be invoked.

The default value is false.

Returns:boolean: true when a javax.cache.Cache is in "read-through" mode.
See Also: getCacheLoaderFactory()

isStatisticsEnabled back to summary

isStatisticsEnabled	back to summary
public boolean isStatisticsEnabled() Checks whether statistics collection is enabled in this cache. The default value is `false`. Returns:boolean true if statistics collection is enabled

public boolean isStatisticsEnabled()

Checks whether statistics collection is enabled in this cache.

The default value is false.

Returns:boolean: true if statistics collection is enabled

isWriteThrough back to summary

isWriteThrough	back to summary
public boolean isWriteThrough() Determines if a `javax.cache.Cache` should operate in write-through mode. When in "write-through" mode, cache updates that occur as a result of performing "put" operations called via one of `javax.cache.Cache#put(Object, Object)`, `javax.cache.Cache#getAndRemove(Object)`, `javax.cache.Cache#removeAll()`, `javax.cache.Cache#getAndPut(Object, Object)` `javax.cache.Cache#getAndRemove(Object)`, `javax.cache.Cache#getAndReplace(Object, Object)`, `javax.cache.Cache#invoke(Object, javax.cache.processor.EntryProcessor, Object...)`, `javax.cache.Cache#invokeAll(java.util.Set, javax.cache.processor.EntryProcessor, Object...)` will appropriately cause the configured `javax.cache.integration.CacheWriter` to be invoked. The default value is `false`. Returns:boolean `true` when a `javax.cache.Cache` is in "write-through" mode. See Also `getCacheWriterFactory()`

public boolean isWriteThrough()

Determines if a javax.cache.Cache should operate in write-through mode.

The default value is false.

Returns:boolean: true when a javax.cache.Cache is in "write-through" mode.
See Also: getCacheWriterFactory()

public Interface CompleteConfiguration<K, V>

Method Summary

Method Detail