org.eclipse.collections.api.map.primitive.PrimitiveObjectMap 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) 2018 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.map.primitive;

import java.util.Collection;
import java.util.Map;
import java.util.Spliterator;
import java.util.Spliterators;
import java.util.stream.Stream;
import java.util.stream.StreamSupport;

import org.eclipse.collections.api.RichIterable;
import org.eclipse.collections.api.bag.Bag;
import org.eclipse.collections.api.bag.primitive.BooleanBag;
import org.eclipse.collections.api.bag.primitive.ByteBag;
import org.eclipse.collections.api.bag.primitive.CharBag;
import org.eclipse.collections.api.bag.primitive.DoubleBag;
import org.eclipse.collections.api.bag.primitive.FloatBag;
import org.eclipse.collections.api.bag.primitive.IntBag;
import org.eclipse.collections.api.bag.primitive.LongBag;
import org.eclipse.collections.api.bag.primitive.ShortBag;
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.map.UnsortedMapIterable;
import org.eclipse.collections.api.multimap.bag.BagMultimap;
import org.eclipse.collections.api.ordered.OrderedIterable;
import org.eclipse.collections.api.partition.bag.PartitionBag;
import org.eclipse.collections.api.set.UnsortedSetIterable;
import org.eclipse.collections.api.tuple.Pair;

/**
 * @since 8.0.
 */
public interface PrimitiveObjectMap extends RichIterable
{
    boolean containsValue(Object value);

    void forEachValue(Procedure procedure);

    /**
     * Follows the same general contract as {@link Map#equals(Object)}.
     */
    @Override
    boolean equals(Object o);

    /**
     * Follows the same general contract as {@link Map#hashCode()}.
     */
    @Override
    int hashCode();

    /**
     * Returns a string with the keys and values of this map separated by commas with spaces and
     * enclosed in curly braces. Each key and value is separated by an equals sign.
     * 
     * 
     * Assert.assertEquals(
     *     "{1=1, 2=2, 3=3}",
     *     IntObjectMaps.mutable.empty().withKeyValue(1, 1).withKeyValue(2, 2).withKeyValue(3, 3).toString());
     * 
     *
     * @return a string representation of this PrimitiveObjectMap
     * @see java.util.AbstractMap#toString()
     */
    @Override
    String toString();

    Collection values();

    @Override
    Bag select(Predicate predicate);

    @Override
     Bag selectWith(Predicate2 predicate, P parameter);

    @Override
    Bag reject(Predicate predicate);

    @Override
    
 Bag rejectWith(Predicate2 predicate, P parameter);

    @Override
    PartitionBag partition(Predicate predicate);

    @Override
     PartitionBag partitionWith(Predicate2 predicate, P parameter);

    @Override
     Bag selectInstancesOf(Class clazz);

    @Override
     Bag collect(Function function);

    @Override
    BooleanBag collectBoolean(BooleanFunction booleanFunction);

    @Override
    ByteBag collectByte(ByteFunction byteFunction);

    @Override
    CharBag collectChar(CharFunction charFunction);

    @Override
    DoubleBag collectDouble(DoubleFunction doubleFunction);

    @Override
    FloatBag collectFloat(FloatFunction floatFunction);

    @Override
    IntBag collectInt(IntFunction intFunction);

    @Override
    LongBag collectLong(LongFunction longFunction);

    @Override
    ShortBag collectShort(ShortFunction shortFunction);

    @Override
     Bag collectWith(Function2 function, P parameter);

    @Override
     Bag collectIf(Predicate predicate, Function function);

    @Override
     Bag flatCollect(Function> function);

    /**
     * @since 9.2
     */
    @Override
    default  Bag flatCollectWith(Function2> function, P parameter)
    {
        return this.flatCollect(each -> function.apply(each, parameter));
    }

    @Override
     BagMultimap groupBy(Function function);

    @Override
     BagMultimap groupByEach(Function> function);

    @Override
     UnsortedMapIterable groupByUniqueKey(Function function);

    /**
     * @deprecated in 6.0. Use {@link OrderedIterable#zip(Iterable)} instead.
     */
    @Override
    @Deprecated
     Bag> zip(Iterable that);

    /**
     * @deprecated in 6.0. Use {@link OrderedIterable#zipWithIndex()} instead.
     */
    @Override
    @Deprecated
    UnsortedSetIterable> zipWithIndex();

    /**
     * @since 9.0
     */
    default Stream stream()
    {
        return StreamSupport.stream(this.spliterator(), false);
    }

    /**
     * @since 9.0
     */
    default Stream parallelStream()
    {
        return StreamSupport.stream(this.spliterator(), true);
    }

    /**
     * @since 9.0
     */
    @Override
    default Spliterator spliterator()
    {
        return Spliterators.spliterator(this.iterator(), (long) this.size(), 0);
    }
}