org.eclipse.collections.impl.set.mutable.MultiReaderUnifiedSet Maven / Gradle / Ivy
/*
* Copyright (c) 2022 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.impl.set.mutable;
import java.io.Externalizable;
import java.io.IOException;
import java.io.ObjectInput;
import java.io.ObjectOutput;
import java.util.Iterator;
import java.util.RandomAccess;
import java.util.Set;
import java.util.concurrent.ExecutorService;
import java.util.concurrent.locks.ReadWriteLock;
import java.util.concurrent.locks.ReentrantReadWriteLock;
import org.eclipse.collections.api.LazyIterable;
import org.eclipse.collections.api.RichIterable;
import org.eclipse.collections.api.block.function.Function;
import org.eclipse.collections.api.block.function.Function2;
import org.eclipse.collections.api.block.function.primitive.BooleanFunction;
import org.eclipse.collections.api.block.function.primitive.ByteFunction;
import org.eclipse.collections.api.block.function.primitive.CharFunction;
import org.eclipse.collections.api.block.function.primitive.DoubleFunction;
import org.eclipse.collections.api.block.function.primitive.FloatFunction;
import org.eclipse.collections.api.block.function.primitive.IntFunction;
import org.eclipse.collections.api.block.function.primitive.LongFunction;
import org.eclipse.collections.api.block.function.primitive.ShortFunction;
import org.eclipse.collections.api.block.predicate.Predicate;
import org.eclipse.collections.api.block.predicate.Predicate2;
import org.eclipse.collections.api.block.procedure.Procedure;
import org.eclipse.collections.api.factory.Sets;
import org.eclipse.collections.api.list.MutableList;
import org.eclipse.collections.api.map.MutableMap;
import org.eclipse.collections.api.multimap.set.MutableSetMultimap;
import org.eclipse.collections.api.ordered.OrderedIterable;
import org.eclipse.collections.api.partition.set.PartitionMutableSet;
import org.eclipse.collections.api.set.ImmutableSet;
import org.eclipse.collections.api.set.MultiReaderSet;
import org.eclipse.collections.api.set.MutableSet;
import org.eclipse.collections.api.set.ParallelUnsortedSetIterable;
import org.eclipse.collections.api.set.SetIterable;
import org.eclipse.collections.api.set.UnsortedSetIterable;
import org.eclipse.collections.api.set.primitive.MutableBooleanSet;
import org.eclipse.collections.api.set.primitive.MutableByteSet;
import org.eclipse.collections.api.set.primitive.MutableCharSet;
import org.eclipse.collections.api.set.primitive.MutableDoubleSet;
import org.eclipse.collections.api.set.primitive.MutableFloatSet;
import org.eclipse.collections.api.set.primitive.MutableIntSet;
import org.eclipse.collections.api.set.primitive.MutableLongSet;
import org.eclipse.collections.api.set.primitive.MutableShortSet;
import org.eclipse.collections.api.tuple.Pair;
import org.eclipse.collections.impl.collection.mutable.AbstractMultiReaderMutableCollection;
import org.eclipse.collections.impl.lazy.parallel.set.MultiReaderParallelUnsortedSetIterable;
import static org.eclipse.collections.impl.factory.Iterables.mList;
/**
* MultiReadUnifiedSet provides a thread-safe wrapper around a UnifiedSet, using a ReentrantReadWriteLock. In order to
* provide true thread-safety, MultiReaderUnifiedSet does not implement {@code iterator()} as this method requires an external
* lock to be taken to provide thread-safe iteration. You can use an {@code iterator()} if you use the
* {@code withReadLockAndDelegate()} or {@code withWriteLockAndDelegate()} methods. Both of these methods take a parameter of type
* {@code Procedure}, and a wrapped version of the underlying Unified is returned. This wrapper guarantees that no
* external pointer can ever reference the underlying UnifiedSet outside a locked procedure. In the case of the read
* lock method, an Unmodifiable version of the collection is offered, which will throw UnsupportedOperationExceptions on
* any write methods like add or remove.
*/
public final class MultiReaderUnifiedSet
extends AbstractMultiReaderMutableCollection
implements RandomAccess, Externalizable, MultiReaderSet
{
private static final long serialVersionUID = 1L;
private MutableSet delegate;
/**
* @deprecated Empty default constructor used for serialization.
*/
@SuppressWarnings("UnusedDeclaration")
@Deprecated
public MultiReaderUnifiedSet()
{
// For Externalizable use only
}
private MultiReaderUnifiedSet(MutableSet newDelegate)
{
this(newDelegate, new ReentrantReadWriteLock());
}
private MultiReaderUnifiedSet(MutableSet newDelegate, ReadWriteLock newLock)
{
this.lock = newLock;
this.lockWrapper = new ReadWriteLockWrapper(newLock);
this.delegate = newDelegate;
}
public static MultiReaderUnifiedSet newSet()
{
return new MultiReaderUnifiedSet<>(Sets.mutable.empty());
}
public static MultiReaderUnifiedSet newSet(int capacity)
{
return new MultiReaderUnifiedSet<>(UnifiedSet.newSet(capacity));
}
public static MultiReaderUnifiedSet newSet(Iterable iterable)
{
return new MultiReaderUnifiedSet<>(UnifiedSet.newSet(iterable));
}
public static MultiReaderUnifiedSet newSetWith(T... elements)
{
return new MultiReaderUnifiedSet<>(UnifiedSet.newSetWith(elements));
}
@Override
protected MutableSet getDelegate()
{
return this.delegate;
}
// Exposed for testing
UntouchableMutableSet asReadUntouchable()
{
return new UntouchableMutableSet<>(this.delegate.asUnmodifiable());
}
// Exposed for testing
UntouchableMutableSet asWriteUntouchable()
{
return new UntouchableMutableSet<>(this.delegate);
}
@Override
public void withReadLockAndDelegate(Procedure> procedure)
{
try (LockWrapper wrapper = this.lockWrapper.acquireReadLock())
{
UntouchableMutableSet untouchableSet = this.asReadUntouchable();
procedure.value(untouchableSet);
untouchableSet.becomeUseless();
}
}
@Override
public void withWriteLockAndDelegate(Procedure> procedure)
{
try (LockWrapper wrapper = this.lockWrapper.acquireWriteLock())
{
UntouchableMutableSet untouchableSet = this.asWriteUntouchable();
procedure.value(untouchableSet);
untouchableSet.becomeUseless();
}
}
@Override
public MutableSet asSynchronized()
{
try (LockWrapper wrapper = this.lockWrapper.acquireReadLock())
{
return SynchronizedMutableSet.of(this);
}
}
@Override
public ImmutableSet toImmutable()
{
try (LockWrapper wrapper = this.lockWrapper.acquireReadLock())
{
return Sets.immutable.withAll(this.delegate);
}
}
@Override
public MutableSet asUnmodifiable()
{
try (LockWrapper wrapper = this.lockWrapper.acquireReadLock())
{
return UnmodifiableMutableSet.of(this);
}
}
@Override
public MutableSet clone()
{
try (LockWrapper wrapper = this.lockWrapper.acquireReadLock())
{
return new MultiReaderUnifiedSet<>(this.delegate.clone());
}
}
@Override
public MutableSet collect(Function function)
{
try (LockWrapper wrapper = this.lockWrapper.acquireReadLock())
{
return this.delegate.collect(function);
}
}
@Override
public MutableBooleanSet collectBoolean(BooleanFunction booleanFunction)
{
try (LockWrapper wrapper = this.lockWrapper.acquireReadLock())
{
return this.delegate.collectBoolean(booleanFunction);
}
}
@Override
public MutableByteSet collectByte(ByteFunction byteFunction)
{
try (LockWrapper wrapper = this.lockWrapper.acquireReadLock())
{
return this.delegate.collectByte(byteFunction);
}
}
@Override
public MutableCharSet collectChar(CharFunction charFunction)
{
try (LockWrapper wrapper = this.lockWrapper.acquireReadLock())
{
return this.delegate.collectChar(charFunction);
}
}
@Override
public MutableDoubleSet collectDouble(DoubleFunction doubleFunction)
{
try (LockWrapper wrapper = this.lockWrapper.acquireReadLock())
{
return this.delegate.collectDouble(doubleFunction);
}
}
@Override
public MutableFloatSet collectFloat(FloatFunction floatFunction)
{
try (LockWrapper wrapper = this.lockWrapper.acquireReadLock())
{
return this.delegate.collectFloat(floatFunction);
}
}
@Override
public MutableIntSet collectInt(IntFunction intFunction)
{
try (LockWrapper wrapper = this.lockWrapper.acquireReadLock())
{
return this.delegate.collectInt(intFunction);
}
}
@Override
public MutableLongSet collectLong(LongFunction longFunction)
{
try (LockWrapper wrapper = this.lockWrapper.acquireReadLock())
{
return this.delegate.collectLong(longFunction);
}
}
@Override
public MutableShortSet collectShort(ShortFunction shortFunction)
{
try (LockWrapper wrapper = this.lockWrapper.acquireReadLock())
{
return this.delegate.collectShort(shortFunction);
}
}
@Override
public MutableSet flatCollect(Function> function)
{
try (LockWrapper wrapper = this.lockWrapper.acquireReadLock())
{
return this.delegate.flatCollect(function);
}
}
@Override
public MutableSet collectIf(
Predicate predicate,
Function function)
{
try (LockWrapper wrapper = this.lockWrapper.acquireReadLock())
{
return this.delegate.collectIf(predicate, function);
}
}
@Override
public MutableSet collectWith(
Function2 function,
P parameter)
{
try (LockWrapper wrapper = this.lockWrapper.acquireReadLock())
{
return this.delegate.collectWith(function, parameter);
}
}
@Override
public MutableSet newEmpty()
{
return MultiReaderUnifiedSet.newSet();
}
@Override
public MutableSet reject(Predicate predicate)
{
try (LockWrapper wrapper = this.lockWrapper.acquireReadLock())
{
return this.delegate.reject(predicate);
}
}
@Override
public MutableSet rejectWith(
Predicate2 predicate,
P parameter)
{
try (LockWrapper wrapper = this.lockWrapper.acquireReadLock())
{
return this.delegate.rejectWith(predicate, parameter);
}
}
@Override
public MutableSet tap(Procedure procedure)
{
try (LockWrapper wrapper = this.lockWrapper.acquireReadLock())
{
this.forEach(procedure);
return this;
}
}
@Override
public MutableSet select(Predicate predicate)
{
try (LockWrapper wrapper = this.lockWrapper.acquireReadLock())
{
return this.delegate.select(predicate);
}
}
@Override
public MutableSet selectWith(
Predicate2 predicate,
P parameter)
{
try (LockWrapper wrapper = this.lockWrapper.acquireReadLock())
{
return this.delegate.selectWith(predicate, parameter);
}
}
@Override
public PartitionMutableSet partition(Predicate predicate)
{
try (LockWrapper wrapper = this.lockWrapper.acquireReadLock())
{
return this.delegate.partition(predicate);
}
}
@Override
public PartitionMutableSet partitionWith(Predicate2 predicate, P parameter)
{
try (LockWrapper wrapper = this.lockWrapper.acquireReadLock())
{
return this.delegate.partitionWith(predicate, parameter);
}
}
@Override
public MutableSet selectInstancesOf(Class clazz)
{
try (LockWrapper wrapper = this.lockWrapper.acquireReadLock())
{
return this.delegate.selectInstancesOf(clazz);
}
}
@Override
public MutableSet with(T element)
{
this.add(element);
return this;
}
@Override
public MutableSet without(T element)
{
this.remove(element);
return this;
}
@Override
public MutableSet withAll(Iterable elements)
{
this.addAllIterable(elements);
return this;
}
@Override
public MutableSet withoutAll(Iterable elements)
{
this.removeAllIterable(elements);
return this;
}
@Override
public boolean equals(Object o)
{
if (o == this || o == this.delegate)
{
return true;
}
if (!(o instanceof Set))
{
return false;
}
try (LockWrapper wrapper = this.lockWrapper.acquireReadLock())
{
return this.delegate.equals(o);
}
}
@Override
public int hashCode()
{
try (LockWrapper wrapper = this.lockWrapper.acquireReadLock())
{
return this.delegate.hashCode();
}
}
@Override
public void writeExternal(ObjectOutput out) throws IOException
{
out.writeObject(this.delegate);
}
@Override
public void readExternal(ObjectInput in) throws IOException, ClassNotFoundException
{
this.delegate = (MutableSet) in.readObject();
this.lock = new ReentrantReadWriteLock();
this.lockWrapper = new ReadWriteLockWrapper(this.lock);
}
// Exposed for testing
static final class UntouchableMutableSet
extends UntouchableMutableCollection
implements MutableSet
{
private final MutableList> requestedIterators = mList();
private UntouchableMutableSet(MutableSet newDelegate)
{
super(newDelegate);
}
@Override
protected MutableSet getDelegate()
{
return (MutableSet) this.delegate;
}
public void becomeUseless()
{
this.delegate = null;
this.requestedIterators.each(UntouchableIterator::becomeUseless);
}
/**
* This must be implemented this way to guarantee a reference to the delegate doesn't escape.
*/
@Override
public MutableSet with(T element)
{
this.add(element);
return this;
}
@Override
public MutableSet without(T element)
{
this.remove(element);
return this;
}
@Override
public MutableSet withAll(Iterable elements)
{
this.addAllIterable(elements);
return this;
}
@Override
public MutableSet withoutAll(Iterable elements)
{
this.removeAllIterable(elements);
return this;
}
@Override
public MutableSet asSynchronized()
{
throw new UnsupportedOperationException("Cannot call asSynchronized() on " + this.getClass().getSimpleName());
}
@Override
public MutableSet asUnmodifiable()
{
throw new UnsupportedOperationException("Cannot call asUnmodifiable() on " + this.getClass().getSimpleName());
}
@Override
public ImmutableSet toImmutable()
{
return Sets.immutable.withAll(this.getDelegate());
}
@Override
public MutableSet clone()
{
return this.getDelegate().clone();
}
@Override
public MutableSet collect(Function function)
{
return this.getDelegate().collect(function);
}
@Override
public MutableBooleanSet collectBoolean(BooleanFunction booleanFunction)
{
return this.getDelegate().collectBoolean(booleanFunction);
}
@Override
public MutableByteSet collectByte(ByteFunction byteFunction)
{
return this.getDelegate().collectByte(byteFunction);
}
@Override
public MutableCharSet collectChar(CharFunction charFunction)
{
return this.getDelegate().collectChar(charFunction);
}
@Override
public MutableDoubleSet collectDouble(DoubleFunction doubleFunction)
{
return this.getDelegate().collectDouble(doubleFunction);
}
@Override
public MutableFloatSet collectFloat(FloatFunction floatFunction)
{
return this.getDelegate().collectFloat(floatFunction);
}
@Override
public MutableIntSet collectInt(IntFunction intFunction)
{
return this.getDelegate().collectInt(intFunction);
}
@Override
public MutableLongSet collectLong(LongFunction longFunction)
{
return this.getDelegate().collectLong(longFunction);
}
@Override
public MutableShortSet collectShort(ShortFunction shortFunction)
{
return this.getDelegate().collectShort(shortFunction);
}
@Override
public MutableSet flatCollect(Function> function)
{
return this.getDelegate().flatCollect(function);
}
@Override
public MutableSet collectIf(
Predicate predicate,
Function function)
{
return this.getDelegate().collectIf(predicate, function);
}
@Override
public MutableSet collectWith(
Function2 function,
P parameter)
{
return this.getDelegate().collectWith(function, parameter);
}
@Override
public MutableSetMultimap groupBy(
Function function)
{
return this.getDelegate().groupBy(function);
}
@Override
public MutableSetMultimap groupByEach(
Function> function)
{
return this.getDelegate().groupByEach(function);
}
@Override
public MutableSet newEmpty()
{
return this.getDelegate().newEmpty();
}
@Override
public MutableSet reject(Predicate predicate)
{
return this.getDelegate().reject(predicate);
}
@Override
public MutableSet rejectWith(
Predicate2 predicate,
P parameter)
{
return this.getDelegate().rejectWith(predicate, parameter);
}
@Override
public MutableSet tap(Procedure procedure)
{
this.forEach(procedure);
return this;
}
@Override
public MutableSet select(Predicate predicate)
{
return this.getDelegate().select(predicate);
}
@Override
public MutableSet selectWith(
Predicate2 predicate,
P parameter)
{
return this.getDelegate().selectWith(predicate, parameter);
}
@Override
public PartitionMutableSet partition(Predicate predicate)
{
return this.getDelegate().partition(predicate);
}
@Override
public PartitionMutableSet partitionWith(Predicate2 predicate, P parameter)
{
return this.getDelegate().partitionWith(predicate, parameter);
}
@Override
public MutableSet selectInstancesOf(Class clazz)
{
return this.getDelegate().selectInstancesOf(clazz);
}
@Override
public Iterator iterator()
{
UntouchableIterator iterator = new UntouchableIterator<>(this.delegate.iterator());
this.requestedIterators.add(iterator);
return iterator;
}
/**
* @deprecated in 6.0. Use {@link OrderedIterable#zip(Iterable)} instead.
*/
@Override
@Deprecated
public MutableSet> zip(Iterable that)
{
return this.getDelegate().zip(that);
}
/**
* @deprecated in 6.0. Use {@link OrderedIterable#zipWithIndex()} instead.
*/
@Override
@Deprecated
public MutableSet> zipWithIndex()
{
return this.getDelegate().zipWithIndex();
}
@Override
public MutableSet union(SetIterable set)
{
return this.getDelegate().union(set);
}
@Override
public > R unionInto(SetIterable set, R targetSet)
{
return this.getDelegate().unionInto(set, targetSet);
}
@Override
public MutableSet intersect(SetIterable set)
{
return this.getDelegate().intersect(set);
}
@Override
public > R intersectInto(SetIterable set, R targetSet)
{
return this.getDelegate().intersectInto(set, targetSet);
}
@Override
public MutableSet difference(SetIterable subtrahendSet)
{
return this.getDelegate().difference(subtrahendSet);
}
@Override
public > R differenceInto(SetIterable subtrahendSet, R targetSet)
{
return this.getDelegate().differenceInto(subtrahendSet, targetSet);
}
@Override
public MutableSet symmetricDifference(SetIterable setB)
{
return this.getDelegate().symmetricDifference(setB);
}
@Override
public > R symmetricDifferenceInto(SetIterable set, R targetSet)
{
return this.getDelegate().symmetricDifferenceInto(set, targetSet);
}
@Override
public boolean isSubsetOf(SetIterable candidateSuperset)
{
return this.getDelegate().isSubsetOf(candidateSuperset);
}
@Override
public boolean isProperSubsetOf(SetIterable candidateSuperset)
{
return this.getDelegate().isProperSubsetOf(candidateSuperset);
}
@Override
public MutableSet> powerSet()
{
return this.getDelegate().powerSet();
}
@Override
public LazyIterable> cartesianProduct(SetIterable set)
{
return this.getDelegate().cartesianProduct(set);
}
@Override
public ParallelUnsortedSetIterable asParallel(ExecutorService executorService, int batchSize)
{
return this.getDelegate().asParallel(executorService, batchSize);
}
}
private static final class UntouchableIterator
implements Iterator
{
private Iterator delegate;
private UntouchableIterator(Iterator newDelegate)
{
this.delegate = newDelegate;
}
@Override
public boolean hasNext()
{
return this.delegate.hasNext();
}
@Override
public T next()
{
return this.delegate.next();
}
@Override
public void remove()
{
this.delegate.remove();
}
public void becomeUseless()
{
this.delegate = null;
}
}
@Override
public MutableSetMultimap groupBy(Function function)
{
try (LockWrapper wrapper = this.lockWrapper.acquireReadLock())
{
return this.delegate.groupBy(function);
}
}
@Override
public MutableSetMultimap groupByEach(Function> function)
{
try (LockWrapper wrapper = this.lockWrapper.acquireReadLock())
{
return this.delegate.groupByEach(function);
}
}
@Override
public MutableMap groupByUniqueKey(Function function)
{
try (LockWrapper wrapper = this.lockWrapper.acquireReadLock())
{
return this.delegate.groupByUniqueKey(function);
}
}
/**
* @deprecated in 6.0. Use {@link OrderedIterable#zip(Iterable)} instead.
*/
@Override
@Deprecated
public MutableSet> zip(Iterable that)
{
try (LockWrapper wrapper = this.lockWrapper.acquireReadLock())
{
return this.delegate.zip(that);
}
}
/**
* @deprecated in 6.0. Use {@link OrderedIterable#zipWithIndex()} instead.
*/
@Override
@Deprecated
public MutableSet> zipWithIndex()
{
try (LockWrapper wrapper = this.lockWrapper.acquireReadLock())
{
return this.delegate.zipWithIndex();
}
}
@Override
public RichIterable> chunk(int size)
{
try (LockWrapper wrapper = this.lockWrapper.acquireReadLock())
{
return this.delegate.chunk(size);
}
}
@Override
public MutableSet union(SetIterable set)
{
try (LockWrapper wrapper = this.lockWrapper.acquireReadLock())
{
return this.delegate.union(set);
}
}
@Override
public > R unionInto(SetIterable set, R targetSet)
{
try (LockWrapper wrapper = this.lockWrapper.acquireReadLock())
{
return this.delegate.unionInto(set, targetSet);
}
}
@Override
public MutableSet intersect(SetIterable set)
{
try (LockWrapper wrapper = this.lockWrapper.acquireReadLock())
{
return this.delegate.intersect(set);
}
}
@Override
public > R intersectInto(SetIterable set, R targetSet)
{
try (LockWrapper wrapper = this.lockWrapper.acquireReadLock())
{
return this.delegate.intersectInto(set, targetSet);
}
}
@Override
public MutableSet difference(SetIterable subtrahendSet)
{
try (LockWrapper wrapper = this.lockWrapper.acquireReadLock())
{
return this.delegate.difference(subtrahendSet);
}
}
@Override
public > R differenceInto(SetIterable subtrahendSet, R targetSet)
{
try (LockWrapper wrapper = this.lockWrapper.acquireReadLock())
{
return this.delegate.differenceInto(subtrahendSet, targetSet);
}
}
@Override
public MutableSet symmetricDifference(SetIterable setB)
{
try (LockWrapper wrapper = this.lockWrapper.acquireReadLock())
{
return this.delegate.symmetricDifference(setB);
}
}
@Override
public > R symmetricDifferenceInto(SetIterable set, R targetSet)
{
try (LockWrapper wrapper = this.lockWrapper.acquireReadLock())
{
return this.delegate.symmetricDifferenceInto(set, targetSet);
}
}
@Override
public boolean isSubsetOf(SetIterable candidateSuperset)
{
try (LockWrapper wrapper = this.lockWrapper.acquireReadLock())
{
return this.delegate.isSubsetOf(candidateSuperset);
}
}
@Override
public boolean isProperSubsetOf(SetIterable candidateSuperset)
{
try (LockWrapper wrapper = this.lockWrapper.acquireReadLock())
{
return this.delegate.isProperSubsetOf(candidateSuperset);
}
}
@Override
public MutableSet> powerSet()
{
try (LockWrapper wrapper = this.lockWrapper.acquireReadLock())
{
return this.delegate.powerSet();
}
}
@Override
public LazyIterable> cartesianProduct(SetIterable set)
{
try (LockWrapper wrapper = this.lockWrapper.acquireReadLock())
{
return this.delegate.cartesianProduct(set);
}
}
@Override
public ParallelUnsortedSetIterable asParallel(ExecutorService executorService, int batchSize)
{
try (LockWrapper wrapper = this.lockWrapper.acquireReadLock())
{
return new MultiReaderParallelUnsortedSetIterable<>(this.delegate.asParallel(executorService, batchSize), this.lock);
}
}
}