com.hazelcast.client.impl.protocol.template

Interface SetCodecTemplate

public interface SetCodecTemplate

Method Summary

Methods

Modifier and Type	Method and Description
Object	add(String name, Data value) Adds the specified element to this set if it is not already present (optional operation).
Object	addAll(String name, List<Data> valueList) Adds all of the elements in the specified collection to this set if they're not already present (optional operation).
Object	addListener(String name, boolean includeValue, boolean localOnly) Adds an item listener for this collection.
Object	clear(String name) Removes all of the elements from this set (optional operation).
Object	compareAndRemoveAll(String name, Set<Data> valueSet) Removes from this set all of its elements that are contained in the specified collection (optional operation).
Object	compareAndRetainAll(String name, Set<Data> valueSet) Retains only the elements in this set that are contained in the specified collection (optional operation).
Object	contains(String name, Data value) Returns true if this set contains the specified element.
Object	containsAll(String name, Set<Data> valueSet) Returns true if this set contains all of the elements of the specified collection.
Object	getAll(String name) Return the all elements of this collection
Object	isEmpty(String name) Returns true if this set contains no elements.
Object	remove(String name, Data value) Removes the specified element from this set if it is present (optional operation).
Object	removeListener(String name, String registrationId) Removes the specified item listener.
Object	size(String name) Returns the number of elements in this set (its cardinality).

Method Detail

size

Object size(String name)

Returns the number of elements in this set (its cardinality). If this set contains more than Integer.MAX_VALUE elements, returns Integer.MAX_VALUE.

Parameters:

name - Name of the Set

Returns:

The number of elements in this set (its cardinality)

contains

Object contains(String name,
              Data value)

Returns true if this set contains the specified element.

Parameters:

name - Name of the Set

value - Element whose presence in this set is to be tested

Returns:

True if this set contains the specified element, false otherwise

containsAll

Object containsAll(String name,
                 Set<Data> valueSet)

Returns true if this set contains all of the elements of the specified collection. If the specified collection is also a set, this method returns true if it is a subset of this set.

Parameters:

name - Name of the Set

valueSet - Collection to be checked for containment in this set

Returns:

true if this set contains all of the elements of the specified collection

add

Object add(String name,
         Data value)

Adds the specified element to this set if it is not already present (optional operation). If this set already contains the element, the call leaves the set unchanged and returns false.In combination with the restriction on constructors, this ensures that sets never contain duplicate elements. The stipulation above does not imply that sets must accept all elements; sets may refuse to add any particular element, including null, and throw an exception, as described in the specification for Collection Individual set implementations should clearly document any restrictions on the elements that they may contain.

Parameters:

name - Name of the Set

value - Element to be added to this set

Returns:

True if this set did not already contain the specified element and the element is added, returns false otherwise.

remove

Object remove(String name,
            Data value)

Removes the specified element from this set if it is present (optional operation). Returns true if this set contained the element (or equivalently, if this set changed as a result of the call). (This set will not contain the element once the call returns.)

Parameters:

name - Name of the Set

value - Object to be removed from this set, if present

Returns:

True if this set contained the specified element and it is removed successfully

addAll

Object addAll(String name,
            List<Data> valueList)

Adds all of the elements in the specified collection to this set if they're not already present (optional operation). If the specified collection is also a set, the addAll operation effectively modifies this set so that its value is the union of the two sets. The behavior of this operation is undefined if the specified collection is modified while the operation is in progress.

Parameters:

name - Name of the Set

valueList - Collection containing elements to be added to this set

Returns:

True if this set changed as a result of the call

compareAndRemoveAll

Object compareAndRemoveAll(String name,
                         Set<Data> valueSet)

Removes from this set all of its elements that are contained in the specified collection (optional operation). If the specified collection is also a set, this operation effectively modifies this set so that its value is the asymmetric set difference of the two sets.

Parameters:

name - Name of the Set

valueSet - The set of values to test for matching the item to remove.

Returns:

true if at least one item in valueSet existed and removed, false otherwise.

compareAndRetainAll

Object compareAndRetainAll(String name,
                         Set<Data> valueSet)

Retains only the elements in this set that are contained in the specified collection (optional operation). In other words, removes from this set all of its elements that are not contained in the specified collection. If the specified collection is also a set, this operation effectively modifies this set so that its value is the intersection of the two sets.

Parameters:

name - Name of the Set

valueSet - The set of values to test for matching the item to retain.

Returns:

true if at least one item in valueSet existed and it is retained, false otherwise. All items not in valueSet but in the Set are removed.

clear

Object clear(String name)

Removes all of the elements from this set (optional operation). The set will be empty after this call returns.

Parameters:

name - Name of the Set

getAll

Object getAll(String name)

Return the all elements of this collection

Parameters:

name - Name of the Set

Returns:

Array of all values in the Set

addListener

Object addListener(String name,
                 boolean includeValue,
                 boolean localOnly)

Adds an item listener for this collection. Listener will be notified for all collection add/remove events.

Parameters:

name - Name of the Set

includeValue - if set to true, the event shall also include the value.

localOnly - if true fires events that originated from this node only, otherwise fires all events

Returns:

The registration id.

removeListener

Object removeListener(String name,
                    String registrationId)

Removes the specified item listener. Returns silently if the specified listener was not added before.

Parameters:

name - Name of the Set

registrationId - The id retrieved during registration.

Returns:

true if the listener with the provided id existed and removed, false otherwise.

isEmpty

Object isEmpty(String name)

Returns true if this set contains no elements.

Parameters:

name - Name of the Set

Returns:

True if this set contains no elements