DistCache (GemFire XD Java API Documentation)

All Known Implementing Classes:

GemFireCacheTestImpl, HashMapCacheImpl
```
public interface DistCache
```
Interface for a member of a distributed cache of objects.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`addMembers(Map caches)` Notifies this member about other members of the distributed cache.
`void`	`close()` Closes the local cache.
`void`	`create(Object key, Object value)` Puts the specified key and value into the cache.
`void`	`createCache()` Creates the local cache (with no regions).
`void`	`createKey(Object key)` Puts the specified key, with no value, into the cache.
`void`	`destroy(Object key)` Removes the specified key and its value from the cache.
`Object`	`get(Object key)` Gets the value with the specified key from the cache.
`String`	`getCacheName()` Gets the name of this member of the distributed cache.
`Object`	`getCacheTransactionManager()` Gets the CacheTransactionManager of the distributed cache.
`void`	`invalidate(Object key)` Removes the value from the cache, but keeps the key.
`void`	`localDestroy(Object key)` Removes the specified key and its value from the local cache.
`Object`	`localGet(Object key)` Gets the value with the specified key from the local cache.
`void`	`localInvalidate(Object key)` Removes the value from the local cache, but keeps the key.
`void`	`open()` Opens the local cache.
`void`	`put(Object key, Object value)` Puts the specified value into the cache at the specified key.
`int`	`size()` Returns the number of entries in the local cache.
`void`	`synchPut(Object key, Object value)` Puts the specified value in the cache at the specified key under the protection of a distributed lock.

- Method Detail
  - createCache
```
void createCache()
          throws DistCacheException
```
    Creates the local cache (with no regions).
    
    Throws:
    
    DistCacheException
  - open
```
void open()
   throws DistCacheException
```
    Opens the local cache.
    
    Throws:
    
    DistCacheException
  - close
```
void close()
    throws DistCacheException
```
    Closes the local cache.
    
    Throws:
    
    DistCacheException
  - getCacheName
```
String getCacheName()
```
    Gets the name of this member of the distributed cache.
  - getCacheTransactionManager
```
Object getCacheTransactionManager()
```
    Gets the CacheTransactionManager of the distributed cache. returns null if not implemented
  - addMembers
```
void addMembers(Map caches)
         throws DistCacheException
```
    Notifies this member about other members of the distributed cache.
    
    Throws:
    
    DistCacheException
  - createKey
```
void createKey(Object key)
        throws DistCacheException
```
    Puts the specified key, with no value, into the cache.
    
    Throws:
    
    DistCacheException - if the key already exists.
  - create
```
void create(Object key,
            Object value)
     throws DistCacheException
```
    Puts the specified key and value into the cache.
    
    Throws:
    
    DistCacheException - if the key already exists.
  - put
```
void put(Object key,
         Object value)
  throws DistCacheException
```
    Puts the specified value into the cache at the specified key.
    
    Throws:
    
    DistCacheException - if the value is null.
  - synchPut
```
void synchPut(Object key,
              Object value)
       throws DistCacheException
```
    Puts the specified value in the cache at the specified key under the protection of a distributed lock.
    
    Throws:
    
    DistCacheException - if the key does not exist.
  - get
```
Object get(Object key)
    throws DistCacheException
```
    Gets the value with the specified key from the cache.
    
    Returns:
    
    the value (or null).
    
    Throws:
    
    DistCacheException
  - localGet
```
Object localGet(Object key)
         throws DistCacheException
```
    Gets the value with the specified key from the local cache.
    
    Returns:
    
    the value (or null).
    
    Throws:
    
    DistCacheException
  - invalidate
```
void invalidate(Object key)
         throws DistCacheException
```
    Removes the value from the cache, but keeps the key.
    
    Throws:
    
    DistCacheException
  - localInvalidate
```
void localInvalidate(Object key)
              throws DistCacheException
```
    Removes the value from the local cache, but keeps the key.
    
    Throws:
    
    DistCacheException
  - destroy
```
void destroy(Object key)
      throws DistCacheException
```
    Removes the specified key and its value from the cache.
    
    Throws:
    
    DistCacheException
  - localDestroy
```
void localDestroy(Object key)
           throws DistCacheException
```
    Removes the specified key and its value from the local cache.
    
    Throws:
    
    DistCacheException
  - size
```
int size()
  throws DistCacheException
```
    Returns the number of entries in the local cache.
    
    Throws:
    
    DistCacheException

Interface DistCache

Method Summary

Method Detail

createCache

open

close

getCacheName

getCacheTransactionManager

addMembers

createKey

create

put

synchPut

get

localGet

invalidate

localInvalidate

destroy

localDestroy

size