from hazelcast.protocol.codec import (
set_add_all_codec,
set_add_codec,
set_add_listener_codec,
set_clear_codec,
set_compare_and_remove_all_codec,
set_compare_and_retain_all_codec,
set_contains_all_codec,
set_contains_codec,
set_get_all_codec,
set_is_empty_codec,
set_remove_codec,
set_remove_listener_codec,
set_size_codec,
)
from hazelcast.proxy.base import PartitionSpecificProxy, ItemEvent, ItemEventType
from hazelcast.util import check_not_none, ImmutableLazyDataList
[docs]class Set(PartitionSpecificProxy):
"""Concurrent, distributed implementation of Set"""
[docs] def add(self, item):
"""Adds the specified item if it is not exists in this set.
Args:
item: The specified item to be added.
Returns:
hazelcast.future.Future[bool]: ``True`` if this set is changed after call, ``False`` otherwise.
"""
check_not_none(item, "Value can't be None")
element_data = self._to_data(item)
request = set_add_codec.encode_request(self.name, element_data)
return self._invoke(request, set_add_codec.decode_response)
[docs] def add_all(self, items):
"""Adds the elements in the specified collection if they're not exist in this set.
Args:
items (list): Collection which includes the items to be added.
Returns:
hazelcast.future.Future[bool]: ``True`` if this set is changed after call, ``False`` otherwise.
"""
check_not_none(items, "Value can't be None")
data_items = []
for item in items:
check_not_none(item, "Value can't be None")
data_items.append(self._to_data(item))
request = set_add_all_codec.encode_request(self.name, data_items)
return self._invoke(request, set_add_all_codec.decode_response)
[docs] def add_listener(self, include_value=False, item_added_func=None, item_removed_func=None):
"""Adds an item listener for this container.
Listener will be notified for all container add/remove events.
Args:
include_value (bool): Whether received events include the updated item or not.
item_added_func (function): Function to be called when an item is added to this set.
item_removed_func (function): Function to be called when an item is deleted from this set.
Returns:
hazelcast.future.Future[str]: A registration id which is used as a key to remove the listener.
"""
request = set_add_listener_codec.encode_request(self.name, include_value, self._is_smart)
def handle_event_item(item, uuid, event_type):
item = item if include_value else None
member = self._context.cluster_service.get_member(uuid)
item_event = ItemEvent(self.name, item, event_type, member, self._to_object)
if event_type == ItemEventType.ADDED:
if item_added_func:
item_added_func(item_event)
else:
if item_removed_func:
item_removed_func(item_event)
return self._register_listener(
request,
lambda r: set_add_listener_codec.decode_response(r),
lambda reg_id: set_remove_listener_codec.encode_request(self.name, reg_id),
lambda m: set_add_listener_codec.handle(m, handle_event_item),
)
[docs] def clear(self):
"""Clears the set. Set will be empty with this call.
Returns:
hazelcast.future.Future[None]:
"""
request = set_clear_codec.encode_request(self.name)
return self._invoke(request)
[docs] def contains(self, item):
"""Determines whether this set contains the specified item or not.
Args:
item: The specified item to be searched.
Returns:
hazelcast.future.Future[bool]: ``True`` if the specified item exists in this set, ``False`` otherwise.
"""
check_not_none(item, "Value can't be None")
item_data = self._to_data(item)
request = set_contains_codec.encode_request(self.name, item_data)
return self._invoke(request, set_contains_codec.decode_response)
[docs] def contains_all(self, items):
"""Determines whether this set contains all of the items in the specified collection or not.
Args:
items (list): The specified collection which includes the items to be searched.
Returns:
hazelcast.future.Future[bool]: ``True`` if all of the items in the specified collection exist in this set,
``False`` otherwise.
"""
check_not_none(items, "Value can't be None")
data_items = []
for item in items:
check_not_none(item, "Value can't be None")
data_items.append(self._to_data(item))
request = set_contains_all_codec.encode_request(self.name, data_items)
return self._invoke(request, set_contains_all_codec.decode_response)
[docs] def get_all(self):
"""Returns all of the items in the set.
Returns:
hazelcast.future.Future[list]: List of the items in this set.
"""
def handler(message):
return ImmutableLazyDataList(
set_get_all_codec.decode_response(message), self._to_object
)
request = set_get_all_codec.encode_request(self.name)
return self._invoke(request, handler)
[docs] def is_empty(self):
"""Determines whether this set is empty or not.
Returns:
hazelcast.future.Future[bool]: ``True`` if this set is empty, ``False`` otherwise.
"""
request = set_is_empty_codec.encode_request(self.name)
return self._invoke(request, set_is_empty_codec.decode_response)
[docs] def remove(self, item):
"""Removes the specified element from the set if it exists.
Args:
item: The specified element to be removed.
Returns:
hazelcast.future.Future[bool]: ``True`` if the specified element exists in this set, ``False`` otherwise.
"""
check_not_none(item, "Value can't be None")
item_data = self._to_data(item)
request = set_remove_codec.encode_request(self.name, item_data)
return self._invoke(request, set_remove_codec.decode_response)
[docs] def remove_all(self, items):
"""Removes all of the elements of the specified collection from this set.
Args:
items (list): The specified collection.
Returns:
hazelcast.future.Future[bool]: ``True`` if the call changed this set, ``False`` otherwise.
"""
check_not_none(items, "Value can't be None")
data_items = []
for item in items:
check_not_none(item, "Value can't be None")
data_items.append(self._to_data(item))
request = set_compare_and_remove_all_codec.encode_request(self.name, data_items)
return self._invoke(request, set_compare_and_remove_all_codec.decode_response)
[docs] def remove_listener(self, registration_id):
"""Removes the specified item listener.
Returns silently if the specified listener was not added before.
Args:
registration_id (str): Id of the listener to be deleted.
Returns:
hazelcast.future.Future[bool]: ``True`` if the item listener is removed, ``False`` otherwise.
"""
return self._deregister_listener(registration_id)
[docs] def retain_all(self, items):
"""Removes the items which are not contained in the specified collection.
In other words, only the items that are contained in the specified collection will be retained.
Args:
items (list): Collection which includes the elements to be retained in this set.
Returns:
hazelcast.future.Future[bool]: ``True`` if this set changed as a result of the call, ``False`` otherwise.
"""
check_not_none(items, "Value can't be None")
data_items = []
for item in items:
check_not_none(item, "Value can't be None")
data_items.append(self._to_data(item))
request = set_compare_and_retain_all_codec.encode_request(self.name, data_items)
return self._invoke(request, set_compare_and_retain_all_codec.decode_response)
[docs] def size(self):
"""Returns the number of items in this set.
Returns:
hazelcast.future.Future[int]: Number of items in this set.
"""
request = set_size_codec.encode_request(self.name)
return self._invoke(request, set_size_codec.decode_response)