org.eclipse.collections.api.map.primitive.ImmutablePrimitiveObjectMap Maven / Gradle / Ivy
/*
* Copyright (c) 2021 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.api.map.primitive;
import org.eclipse.collections.api.bag.ImmutableBag;
import org.eclipse.collections.api.bag.primitive.ImmutableBooleanBag;
import org.eclipse.collections.api.bag.primitive.ImmutableByteBag;
import org.eclipse.collections.api.bag.primitive.ImmutableCharBag;
import org.eclipse.collections.api.bag.primitive.ImmutableDoubleBag;
import org.eclipse.collections.api.bag.primitive.ImmutableFloatBag;
import org.eclipse.collections.api.bag.primitive.ImmutableIntBag;
import org.eclipse.collections.api.bag.primitive.ImmutableLongBag;
import org.eclipse.collections.api.bag.primitive.ImmutableShortBag;
import org.eclipse.collections.api.block.function.Function;
import org.eclipse.collections.api.block.function.Function0;
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.Procedure2;
import org.eclipse.collections.api.factory.Maps;
import org.eclipse.collections.api.map.ImmutableMap;
import org.eclipse.collections.api.map.MutableMap;
import org.eclipse.collections.api.multimap.bag.ImmutableBagMultimap;
import org.eclipse.collections.api.ordered.OrderedIterable;
import org.eclipse.collections.api.partition.bag.PartitionImmutableBag;
import org.eclipse.collections.api.set.ImmutableSet;
import org.eclipse.collections.api.tuple.Pair;
/**
* @since 8.0.
*/
public interface ImmutablePrimitiveObjectMap extends PrimitiveObjectMap
{
@Override
default ImmutableMap aggregateInPlaceBy(
Function super V, ? extends K> groupBy,
Function0 extends VV> zeroValueFactory,
Procedure2 super VV, ? super V> mutatingAggregator)
{
MutableMap map = Maps.mutable.empty();
this.forEach(each ->
{
K key = groupBy.valueOf(each);
VV value = map.getIfAbsentPut(key, zeroValueFactory);
mutatingAggregator.value(value, each);
});
return map.toImmutable();
}
@Override
default ImmutableMap aggregateBy(
Function super V, ? extends K> groupBy,
Function0 extends VV> zeroValueFactory,
Function2 super VV, ? super V, ? extends VV> nonMutatingAggregator)
{
MutableMap map = this.aggregateBy(
groupBy,
zeroValueFactory,
nonMutatingAggregator,
Maps.mutable.empty());
return map.toImmutable();
}
@Override
ImmutableBagMultimap groupByEach(Function super V, ? extends Iterable> function);
@Override
ImmutableBagMultimap groupBy(Function super V, ? extends VV> function);
@Override
default ImmutableMap groupByUniqueKey(Function super V, ? extends VV> function)
{
MutableMap target = Maps.mutable.withInitialCapacity(this.size());
return this.groupByUniqueKey(function, target).toImmutable();
}
@Override
ImmutableBag collectIf(Predicate super V> predicate, Function super V, ? extends VV> function);
@Override
ImmutableBag collect(Function super V, ? extends VV> function);
@Override
ImmutableBag flatCollect(Function super V, ? extends Iterable> function);
/**
* @since 9.2
*/
@Override
default ImmutableBag flatCollectWith(Function2 super V, ? super P, ? extends Iterable> function, P parameter)
{
return this.flatCollect(each -> function.apply(each, parameter));
}
@Override
ImmutableBooleanBag collectBoolean(BooleanFunction super V> booleanFunction);
@Override
ImmutableByteBag collectByte(ByteFunction super V> byteFunction);
@Override
ImmutableCharBag collectChar(CharFunction super V> charFunction);
@Override
ImmutableDoubleBag collectDouble(DoubleFunction super V> doubleFunction);
@Override
ImmutableFloatBag collectFloat(FloatFunction super V> floatFunction);
@Override
ImmutableIntBag collectInt(IntFunction super V> intFunction);
@Override
ImmutableLongBag collectLong(LongFunction super V> longFunction);
@Override
ImmutableShortBag collectShort(ShortFunction super V> shortFunction);
@Override
ImmutableBag collectWith(Function2 super V, ? super P, ? extends VV> function, P parameter);
@Override
ImmutableBag selectInstancesOf(Class clazz);
@Override
ImmutableBag select(Predicate super V> predicate);
@Override
ImmutableBag selectWith(Predicate2 super V, ? super P> predicate, P parameter);
@Override
ImmutableBag reject(Predicate super V> predicate);
@Override
ImmutableBag rejectWith(Predicate2 super V, ? super P> predicate, P parameter);
@Override
PartitionImmutableBag partition(Predicate super V> predicate);
@Override
PartitionImmutableBag partitionWith(Predicate2 super V, ? super P> predicate, P parameter);
/**
* @deprecated in 7.0. Use {@link OrderedIterable#zip(Iterable)} instead.
*/
@Override
@Deprecated
ImmutableBag> zip(Iterable that);
/**
* @deprecated in 7.0. Use {@link OrderedIterable#zipWithIndex()} instead.
*/
@Override
@Deprecated
ImmutableSet> zipWithIndex();
@Override
ImmutableObjectLongMap sumByInt(Function super V, ? extends VV> groupBy, IntFunction super V> function);
@Override
ImmutableObjectDoubleMap sumByFloat(Function super V, ? extends VV> groupBy, FloatFunction super V> function);
@Override
ImmutableObjectLongMap sumByLong(Function super V, ? extends VV> groupBy, LongFunction super V> function);
@Override
ImmutableObjectDoubleMap sumByDouble(Function super V, ? extends VV> groupBy, DoubleFunction super V> function);
}