org.eclipse.collections.api.map.ImmutableOrderedMap Maven / Gradle / Ivy

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;

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.Procedure;
import org.eclipse.collections.api.block.procedure.Procedure2;
import org.eclipse.collections.api.list.ImmutableList;
import org.eclipse.collections.api.list.primitive.ImmutableBooleanList;
import org.eclipse.collections.api.list.primitive.ImmutableByteList;
import org.eclipse.collections.api.list.primitive.ImmutableCharList;
import org.eclipse.collections.api.list.primitive.ImmutableDoubleList;
import org.eclipse.collections.api.list.primitive.ImmutableFloatList;
import org.eclipse.collections.api.list.primitive.ImmutableIntList;
import org.eclipse.collections.api.list.primitive.ImmutableLongList;
import org.eclipse.collections.api.list.primitive.ImmutableShortList;
import org.eclipse.collections.api.multimap.list.ImmutableListMultimap;
import org.eclipse.collections.api.partition.list.PartitionImmutableList;
import org.eclipse.collections.api.tuple.Pair;

public interface ImmutableOrderedMap extends OrderedMap, ImmutableMapIterable
{
    @Override
    ImmutableOrderedMap tap(Procedure procedure);

    @Override
    ImmutableOrderedMap flipUniqueValues();

    @Override
    ImmutableListMultimap flip();

    @Override
    ImmutableOrderedMap select(Predicate2 predicate);

    @Override
    ImmutableOrderedMap reject(Predicate2 predicate);

    @Override
     ImmutableOrderedMap collect(Function2> function);

    @Override
     ImmutableOrderedMap collectValues(Function2 function);

    @Override
    ImmutableOrderedMap toReversed();

    @Override
    ImmutableOrderedMap take(int count);

    @Override
    ImmutableOrderedMap takeWhile(Predicate predicate);

    @Override
    ImmutableOrderedMap drop(int count);

    @Override
    ImmutableOrderedMap dropWhile(Predicate predicate);

    @Override
    PartitionImmutableList partitionWhile(Predicate predicate);

    @Override
    ImmutableList distinct();

    @Override
    ImmutableList select(Predicate predicate);

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

    @Override
    ImmutableList reject(Predicate predicate);

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

    @Override
    PartitionImmutableList partition(Predicate predicate);

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

    @Override
    ImmutableBooleanList collectBoolean(BooleanFunction booleanFunction);

    @Override
    ImmutableByteList collectByte(ByteFunction byteFunction);

    @Override
    ImmutableCharList collectChar(CharFunction charFunction);

    @Override
    ImmutableDoubleList collectDouble(DoubleFunction doubleFunction);

    @Override
    ImmutableFloatList collectFloat(FloatFunction floatFunction);

    @Override
    ImmutableIntList collectInt(IntFunction intFunction);

    @Override
    ImmutableLongList collectLong(LongFunction longFunction);

    @Override
    ImmutableShortList collectShort(ShortFunction shortFunction);

    @Override
     ImmutableList> zip(Iterable that);

    @Override
    ImmutableList> zipWithIndex();

    @Override
     ImmutableList collect(Function function);

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

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

    @Override
     ImmutableList selectInstancesOf(Class clazz);

    @Override
     ImmutableList flatCollect(Function> function);

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

    @Override
     ImmutableListMultimap groupBy(Function function);

    @Override
     ImmutableListMultimap groupByEach(Function> function);

    @Override
     ImmutableOrderedMap groupByUniqueKey(Function function);

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

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

    @Override
    default  ImmutableOrderedMap aggregateBy(
            Function keyFunction,
            Function valueFunction,
            Function0 zeroValueFactory,
            Function2 nonMutatingAggregator)
    {
        throw new UnsupportedOperationException("Not implemented");
    }
}