/*
 * Copyright 2014 The Netty Project
 *
 * The Netty Project licenses this file to you 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 io.netty.util.collection;

import java.util.Map;

Interface for a primitive map that uses shorts as keys. 
Type parameters:
<V> – the value type stored in the map./**
 * Interface for a primitive map that uses {@code short}s as keys.
 *
 * @param <V> the value type stored in the map.
 */
public interface ShortObjectMap<V> extends Map<Short, V> {

    
A primitive entry in the map, provided by the iterator from ShortObjectMap.entries() 
Type parameters:
<V> – the value type stored in the map./**
     * A primitive entry in the map, provided by the iterator from {@link #entries()}
     *
     * @param <V> the value type stored in the map.
     */
    interface PrimitiveEntry<V> {
        
Gets the key for this entry.
/**
         * Gets the key for this entry.
         */
        short key();

        
Gets the value for this entry.
/**
         * Gets the value for this entry.
         */
        V value();

        
Sets the value for this entry.
/**
         * Sets the value for this entry.
         */
        void setValue(V value);
    }

    
Gets the value in the map with the specified key.
Params:
key – the key whose associated value is to be returned.
Returns:
the value or null if the key was not found in the map./**
     * Gets the value in the map with the specified key.
     *
     * @param key the key whose associated value is to be returned.
     * @return the value or {@code null} if the key was not found in the map.
     */
    V get(short key);

    
Puts the given entry into the map.
Params:
key – the key of the entry.
value – the value of the entry.
Returns:
the previous value for this key or null if there was no previous mapping./**
     * Puts the given entry into the map.
     *
     * @param key the key of the entry.
     * @param value the value of the entry.
     * @return the previous value for this key or {@code null} if there was no previous mapping.
     */
    V put(short key, V value);

    
Removes the entry with the specified key.
Params:
key – the key for the entry to be removed from this map.
Returns:
the previous value for the key, or null if there was no mapping./**
     * Removes the entry with the specified key.
     *
     * @param key the key for the entry to be removed from this map.
     * @return the previous value for the key, or {@code null} if there was no mapping.
     */
    V remove(short key);

    
Gets an iterable to traverse over the primitive entries contained in this map. As an optimization, the PrimitiveEntrys returned by the Iterator may change as the Iterator progresses. The caller should not rely on PrimitiveEntry key/value stability. /**
     * Gets an iterable to traverse over the primitive entries contained in this map. As an optimization,
     * the {@link PrimitiveEntry}s returned by the {@link Iterator} may change as the {@link Iterator}
     * progresses. The caller should not rely on {@link PrimitiveEntry} key/value stability.
     */
    Iterable<PrimitiveEntry<V>> entries();

    
Indicates whether or not this map contains a value for the specified key.
/**
     * Indicates whether or not this map contains a value for the specified key.
     */
    boolean containsKey(short key);
}