com.hazelcast.client.impl.protocol.template.SetCodecTemplate Maven / Gradle / Ivy
/*
* Copyright (c) 2008-2015, Hazelcast, Inc. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.hazelcast.client.impl.protocol.template;
import com.hazelcast.annotation.GenerateCodec;
import com.hazelcast.annotation.Request;
import com.hazelcast.client.impl.protocol.EventMessageConst;
import com.hazelcast.client.impl.protocol.ResponseMessageConst;
import com.hazelcast.nio.serialization.Data;
import java.util.List;
@GenerateCodec(id = TemplateConstants.SET_TEMPLATE_ID, name = "Set", ns = "Hazelcast.Client.Protocol.Codec")
public interface SetCodecTemplate {
/**
* Returns the number of elements in this set (its cardinality). If this set contains more than Integer.MAX_VALUE
* elements, returns Integer.MAX_VALUE.
*
* @param name Name of the Set
* @return The number of elements in this set (its cardinality)
*/
@Request(id = 1, retryable = false, response = ResponseMessageConst.INTEGER, partitionIdentifier = "name")
Object size(String name);
/**
* Returns true if this set contains the specified element.
*
* @param name Name of the Set
* @param value Element whose presence in this set is to be tested
* @return True if this set contains the specified element, false otherwise
*/
@Request(id = 2, retryable = false, response = ResponseMessageConst.BOOLEAN, partitionIdentifier = "name")
Object contains(String name, Data value);
/**
* 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.
*
* @param name Name of the Set
* @param items Collection to be checked for containment in this list
* @return true if this set contains all of the elements of the
* specified collection
*/
@Request(id = 3, retryable = false, response = ResponseMessageConst.BOOLEAN, partitionIdentifier = "name")
Object containsAll(String name, List items);
/**
* 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.
*
* @param name Name of the Set
* @param value Element to be added to this set
* @return True if this set did not already contain the specified
* element and the element is added, returns false otherwise.
*/
@Request(id = 4, retryable = false, response = ResponseMessageConst.BOOLEAN, partitionIdentifier = "name")
Object add(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.)
*
* @param name Name of the Set
* @param value Object to be removed from this set, if present
* @return True if this set contained the specified element and it is removed successfully
*/
@Request(id = 5, retryable = false, response = ResponseMessageConst.BOOLEAN, partitionIdentifier = "name")
Object remove(String name, Data value);
/**
* 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.
*
* @param name Name of the Set
* @param valueList Collection containing elements to be added to this set
* @return True if this set changed as a result of the call
*/
@Request(id = 6, retryable = false, response = ResponseMessageConst.BOOLEAN, partitionIdentifier = "name")
Object addAll(String name, List valueList);
/**
* 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.
*
* @param name Name of the Set
* @param values The list of values to test for matching the item to remove.
* @return true if at least one item in values existed and removed, false otherwise.
*/
@Request(id = 7, retryable = false, response = ResponseMessageConst.BOOLEAN, partitionIdentifier = "name")
Object compareAndRemoveAll(String name, List values);
/**
* 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.
*
* @param name Name of the Set
* @param values The list of values to test for matching the item to retain.
* @return true if at least one item in values existed and it is retained, false otherwise. All items not in valueSet but
* in the Set are removed.
*/
@Request(id = 8, retryable = false, response = ResponseMessageConst.BOOLEAN, partitionIdentifier = "name")
Object compareAndRetainAll(String name, List values);
/**
* Removes all of the elements from this set (optional operation). The set will be empty after this call returns.
*
* @param name Name of the Set
*/
@Request(id = 9, retryable = false, response = ResponseMessageConst.VOID, partitionIdentifier = "name")
Object clear(String name);
/**
* Return the all elements of this collection
*
* @param name Name of the Set
* @return Array of all values in the Set
*/
@Request(id = 10, retryable = false, response = ResponseMessageConst.LIST_DATA, partitionIdentifier = "name")
Object getAll(String name);
/**
* Adds an item listener for this collection. Listener will be notified for all collection add/remove events.
*
* @param name Name of the Set
* @param includeValue if set to true, the event shall also include the value.
* @param localOnly if true fires events that originated from this node only, otherwise fires all events
* @return The registration id.
*/
@Request(id = 11, retryable = false, response = ResponseMessageConst.STRING,
event = {EventMessageConst.EVENT_ITEM})
Object addListener(String name, boolean includeValue, boolean localOnly);
/**
* Removes the specified item listener. Returns silently if the specified listener was not added before.
*
* @param name Name of the Set
* @param registrationId The id retrieved during registration.
* @return true if the listener with the provided id existed and removed, false otherwise.
*/
@Request(id = 12, retryable = true, response = ResponseMessageConst.BOOLEAN)
Object removeListener(String name, String registrationId);
/**
* Returns true if this set contains no elements.
*
* @param name Name of the Set
* @return True if this set contains no elements
*/
@Request(id = 13, retryable = false, response = ResponseMessageConst.BOOLEAN, partitionIdentifier = "name")
Object isEmpty(String name);
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy