CoherenceBasedCache (Java API Reference for Oracle® Coherence Community Edition)

Type Parameters:

K - the type of keys for the Cache

V - the type of values for the Cache

All Superinterfaces:

AutoCloseable, javax.cache.Cache<K,V>, Closeable, Iterable<javax.cache.Cache.Entry<K,V>>

All Known Implementing Classes:

AbstractCoherenceBasedCache, LocalCache, PartitionedCache, PassThroughCache, RemoteCache
```
public interface CoherenceBasedCache<K,V>
extends javax.cache.Cache<K,V>
```
An Coherence-based implementation of a Cache.
All Coherence-based implementations of Cache should implement this interface.

Since:

Coherence 12.1.3

Author:

bo 2013.11.04

Nested Class Summary
- Nested classes/interfaces inherited from interface javax.cache.Cache
  javax.cache.Cache.Entry<K,V>

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`JCACHE_CONFIG_BACK_SCHEME_NAME` The name of the Coherence Scheme that will manage `JCACHE_CONFIG_CACHE_NAME` back-scheme caches.
`static String`	`JCACHE_CONFIG_BACK_SCHEME_SERVICE_NAME` The name of the Coherence Scheme that will manage `JCACHE_CONFIG_CACHE_NAME` back-scheme service.
`static String`	`JCACHE_CONFIG_CACHE_NAME` The name of the Coherence NamedCache that will hold JCache `Configuration`s.
`static String`	`JCACHE_CONFIG_SCHEME_NAME` The name of the Coherence Scheme that will manage `JCACHE_CONFIG_CACHE_NAME` caches.
`static String`	`JCACHE_CONFIG_SERVICE_NAME` The name of the Coherence Service that will manage `JCACHE_CONFIG_CACHE_NAME` caches.
`static String`	`JCACHE_EXTEND_PROXY_SERVICE_NAME`
`static String`	`JCACHE_EXTEND_SCHEME_NAME`
`static String`	`JCACHE_EXTEND_SERVICE_NAME`
`static String`	`JCACHE_LOCAL_CACHE_NAME_PATTERN` The name of the Coherence NamedCache onto which Local JCaches will be mapped.
`static String`	`JCACHE_LOCAL_CACHE_NAME_PREFIX` The Coherence NamedCache name prefix that JCache Local Caches will use.
`static String`	`JCACHE_LOCAL_SCHEME_NAME` The name of the Coherence Scheme that will manage Local caches.
`static String`	`JCACHE_LOCAL_SERVICE_NAME` The name of the Coherence Service that will manage Local caches.
`static String`	`JCACHE_PARTITIONED_CACHE_NAME_PATTERN` The name of the Coherence NamedCache onto which Partitioned JCaches will be mapped.
`static String`	`JCACHE_PARTITIONED_CACHE_NAME_PREFIX` The Coherence NamedCache name prefix that JCache Partitioned Caches use internally.
`static String`	`JCACHE_PARTITIONED_SCHEME_NAME` The name of the Coherence Scheme that will manage partitioned caches.
`static String`	`JCACHE_PARTITIONED_SERVICE_NAME` The name of the Coherence Service that will manage partitioned caches.
`static String`	`JCACHE_REMOTE_SCHEME` The name of the Coherence remote scheme for JCache.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`destroy()` Destroys a `CoherenceBasedCache` due to a request from a `CoherenceBasedCacheManager`.
`JCacheIdentifier`	`getIdentifier()` Obtain the internal identifier used for JCache caches.

Methods inherited from interface javax.cache.Cache
clear, close, containsKey, deregisterCacheEntryListener, get, getAll, getAndPut, getAndRemove, getAndReplace, getCacheManager, getConfiguration, getName, invoke, invokeAll, isClosed, iterator, loadAll, put, putAll, putIfAbsent, registerCacheEntryListener, remove, remove, removeAll, removeAll, replace, replace, unwrap

Methods inherited from interface java.lang.Iterable
forEach, spliterator

- Field Detail
  - JCACHE_CONFIG_CACHE_NAME
```
static final String JCACHE_CONFIG_CACHE_NAME
```
    The name of the Coherence NamedCache that will hold JCache Configurations.
    
    See Also:
    
    Constant Field Values
  - JCACHE_CONFIG_SERVICE_NAME
```
static final String JCACHE_CONFIG_SERVICE_NAME
```
    The name of the Coherence Service that will manage JCACHE_CONFIG_CACHE_NAME caches.
    
    See Also:
    
    Constant Field Values
  - JCACHE_CONFIG_SCHEME_NAME
```
static final String JCACHE_CONFIG_SCHEME_NAME
```
    The name of the Coherence Scheme that will manage JCACHE_CONFIG_CACHE_NAME caches.
    
    See Also:
    
    Constant Field Values
  - JCACHE_CONFIG_BACK_SCHEME_NAME
```
static final String JCACHE_CONFIG_BACK_SCHEME_NAME
```
    The name of the Coherence Scheme that will manage JCACHE_CONFIG_CACHE_NAME back-scheme caches.
    
    See Also:
    
    Constant Field Values
  - JCACHE_CONFIG_BACK_SCHEME_SERVICE_NAME
```
static final String JCACHE_CONFIG_BACK_SCHEME_SERVICE_NAME
```
    The name of the Coherence Scheme that will manage JCACHE_CONFIG_CACHE_NAME back-scheme service.
    
    See Also:
    
    Constant Field Values
  - JCACHE_PARTITIONED_CACHE_NAME_PREFIX
```
static final String JCACHE_PARTITIONED_CACHE_NAME_PREFIX
```
    The Coherence NamedCache name prefix that JCache Partitioned Caches use internally.
    
    See Also:
    
    Constant Field Values
  - JCACHE_PARTITIONED_CACHE_NAME_PATTERN
```
static final String JCACHE_PARTITIONED_CACHE_NAME_PATTERN
```
    The name of the Coherence NamedCache onto which Partitioned JCaches will be mapped.
    
    See Also:
    
    Constant Field Values
  - JCACHE_PARTITIONED_SCHEME_NAME
```
static final String JCACHE_PARTITIONED_SCHEME_NAME
```
    The name of the Coherence Scheme that will manage partitioned caches.
    
    See Also:
    
    Constant Field Values
  - JCACHE_PARTITIONED_SERVICE_NAME
```
static final String JCACHE_PARTITIONED_SERVICE_NAME
```
    The name of the Coherence Service that will manage partitioned caches.
    
    See Also:
    
    Constant Field Values
  - JCACHE_LOCAL_CACHE_NAME_PREFIX
```
static final String JCACHE_LOCAL_CACHE_NAME_PREFIX
```
    The Coherence NamedCache name prefix that JCache Local Caches will use.
    
    See Also:
    
    Constant Field Values
  - JCACHE_LOCAL_CACHE_NAME_PATTERN
```
static final String JCACHE_LOCAL_CACHE_NAME_PATTERN
```
    The name of the Coherence NamedCache onto which Local JCaches will be mapped.
    
    See Also:
    
    Constant Field Values
  - JCACHE_LOCAL_SCHEME_NAME
```
static final String JCACHE_LOCAL_SCHEME_NAME
```
    The name of the Coherence Scheme that will manage Local caches.
    
    See Also:
    
    Constant Field Values
  - JCACHE_LOCAL_SERVICE_NAME
```
static final String JCACHE_LOCAL_SERVICE_NAME
```
    The name of the Coherence Service that will manage Local caches.
    
    See Also:
    
    Constant Field Values
  - JCACHE_EXTEND_SCHEME_NAME
```
static final String JCACHE_EXTEND_SCHEME_NAME
```
    See Also:
    
    Constant Field Values
  - JCACHE_EXTEND_SERVICE_NAME
```
static final String JCACHE_EXTEND_SERVICE_NAME
```
    See Also:
    
    Constant Field Values
  - JCACHE_EXTEND_PROXY_SERVICE_NAME
```
static final String JCACHE_EXTEND_PROXY_SERVICE_NAME
```
    See Also:
    
    Constant Field Values
  - JCACHE_REMOTE_SCHEME
```
static final String JCACHE_REMOTE_SCHEME
```
    The name of the Coherence remote scheme for JCache.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - getIdentifier
```
JCacheIdentifier getIdentifier()
```
    Obtain the internal identifier used for JCache caches.
    
    Returns:
    
    the internal JCacheIdentifier
  - destroy
```
void destroy()
```
    Destroys a CoherenceBasedCache due to a request from a CoherenceBasedCacheManager.

Interface CoherenceBasedCache<K,V>

Nested Class Summary

Nested classes/interfaces inherited from interface javax.cache.Cache

Field Summary

Method Summary

Methods inherited from interface javax.cache.Cache

Methods inherited from interface java.lang.Iterable

Field Detail

JCACHE_CONFIG_CACHE_NAME

JCACHE_CONFIG_SERVICE_NAME

JCACHE_CONFIG_SCHEME_NAME

JCACHE_CONFIG_BACK_SCHEME_NAME

JCACHE_CONFIG_BACK_SCHEME_SERVICE_NAME

JCACHE_PARTITIONED_CACHE_NAME_PREFIX

JCACHE_PARTITIONED_CACHE_NAME_PATTERN

JCACHE_PARTITIONED_SCHEME_NAME

JCACHE_PARTITIONED_SERVICE_NAME

JCACHE_LOCAL_CACHE_NAME_PREFIX

JCACHE_LOCAL_CACHE_NAME_PATTERN

JCACHE_LOCAL_SCHEME_NAME

JCACHE_LOCAL_SERVICE_NAME

JCACHE_EXTEND_SCHEME_NAME

JCACHE_EXTEND_SERVICE_NAME

JCACHE_EXTEND_PROXY_SERVICE_NAME

JCACHE_REMOTE_SCHEME

Method Detail

getIdentifier

destroy