org.eclipse.collections.api.map.MutableOrderedMap 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;

import java.util.Map;

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.list.MutableList;
import org.eclipse.collections.api.list.primitive.MutableBooleanList;
import org.eclipse.collections.api.list.primitive.MutableByteList;
import org.eclipse.collections.api.list.primitive.MutableCharList;
import org.eclipse.collections.api.list.primitive.MutableDoubleList;
import org.eclipse.collections.api.list.primitive.MutableFloatList;
import org.eclipse.collections.api.list.primitive.MutableIntList;
import org.eclipse.collections.api.list.primitive.MutableLongList;
import org.eclipse.collections.api.list.primitive.MutableShortList;
import org.eclipse.collections.api.multimap.list.MutableListMultimap;
import org.eclipse.collections.api.partition.list.PartitionMutableList;
import org.eclipse.collections.api.tuple.Pair;

public interface MutableOrderedMap extends OrderedMap, MutableMapIterable
{
    @Override
    MutableOrderedMap tap(Procedure procedure);

    @Override
    MutableOrderedMap flipUniqueValues();

    @Override
    MutableListMultimap flip();

    @Override
    MutableOrderedMap select(Predicate2 predicate);

    @Override
    MutableOrderedMap reject(Predicate2 predicate);

    @Override
     MutableOrderedMap collect(Function2> function);

    @Override
     MutableOrderedMap collectValues(Function2 function);

    @Override
    MutableOrderedMap toReversed();

    @Override
    MutableOrderedMap take(int count);

    @Override
    MutableOrderedMap takeWhile(Predicate predicate);

    @Override
    MutableOrderedMap drop(int count);

    @Override
    MutableOrderedMap dropWhile(Predicate predicate);

    @Override
    PartitionMutableList partitionWhile(Predicate predicate);

    @Override
    MutableList distinct();

    @Override
    MutableList select(Predicate predicate);

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

    @Override
    MutableList reject(Predicate predicate);

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

    @Override
    PartitionMutableList partition(Predicate predicate);

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

    @Override
    MutableBooleanList collectBoolean(BooleanFunction booleanFunction);

    @Override
    MutableByteList collectByte(ByteFunction byteFunction);

    @Override
    MutableCharList collectChar(CharFunction charFunction);

    @Override
    MutableDoubleList collectDouble(DoubleFunction doubleFunction);

    @Override
    MutableFloatList collectFloat(FloatFunction floatFunction);

    @Override
    MutableIntList collectInt(IntFunction intFunction);

    @Override
    MutableLongList collectLong(LongFunction longFunction);

    @Override
    MutableShortList collectShort(ShortFunction shortFunction);

    @Override
     MutableList> zip(Iterable that);

    @Override
    MutableList> zipWithIndex();

    @Override
     MutableList collect(Function function);

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

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

    @Override
     MutableList selectInstancesOf(Class clazz);

    @Override
     MutableList flatCollect(Function> function);

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

    @Override
     MutableListMultimap groupBy(Function function);

    @Override
     MutableListMultimap groupByEach(Function> function);

    @Override
     MutableOrderedMap groupByUniqueKey(Function function);

    @Override
    MutableOrderedMap withKeyValue(K key, V value);

    @Override
    default MutableOrderedMap withMap(Map map)
    {
        this.putAll(map);
        return this;
    }

    @Override
    MutableOrderedMap withAllKeyValues(Iterable> keyValues);

    @Override
    MutableOrderedMap withAllKeyValueArguments(Pair... keyValuePairs);

    @Override
    MutableOrderedMap withoutKey(K key);

    @Override
    MutableOrderedMap withoutAllKeys(Iterable keys);

    @Override
    MutableOrderedMap asUnmodifiable();
}