org.eclipse.collections.api.map.ImmutableMapIterable 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) 2016 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;

import java.util.Map;

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.predicate.Predicate;
import org.eclipse.collections.api.block.predicate.Predicate2;
import org.eclipse.collections.api.block.procedure.Procedure;
import org.eclipse.collections.api.block.procedure.Procedure2;
import org.eclipse.collections.api.collection.ImmutableCollection;
import org.eclipse.collections.api.multimap.ImmutableMultimap;
import org.eclipse.collections.api.partition.PartitionImmutableCollection;
import org.eclipse.collections.api.tuple.Pair;

public interface ImmutableMapIterable extends MapIterable
{
    Map castToMap();

    ImmutableMapIterable newWithKeyValue(K key, V value);

    ImmutableMapIterable newWithAllKeyValues(Iterable> keyValues);

    ImmutableMapIterable newWithAllKeyValueArguments(Pair... keyValuePairs);

    ImmutableMapIterable newWithoutKey(K key);

    ImmutableMapIterable newWithoutAllKeys(Iterable keys);

    // TODO
    // ImmutableSetIterable keySet();

    @Override
    ImmutableMapIterable tap(Procedure procedure);

    @Override
    ImmutableMapIterable flipUniqueValues();

    @Override
    ImmutableMultimap flip();

    @Override
    ImmutableMapIterable select(Predicate2 predicate);

    @Override
    ImmutableMapIterable reject(Predicate2 predicate);

    @Override
     ImmutableMapIterable collect(Function2> function);

    @Override
     ImmutableMapIterable collectValues(Function2 function);

    @Override
    ImmutableCollection select(Predicate predicate);

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

    @Override
    ImmutableCollection reject(Predicate predicate);

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

    @Override
    PartitionImmutableCollection partition(Predicate predicate);

    @Override
     ImmutableCollection selectInstancesOf(Class clazz);

    @Override
     ImmutableMultimap groupBy(Function function);

    @Override
     ImmutableMultimap groupByEach(Function> function);

    @Override
     ImmutableMapIterable groupByUniqueKey(Function function);

    @Override
     ImmutableCollection> zip(Iterable that);

    @Override
    ImmutableCollection> zipWithIndex();

    @Override
     ImmutableMapIterable aggregateInPlaceBy(Function groupBy, Function0 zeroValueFactory, Procedure2 mutatingAggregator);

    @Override
     ImmutableMapIterable aggregateBy(Function groupBy, Function0 zeroValueFactory, Function2 nonMutatingAggregator);
}