/*
 * Copyright (c) 2018 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.primitive;

import java.util.Map;

import org.eclipse.collections.api.LazyByteIterable;
import org.eclipse.collections.api.RichIterable;
import org.eclipse.collections.api.block.predicate.primitive.ByteShortPredicate;
import org.eclipse.collections.api.block.procedure.primitive.ByteShortProcedure;
import org.eclipse.collections.api.block.procedure.primitive.ByteProcedure;
import org.eclipse.collections.api.set.primitive.MutableByteSet;
import org.eclipse.collections.api.tuple.primitive.ByteShortPair;

This file was automatically generated from template file primitivePrimitiveMap.stg.
Since:
3.0./**
 * This file was automatically generated from template file primitivePrimitiveMap.stg.
 *
 * @since 3.0.
 */
public interface ByteShortMap extends ShortValuesMap
{
    short get(byte key);

    short getIfAbsent(byte key, short ifAbsent);

    short getOrThrow(byte key);

    boolean containsKey(byte key);

    void forEachKey(ByteProcedure procedure);

    void forEachKeyValue(ByteShortProcedure procedure);

    LazyByteIterable keysView();

    
Since:
5.0/**
     * @since 5.0
     */
    RichIterable<ByteShortPair> keyValuesView();

    
Return the ShortByteMap that is obtained by flipping the direction of this map and making the associations
from value to key.
Throws:
IllegalStateException – if the ShortByteMap contains duplicate values.
Since:
9.0/**
     * Return the ShortByteMap that is obtained by flipping the direction of this map and making the associations
     * from value to key.
     *
     * @throws IllegalStateException if the ShortByteMap contains duplicate values.
     * @since 9.0
     */
    ShortByteMap flipUniqueValues();

    ByteShortMap select(ByteShortPredicate predicate);

    ByteShortMap reject(ByteShortPredicate predicate);

    
Follows the same general contract as Map.equals(Object). /**
     * Follows the same general contract as {@link Map#equals(Object)}.
     */
    @Override
    boolean equals(Object o);

    
Follows the same general contract as Map.hashCode(). /**
     * Follows the same general contract as {@link Map#hashCode()}.
     */
    @Override
    int hashCode();

    
Follows the same general contract as AbstractMap.toString() 
Returns:
a string representation of this ByteShortMap/**
     * Follows the same general contract as {@link java.util.AbstractMap#toString()}
     *
     * @return a string representation of this ByteShortMap
     */
    @Override
    String toString();

    ImmutableByteShortMap toImmutable();

    MutableByteSet keySet();
}