org.gridgain.grid.cache.datastructures

Interface GridCacheSet<T>

All Superinterfaces:

Collection<T>, Iterable<T>, Set<T>

All Known Implementing Classes:

GridCacheSetImpl, GridCacheSetProxy

public interface GridCacheSet<T>
extends Set<T>

Set implementation based on on In-Memory Data Grid.

Overview

Cache set implements Set interface and provides all methods from collections. Note that all Collection methods in the set may throw GridRuntimeException in case of failure or if set was removed.

Collocated vs Non-collocated

Set items can be placed on one node or distributed throughout grid nodes (governed by collocated parameter). Non-collocated mode is provided only for partitioned caches. If collocated parameter is true, then all set items will be collocated on one node, otherwise items will be distributed through all grid nodes.

See Also:

GridCacheDataStructures.set(String, boolean, boolean), GridCacheDataStructures.removeSet(String)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	collocated() Returns true if this set can be kept on the one node only.
String	name() Gets set name.
boolean	removed() Gets status of set.

Methods inherited from interface java.util.Set

add, addAll, clear, contains, containsAll, equals, hashCode, isEmpty, iterator, remove, removeAll, retainAll, size, toArray, toArray

Method Detail

name

String name()

Gets set name.

Returns:

Set name.

collocated

boolean collocated()
                   throws GridException

Returns true if this set can be kept on the one node only. Returns false if this set can be kept on the many nodes.

Returns:

True if this set is in collocated mode false otherwise.

Throws:

GridException - If operation failed.

removed

boolean removed()

Gets status of set.

Returns:

True if set was removed from cache false otherwise.