org.eclipse.collections.impl.set.immutable.AbstractImmutableSet Maven / Gradle / Ivy
/*
* Copyright (c) 2015 Goldman Sachs.
* 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.immutable;
import java.util.Iterator;
import java.util.Set;
import java.util.concurrent.ExecutorService;
import net.jcip.annotations.Immutable;
import org.eclipse.collections.api.LazyIterable;
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.collection.MutableCollection;
import org.eclipse.collections.api.list.MutableList;
import org.eclipse.collections.api.multimap.MutableMultimap;
import org.eclipse.collections.api.multimap.set.ImmutableSetMultimap;
import org.eclipse.collections.api.ordered.OrderedIterable;
import org.eclipse.collections.api.partition.set.PartitionImmutableSet;
import org.eclipse.collections.api.partition.set.PartitionMutableSet;
import org.eclipse.collections.api.set.ImmutableSet;
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.ImmutableBooleanSet;
import org.eclipse.collections.api.set.primitive.ImmutableByteSet;
import org.eclipse.collections.api.set.primitive.ImmutableCharSet;
import org.eclipse.collections.api.set.primitive.ImmutableDoubleSet;
import org.eclipse.collections.api.set.primitive.ImmutableFloatSet;
import org.eclipse.collections.api.set.primitive.ImmutableIntSet;
import org.eclipse.collections.api.set.primitive.ImmutableLongSet;
import org.eclipse.collections.api.set.primitive.ImmutableShortSet;
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.block.factory.Functions;
import org.eclipse.collections.impl.block.factory.Predicates;
import org.eclipse.collections.impl.block.procedure.CollectIfProcedure;
import org.eclipse.collections.impl.block.procedure.CollectProcedure;
import org.eclipse.collections.impl.block.procedure.FlatCollectProcedure;
import org.eclipse.collections.impl.block.procedure.MultimapEachPutProcedure;
import org.eclipse.collections.impl.block.procedure.MultimapPutProcedure;
import org.eclipse.collections.impl.block.procedure.PartitionPredicate2Procedure;
import org.eclipse.collections.impl.block.procedure.PartitionProcedure;
import org.eclipse.collections.impl.block.procedure.RejectProcedure;
import org.eclipse.collections.impl.block.procedure.SelectInstancesOfProcedure;
import org.eclipse.collections.impl.block.procedure.SelectProcedure;
import org.eclipse.collections.impl.block.procedure.primitive.CollectBooleanProcedure;
import org.eclipse.collections.impl.block.procedure.primitive.CollectByteProcedure;
import org.eclipse.collections.impl.block.procedure.primitive.CollectCharProcedure;
import org.eclipse.collections.impl.block.procedure.primitive.CollectDoubleProcedure;
import org.eclipse.collections.impl.block.procedure.primitive.CollectFloatProcedure;
import org.eclipse.collections.impl.block.procedure.primitive.CollectIntProcedure;
import org.eclipse.collections.impl.block.procedure.primitive.CollectLongProcedure;
import org.eclipse.collections.impl.block.procedure.primitive.CollectShortProcedure;
import org.eclipse.collections.impl.collection.immutable.AbstractImmutableCollection;
import org.eclipse.collections.impl.factory.Sets;
import org.eclipse.collections.impl.list.mutable.FastList;
import org.eclipse.collections.impl.multimap.set.UnifiedSetMultimap;
import org.eclipse.collections.impl.partition.set.PartitionUnifiedSet;
import org.eclipse.collections.impl.set.mutable.UnifiedSet;
import org.eclipse.collections.impl.set.mutable.primitive.BooleanHashSet;
import org.eclipse.collections.impl.set.mutable.primitive.ByteHashSet;
import org.eclipse.collections.impl.set.mutable.primitive.CharHashSet;
import org.eclipse.collections.impl.set.mutable.primitive.DoubleHashSet;
import org.eclipse.collections.impl.set.mutable.primitive.FloatHashSet;
import org.eclipse.collections.impl.set.mutable.primitive.IntHashSet;
import org.eclipse.collections.impl.set.mutable.primitive.LongHashSet;
import org.eclipse.collections.impl.set.mutable.primitive.ShortHashSet;
import org.eclipse.collections.impl.utility.internal.SetIterables;
/**
* This class is the parent class for all ImmutableSets. All implementations of ImmutableSet must implement the Set
* interface so anArraySet.equals(anImmutableSet) can return true when the contents and order are the same.
*/
@Immutable
public abstract class AbstractImmutableSet extends AbstractImmutableCollection
implements ImmutableSet, Set
{
public Set castToSet()
{
return this;
}
protected int nullSafeHashCode(Object element)
{
return element == null ? 0 : element.hashCode();
}
public ImmutableSet newWith(T element)
{
if (!this.contains(element))
{
MutableSet result = UnifiedSet.newSet(this);
result.add(element);
return result.toImmutable();
}
return this;
}
public ImmutableSet newWithout(T element)
{
if (this.contains(element))
{
MutableSet result = UnifiedSet.newSet(this);
result.remove(element);
return result.toImmutable();
}
return this;
}
public ImmutableSet newWithAll(Iterable elements)
{
MutableSet result = UnifiedSet.newSet(elements);
result.addAll(this);
return result.toImmutable();
}
public ImmutableSet newWithoutAll(Iterable elements)
{
MutableSet result = UnifiedSet.newSet(this);
this.removeAllFrom(elements, result);
return result.toImmutable();
}
public ImmutableSet tap(Procedure procedure)
{
this.forEach(procedure);
return this;
}
public ImmutableSet select(Predicate predicate)
{
MutableList intermediateResult = FastList.newList();
this.forEach(new SelectProcedure(predicate, intermediateResult));
return Sets.immutable.withAll(intermediateResult);
}
public ImmutableSet selectWith(Predicate2 predicate, P parameter)
{
return this.select(Predicates.bind(predicate, parameter));
}
public ImmutableSet reject(Predicate predicate)
{
MutableList intermediateResult = FastList.newList();
this.forEach(new RejectProcedure(predicate, intermediateResult));
return Sets.immutable.withAll(intermediateResult);
}
public ImmutableSet rejectWith(Predicate2 predicate, P parameter)
{
return this.reject(Predicates.bind(predicate, parameter));
}
public PartitionImmutableSet partition(Predicate predicate)
{
PartitionMutableSet partitionUnifiedSet = new PartitionUnifiedSet();
this.forEach(new PartitionProcedure(predicate, partitionUnifiedSet));
return partitionUnifiedSet.toImmutable();
}
public PartitionImmutableSet partitionWith(Predicate2 predicate, P parameter)
{
PartitionMutableSet partitionUnifiedSet = new PartitionUnifiedSet();
this.forEach(new PartitionPredicate2Procedure(predicate, parameter, partitionUnifiedSet));
return partitionUnifiedSet.toImmutable();
}
public ImmutableSet selectInstancesOf(Class clazz)
{
MutableSet result = UnifiedSet.newSet(this.size());
this.forEach(new SelectInstancesOfProcedure(clazz, result));
return result.toImmutable();
}
public ImmutableSet collect(Function function)
{
MutableSet result = UnifiedSet.newSet();
this.forEach(new CollectProcedure(function, result));
return result.toImmutable();
}
public ImmutableBooleanSet collectBoolean(BooleanFunction booleanFunction)
{
MutableBooleanSet result = new BooleanHashSet();
this.forEach(new CollectBooleanProcedure(booleanFunction, result));
return result.toImmutable();
}
public ImmutableByteSet collectByte(ByteFunction byteFunction)
{
MutableByteSet result = new ByteHashSet();
this.forEach(new CollectByteProcedure(byteFunction, result));
return result.toImmutable();
}
public ImmutableCharSet collectChar(CharFunction charFunction)
{
MutableCharSet result = new CharHashSet(this.size());
this.forEach(new CollectCharProcedure(charFunction, result));
return result.toImmutable();
}
public ImmutableDoubleSet collectDouble(DoubleFunction doubleFunction)
{
MutableDoubleSet result = new DoubleHashSet(this.size());
this.forEach(new CollectDoubleProcedure(doubleFunction, result));
return result.toImmutable();
}
public ImmutableFloatSet collectFloat(FloatFunction floatFunction)
{
MutableFloatSet result = new FloatHashSet(this.size());
this.forEach(new CollectFloatProcedure(floatFunction, result));
return result.toImmutable();
}
public ImmutableIntSet collectInt(IntFunction intFunction)
{
MutableIntSet result = new IntHashSet(this.size());
this.forEach(new CollectIntProcedure(intFunction, result));
return result.toImmutable();
}
public ImmutableLongSet collectLong(LongFunction longFunction)
{
MutableLongSet result = new LongHashSet(this.size());
this.forEach(new CollectLongProcedure(longFunction, result));
return result.toImmutable();
}
public ImmutableShortSet collectShort(ShortFunction shortFunction)
{
MutableShortSet result = new ShortHashSet(this.size());
this.forEach(new CollectShortProcedure(shortFunction, result));
return result.toImmutable();
}
public ImmutableSet collectWith(Function2 function, P parameter)
{
return this.collect(Functions.bind(function, parameter));
}
public ImmutableSet collectIf(Predicate predicate, Function function)
{
MutableSet result = UnifiedSet.newSet();
this.forEach(new CollectIfProcedure(result, function, predicate));
return result.toImmutable();
}
public ImmutableSet flatCollect(Function> function)
{
MutableSet result = UnifiedSet.newSet();
this.forEach(new FlatCollectProcedure(function, result));
return result.toImmutable();
}
public ImmutableSet toImmutable()
{
return this;
}
protected abstract class ImmutableSetIterator
implements Iterator
{
private int next; // next entry to return, defaults to 0
protected abstract T getElement(int i);
public boolean hasNext()
{
return this.next < AbstractImmutableSet.this.size();
}
public T next()
{
return this.getElement(this.next++);
}
public void remove()
{
throw new UnsupportedOperationException("Cannot remove from an ImmutableSet");
}
}
public ImmutableSetMultimap groupBy(Function function)
{
return this.groupBy(function, UnifiedSetMultimap.newMultimap()).toImmutable();
}
@Override
public > R groupBy(Function function, R target)
{
this.forEach(MultimapPutProcedure.on(target, function));
return target;
}
public ImmutableSetMultimap groupByEach(Function> function)
{
return this.groupByEach(function, UnifiedSetMultimap.newMultimap()).toImmutable();
}
@Override
public > R groupByEach(Function> function, R target)
{
this.forEach(MultimapEachPutProcedure.on(target, function));
return target;
}
/**
* @deprecated in 6.0. Use {@link OrderedIterable#zip(Iterable)} instead.
*/
@Deprecated
public ImmutableSet> zip(Iterable that)
{
return this.zip(that, UnifiedSet.>newSet()).toImmutable();
}
/**
* @deprecated in 6.0. Use {@link OrderedIterable#zipWithIndex()} instead.
*/
@Deprecated
public ImmutableSet> zipWithIndex()
{
return this.zipWithIndex(UnifiedSet.>newSet()).toImmutable();
}
@Override
protected MutableCollection newMutable(int size)
{
return UnifiedSet.newSet(size);
}
public ImmutableSet union(SetIterable set)
{
return SetIterables.union(this, set).toImmutable();
}
public > R unionInto(SetIterable set, R targetSet)
{
return SetIterables.unionInto(this, set, targetSet);
}
public ImmutableSet intersect(SetIterable set)
{
return SetIterables.intersect(this, set).toImmutable();
}
public > R intersectInto(SetIterable set, R targetSet)
{
return SetIterables.intersectInto(this, set, targetSet);
}
public ImmutableSet difference(SetIterable subtrahendSet)
{
return SetIterables.difference(this, subtrahendSet).toImmutable();
}
public > R differenceInto(SetIterable subtrahendSet, R targetSet)
{
return SetIterables.differenceInto(this, subtrahendSet, targetSet);
}
public ImmutableSet symmetricDifference(SetIterable setB)
{
return SetIterables.symmetricDifference(this, setB).toImmutable();
}
public > R symmetricDifferenceInto(SetIterable set, R targetSet)
{
return SetIterables.symmetricDifferenceInto(this, set, targetSet);
}
public boolean isSubsetOf(SetIterable candidateSuperset)
{
return SetIterables.isSubsetOf(this, candidateSuperset);
}
public boolean isProperSubsetOf(SetIterable candidateSuperset)
{
return SetIterables.isProperSubsetOf(this, candidateSuperset);
}
public ImmutableSet> powerSet()
{
return (ImmutableSet>) (ImmutableSet) SetIterables.immutablePowerSet(this);
}
public LazyIterable> cartesianProduct(SetIterable set)
{
return SetIterables.cartesianProduct(this, set);
}
public ParallelUnsortedSetIterable asParallel(ExecutorService executorService, int batchSize)
{
return this.toSet().asParallel(executorService, batchSize);
}
}