Package com.alachisoft.ncache.client.datastructures

Interface DataStructureManager

All Superinterfaces:

CollectionManager

public interface DataStructureManager
extends CollectionManager

This interface contains create and get operations for the Counter and remove operation for all distributed data structures.

Method Summary

Modifier and Type	Method	Description
Counter	createCounter(java.lang.String key)	Creates the Counter against the provided name.
Counter	createCounter(java.lang.String key, long initialValue)	Creates the Counter against the provided name.
Counter	createCounter(java.lang.String name, DataStructureAttributes attributes, long initialValue, WriteThruOptions options)	Creates the Counter against the provided name and configures it according to the provided user configuration as attributes.
Counter	getCounter(java.lang.String key)	Gets Counter interface against the provided name.
Counter	getCounter(java.lang.String key, ReadThruOptions options)	Gets Counter interface against the provided name with backing source ReadThruOptions.
void	remove(java.lang.String key)	Remove the specified data structure.
void	remove(java.lang.String key, WriteThruOptions writeThruOptions)	Remove the specified data structure.

Methods inherited from interface com.alachisoft.ncache.client.datastructures.CollectionManager

createHashSet, createHashSet, createList, createList, createMap, createMap, createQueue, createQueue, getHashSet, getHashSet, getList, getList, getMap, getMap, getQueue, getQueue

Method Detail

createCounter

Counter createCounter(java.lang.String key)
               throws CacheException,
                      java.lang.IllegalArgumentException

Creates the Counter against the provided name.

Parameters:

key - This is the unqiue identifier for Counter object. Initial value of Counter is zero.

Returns:

Interface for using Counters.

Throws:

CacheException

java.lang.IllegalArgumentException

createCounter

Counter createCounter(java.lang.String key,
                      long initialValue)
               throws CacheException,
                      java.lang.IllegalArgumentException

Creates the Counter against the provided name.

Parameters:

key - This is the unqiue identifier for Counter object.

initialValue - This is the starting index of Counter object.

Returns:

Interface for using Counters.

Throws:

CacheException

java.lang.IllegalArgumentException

createCounter

Counter createCounter(java.lang.String name,
                      DataStructureAttributes attributes,
                      long initialValue,
                      WriteThruOptions options)
               throws CacheException,
                      java.lang.IllegalArgumentException

Creates the Counter against the provided name and configures it according to the provided user configuration as attributes.

Parameters:

name - This is the unqiue identifier for Counter object.

attributes - DataStructureAttributes for providing user configuration for this collection.

initialValue - This is the starting index of Counter object

options - WriteThruOptions regarding updating data source. This can be WriteThru, WriteBehind or none.

Returns:

Interface for using Counters.

Throws:

CacheException

java.lang.IllegalArgumentException

remove

void remove(java.lang.String key)
     throws CacheException,
            java.io.IOException

Remove the specified data structure.

Parameters:

key - Name of the data type.

Throws:

CacheException

java.io.IOException

remove

void remove(java.lang.String key,
            WriteThruOptions writeThruOptions)
     throws CacheException,
            java.io.IOException

Remove the specified data structure.

Parameters:

key - Name of the data type.

writeThruOptions - WriteThruOptions regarding updating data source. This can be WriteThru, WriteBehind or none.

Throws:

CacheException

java.io.IOException

getCounter

Counter getCounter(java.lang.String key)
            throws CacheException,
                   java.lang.IllegalArgumentException

Gets Counter interface against the provided name.

Parameters:

key - Name of Counter.

Returns:

Interface for using Counters.

Throws:

CacheException

java.lang.IllegalArgumentException

getCounter

Counter getCounter(java.lang.String key,
                   ReadThruOptions options)
            throws CacheException,
                   java.lang.IllegalArgumentException

Gets Counter interface against the provided name with backing source ReadThruOptions.

Parameters:

key - Name of Counter.

options - ReadThruOptions to read from data source. These can be either ReadThru, ReadThruForced or none.

Returns:

Interface for using Counters.

Throws:

CacheException

java.lang.IllegalArgumentException