/*
 * This file is part of ViaVersion - https://github.com/ViaVersion/ViaVersion
 * Copyright (C) 2016-2022 ViaVersion and contributors
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */
package com.viaversion.viaversion.util;

import it.unimi.dsi.fastutil.ints.Int2IntMap;
import org.checkerframework.checker.nullness.qual.NonNull;

import java.util.Map;

/**
 * Simple wrapper class for two {@link Int2IntMap}s.
 *
 * @see #inverse() to get the inversed map
 */
public interface Int2IntBiMap extends Int2IntMap {

    /**
     * Returns the inverse of this bimap.
     *
     * @return the inverse of this bimap
     */
    Int2IntBiMap inverse();

    /**
     * Puts the key and value into the maps.
     *
     * @param key   key
     * @param value value
     * @return old value if present
     * @throws IllegalArgumentException if the value already exists in the map
     */
    @Override
    int put(int key, int value);

    @Override
    @Deprecated
    default void putAll(@NonNull Map<? extends Integer, ? extends Integer> m) {
        throw new UnsupportedOperationException();
    }
}
