Package com.alachisoft.ncache.client.datastructures

Interface CollectionManager

All Known Subinterfaces:

DataStructureManager

public interface CollectionManager

This interface contains create and get operations for all collection data types.

Method Summary

Modifier and Type	Method	Description
<T> DistributedHashSet<T>	createHashSet(java.lang.String key, DataStructureAttributes attributes, WriteThruOptions options, java.lang.Class<?> cls)	Creates Distributed Set against the provided collection name and configures it according to the provided user configuration as attributes of collection.
<T> DistributedHashSet<T>	createHashSet(java.lang.String key, java.lang.Class<?> cls)	Creates Distributed Set against the provided collection name.
<T> DistributedList<T>	createList(java.lang.String key, DataStructureAttributes attributes, WriteThruOptions options, java.lang.Class<?> cls)	Creates Distributed List against the provided collection name and configures it according to the provided user configuration as attributes of collection.
<T> DistributedList<T>	createList(java.lang.String key, java.lang.Class<?> cls)	Creates Distributed List against the provided collection name.
<V> DistributedMap<java.lang.String,V>	createMap(java.lang.String key, DataStructureAttributes attributes, WriteThruOptions options, java.lang.Class<?> cls)	Creates Distributed Map against the provided collection name and configures it according to the provided user configuration as attributes of collection.
<V> DistributedMap<java.lang.String,V>	createMap(java.lang.String key, java.lang.Class<?> cls)	Creates Distributed Map against the provided collection name.
<T> DistributedQueue<T>	createQueue(java.lang.String key, DataStructureAttributes attributes, WriteThruOptions options, java.lang.Class<?> cls)	Creates Distributed Queue against the provided collection name and configures it according to the provided user configuration as attributes of collection.
<T> DistributedQueue<T>	createQueue(java.lang.String key, java.lang.Class<?> cls)	Creates Distributed Queue against the provided collection name.
<T> DistributedHashSet<T>	getHashSet(java.lang.String key, ReadThruOptions options, java.lang.Class<?> cls)	Gets Distributed Set interface against the provided collection name.
<T> DistributedHashSet<T>	getHashSet(java.lang.String key, java.lang.Class<?> cls)	Gets Distributed Set interface against the provided collection name.
<T> DistributedList<T>	getList(java.lang.String key, ReadThruOptions options, java.lang.Class<?> cls)	Gets Distributed List interface against the provided collection name.
<T> DistributedList<T>	getList(java.lang.String key, java.lang.Class<?> cls)	Gets Distributed List interface against the provided collection name.
<V> DistributedMap<java.lang.String,V>	getMap(java.lang.String key, ReadThruOptions options, java.lang.Class<?> cls)	Gets Distributed Map interface against the provided collection name.
<V> DistributedMap<java.lang.String,V>	getMap(java.lang.String key, java.lang.Class<?> cls)	Gets Distributed Map interface against the provided collection name.
<T> DistributedQueue<T>	getQueue(java.lang.String key, ReadThruOptions options, java.lang.Class<?> cls)	Gets Distributed Queue interface against the provided collection name.
<T> DistributedQueue<T>	getQueue(java.lang.String key, java.lang.Class<?> cls)	Gets Distributed Queue interface against the provided collection name.

Method Detail

createList

<T> DistributedList<T> createList(java.lang.String key,
                                  java.lang.Class<?> cls)
                           throws CacheException

Creates Distributed List against the provided collection name.

Type Parameters:

T - Type of List items.

Parameters:

key - Name of collection to be created.

cls - Class of the List items.

Returns:

Interface for using List.

Throws:

CacheException

createList

<T> DistributedList<T> createList(java.lang.String key,
                                  DataStructureAttributes attributes,
                                  WriteThruOptions options,
                                  java.lang.Class<?> cls)
                           throws CacheException

Creates Distributed List against the provided collection name and configures it according to the provided user configuration as attributes of collection.

Type Parameters:

T - Type of List items.

Parameters:

key - Name of collection to be created.

attributes - DataStructureAttributes for providing user configuration for this collection.

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

cls - Class of the List items.

Returns:

Interface for using List.

Throws:

CacheException

createQueue

<T> DistributedQueue<T> createQueue(java.lang.String key,
                                    java.lang.Class<?> cls)
                             throws CacheException

Creates Distributed Queue against the provided collection name.

Type Parameters:

T - Type of Queue items.

Parameters:

key - Name of collection to be created.

cls - Class of Queue items.

Returns:

Interface for using Queue.

Throws:

CacheException

createQueue

<T> DistributedQueue<T> createQueue(java.lang.String key,
                                    DataStructureAttributes attributes,
                                    WriteThruOptions options,
                                    java.lang.Class<?> cls)
                             throws CacheException

Creates Distributed Queue against the provided collection name and configures it according to the provided user configuration as attributes of collection.

Type Parameters:

T - Type of Queue items.

Parameters:

key - Name of collection to be created.

attributes - DataStructureAttributes for providing user configuration for this collection.

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

cls - Class of Queue items.

Returns:

Interface for using Queue.

Throws:

CacheException

createMap

<V> DistributedMap<java.lang.String,V> createMap(java.lang.String key,
                                                       java.lang.Class<?> cls)
                                                throws CacheException

Creates Distributed Map against the provided collection name.

Type Parameters:

V - Type of Map values.

Parameters:

key - Name of collection to be created.

cls - Class of Map values.

Returns:

Interface for using Dictionary.

Throws:

CacheException

createMap

<V> DistributedMap<java.lang.String,V> createMap(java.lang.String key,
                                                       DataStructureAttributes attributes,
                                                       WriteThruOptions options,
                                                       java.lang.Class<?> cls)
                                                throws CacheException

Creates Distributed Map against the provided collection name and configures it according to the provided user configuration as attributes of collection.

Type Parameters:

V - Type of Map values.

Parameters:

key - Name of collection to be created.

attributes - DataStructureAttributes for providing user configuration for this collection.

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

cls - Class of Map values.

Returns:

Interface for using Dictionary.

Throws:

CacheException

createHashSet

<T> DistributedHashSet<T> createHashSet(java.lang.String key,
                                        java.lang.Class<?> cls)
                                 throws CacheException

Creates Distributed Set against the provided collection name.

Type Parameters:

T - Type of Set items.

Parameters:

key - Name of collection to be created.

cls - Class of Set items.

Returns:

Interface for using Set.

Throws:

CacheException

createHashSet

<T> DistributedHashSet<T> createHashSet(java.lang.String key,
                                        DataStructureAttributes attributes,
                                        WriteThruOptions options,
                                        java.lang.Class<?> cls)
                                 throws CacheException

Creates Distributed Set against the provided collection name and configures it according to the provided user configuration as attributes of collection.

Type Parameters:

T - Type of Set items.

Parameters:

key - Name of collection to be created.

attributes - DataStructureAttributes for providing user configuration for this collection.

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

cls - Class of Set items.

Returns:

Interface for using Set.

Throws:

CacheException

getList

<T> DistributedList<T> getList(java.lang.String key,
                               java.lang.Class<?> cls)
                        throws CacheException

Gets Distributed List interface against the provided collection name.

Type Parameters:

T - Type of List items.

Parameters:

key - Name of collection.

cls - Class of the List items.

Returns:

Interface for using List.

Throws:

CacheException

getList

<T> DistributedList<T> getList(java.lang.String key,
                               ReadThruOptions options,
                               java.lang.Class<?> cls)
                        throws CacheException

Gets Distributed List interface against the provided collection name.

Type Parameters:

T - Type of List items.

Parameters:

key - Name of collection.

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

cls - Class of the List items.

Returns:

Interface for using List.

Throws:

CacheException

getQueue

<T> DistributedQueue<T> getQueue(java.lang.String key,
                                 java.lang.Class<?> cls)
                          throws CacheException

Gets Distributed Queue interface against the provided collection name.

Type Parameters:

T - Type of Queue items.

Parameters:

key - Name of collection to be created.

cls - Class of Queue items.

Returns:

Interface for using Queue.

Throws:

CacheException

getQueue

<T> DistributedQueue<T> getQueue(java.lang.String key,
                                 ReadThruOptions options,
                                 java.lang.Class<?> cls)
                          throws CacheException

Gets Distributed Queue interface against the provided collection name.

Type Parameters:

T - Type of Queue items.

Parameters:

key - Name of collection to be created.

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

cls - Class of Queue items.

Returns:

Interface for using Queue.

Throws:

CacheException

getMap

<V> DistributedMap<java.lang.String,V> getMap(java.lang.String key,
                                                    java.lang.Class<?> cls)
                                             throws CacheException

Gets Distributed Map interface against the provided collection name.

Type Parameters:

V - Type of Map values.

Parameters:

key - Name of collection.

cls - Class of Map values.

Returns:

Interface for using Map.

Throws:

CacheException

getMap

<V> DistributedMap<java.lang.String,V> getMap(java.lang.String key,
                                                    ReadThruOptions options,
                                                    java.lang.Class<?> cls)
                                             throws CacheException

Gets Distributed Map interface against the provided collection name.

Type Parameters:

V - Type of Map values.

Parameters:

key - Name of collection.

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

cls - Class of Map values.

Returns:

Interface for using Map.

Throws:

CacheException

getHashSet

<T> DistributedHashSet<T> getHashSet(java.lang.String key,
                                     java.lang.Class<?> cls)
                              throws CacheException

Gets Distributed Set interface against the provided collection name.

Type Parameters:

T - Type of Set items.

Parameters:

key - Name of collection.

cls - Class of Set items.

Returns:

Interface for using Set.

Throws:

CacheException

getHashSet

<T> DistributedHashSet<T> getHashSet(java.lang.String key,
                                     ReadThruOptions options,
                                     java.lang.Class<?> cls)
                              throws CacheException

Gets Distributed Set interface against the provided collection name.

Type Parameters:

T - Type of Set items.

Parameters:

key - Name of collection.

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

cls - Class of Set items.

Returns:

Interface for using Set.

Throws:

CacheException