org.eclipse.collections.api.set.MultiReaderSet Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of eclipse-collections-api Show documentation

There is a newer version: 12.0.0.M3

Show newest version

/*
 * Copyright (c) 2021 Goldman Sachs and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * and Eclipse Distribution License v. 1.0 which accompany this distribution.
 * The Eclipse Public License is available at http://www.eclipse.org/legal/epl-v10.html
 * and the Eclipse Distribution License is available at
 * http://www.eclipse.org/org/documents/edl-v10.php.
 */

package org.eclipse.collections.api.set;

import org.eclipse.collections.api.block.procedure.Procedure;

/**
 * A MultiReaderSet provides thread-safe iteration for a set through methods {@code withReadLockAndDelegate()} and {@code withWriteLockAndDelegate()}.
 *
 * @since 10.0.
 */
public interface MultiReaderSet
        extends MutableSet
{
    void withReadLockAndDelegate(Procedure> procedure);

    void withWriteLockAndDelegate(Procedure> procedure);

    @Override
    MultiReaderSet newEmpty();

    @Override
    MultiReaderSet clone();

    @Override
    default MultiReaderSet with(T element)
    {
        this.add(element);
        return this;
    }

    @Override
    default MultiReaderSet without(T element)
    {
        this.remove(element);
        return this;
    }

    @Override
    default MultiReaderSet withAll(Iterable elements)
    {
        this.addAllIterable(elements);
        return this;
    }

    @Override
    default MultiReaderSet withoutAll(Iterable elements)
    {
        this.removeAllIterable(elements);
        return this;
    }

    @Override
    default MultiReaderSet tap(Procedure procedure)
    {
        this.forEach(procedure);
        return this;
    }
}