com.gs.collections.api.bimap.ImmutableBiMap Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of gs-collections-api Show documentation

GS Collections is a collections framework for Java. It has JDK-compatible List, Set and Map implementations with a rich API and set of utility classes that work with any JDK compatible Collections, Arrays, Maps or Strings. The iteration protocol was inspired by the Smalltalk collection framework.

There is a newer version: 7.0.3

Show newest version

/*
 * Copyright 2013 Goldman Sachs.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.gs.collections.api.bimap;

import com.gs.collections.api.block.function.Function2;
import com.gs.collections.api.block.predicate.Predicate2;
import com.gs.collections.api.map.ImmutableMap;
import com.gs.collections.api.tuple.Pair;
import net.jcip.annotations.Immutable;

/**
 * A {@link com.gs.collections.api.bimap.BiMap} whose contents cannot be altered after initialization.
 *
 * @since 4.2
 */
@Immutable
public interface ImmutableBiMap extends BiMap, ImmutableMap
{
    ImmutableBiMap inverse();

    ImmutableBiMap select(Predicate2 predicate);

     ImmutableBiMap collectValues(Function2 function);

     ImmutableBiMap collect(Function2> function);

    ImmutableBiMap reject(Predicate2 predicate);
}