hazelcast-master/hazelcast/src/main/java/com/hazelcast/collection/ISet.java
/*
 * Copyright (c) 2008-2023, 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.collection;

import java.util.Set;

import com.hazelcast.config.SplitBrainProtectionConfig;

/**
 * Concurrent, distributed implementation of {@link Set}
 * <p>
 * <b>Note:</b> This class is <i>not</i> a general-purpose {@link Set}
 * implementation! While this class implements the {@link Set} interface,
 * it intentionally violates {@link Set}'s general contract, which mandates the
 * use of the {@code equals()} method when comparing objects. Instead of the
 * equals method this implementation compares the serialized byte version
 * of the objects.
 * <p>
 * Supports split brain protection {@link SplitBrainProtectionConfig} since 3.10 in cluster
 * versions 3.10 and higher.
 *
 * @param <E> the type of elements maintained by this set
 * @see Set
 */
public interface ISet<E> extends Set<E>, ICollection<E> {

    /**
     * Returns {@link LocalSetStats} for this collection.
     *
     * @return this collection's local statistics.
     */
    LocalSetStats getLocalSetStats();

}
