// Path: hppc/src/main/templates/com/carrotsearch/hppc/cursors/KTypeVTypeCursor.java
// public final class KTypeVTypeCursor<KType, VType> {
//   /**
//    * The current key and value's index in the container this cursor belongs to.
//    * The meaning of this index is defined by the container (usually it will be
//    * an index in the underlying storage buffer).
//    */
//   public int index;
// 
//   /**
//    * The current key.
//    */
//   public KType key;
// 
//   /**
//    * The current value.
//    */
//   public VType value;
// 
//   @Override
//   public String toString() {
//     return "[cursor, index: " + index + ", key: " + key + ", value: " + value + "]";
//   }
// }


import com.carrotsearch.hppc.cursors.KTypeVTypeCursor;
/*! #set($TemplateOptions.ignored = ($TemplateOptions.isKTypeAnyOf("DOUBLE", "FLOAT", "BYTE"))) !*/
package com.carrotsearch.hppc;


/**
 * An associative container with unique binding from keys to a single value.
 */
/*! ${TemplateOptions.generatedAnnotation} !*/
public interface KTypeVTypeMap<KType, VType> extends KTypeVTypeAssociativeContainer<KType, VType> {
  /**
   * @return Returns the value associated with the given key or the default
   *         value for the value type, if the key is not associated with any
   *         value.  For numeric value types, this default value is 0, for
   *         object types it is {@code null}.
   */
  public VType get(KType key);

  /**
   * @return Returns the value associated with the given key or the provided
   *         default value if the key is not associated with any value.
   */
  public VType getOrDefault(KType key, VType defaultValue);

  /**
   * Place a given key and value in the container.
   * 
   * @return The value previously stored under the given key in the map is
   *         returned.
   */
  public VType put(KType key, VType value);

  /**
   * Puts all keys from another container to this map, replacing the values of
   * existing keys, if such keys are present.
   * 
   * @return Returns the number of keys added to the map as a result of this
   *         call (not previously present in the map). Values of existing keys
   *         are overwritten.
   */
  public int putAll(KTypeVTypeAssociativeContainer<? extends KType, ? extends VType> container);

  /**
   * Puts all keys from an iterable cursor to this map, replacing the values of
   * existing keys, if such keys are present.
   * 
   * @return Returns the number of keys added to the map as a result of this
   *         call (not previously present in the map). Values of existing keys
   *         are overwritten.
   */
// Path: hppc/src/main/templates/com/carrotsearch/hppc/cursors/KTypeVTypeCursor.java
// public final class KTypeVTypeCursor<KType, VType> {
//   /**
//    * The current key and value's index in the container this cursor belongs to.
//    * The meaning of this index is defined by the container (usually it will be
//    * an index in the underlying storage buffer).
//    */
//   public int index;
// 
//   /**
//    * The current key.
//    */
//   public KType key;
// 
//   /**
//    * The current value.
//    */
//   public VType value;
// 
//   @Override
//   public String toString() {
//     return "[cursor, index: " + index + ", key: " + key + ", value: " + value + "]";
//   }
// }


// Path: hppc/src/main/templates/com/carrotsearch/hppc/KTypeVTypeMap.java
import com.carrotsearch.hppc.cursors.KTypeVTypeCursor;

/*! #set($TemplateOptions.ignored = ($TemplateOptions.isKTypeAnyOf("DOUBLE", "FLOAT", "BYTE"))) !*/
package com.carrotsearch.hppc;


/**
 * An associative container with unique binding from keys to a single value.
 */
/*! ${TemplateOptions.generatedAnnotation} !*/
public interface KTypeVTypeMap<KType, VType> extends KTypeVTypeAssociativeContainer<KType, VType> {
  /**
   * @return Returns the value associated with the given key or the default
   *         value for the value type, if the key is not associated with any
   *         value.  For numeric value types, this default value is 0, for
   *         object types it is {@code null}.
   */
  public VType get(KType key);

  /**
   * @return Returns the value associated with the given key or the provided
   *         default value if the key is not associated with any value.
   */
  public VType getOrDefault(KType key, VType defaultValue);

  /**
   * Place a given key and value in the container.
   * 
   * @return The value previously stored under the given key in the map is
   *         returned.
   */
  public VType put(KType key, VType value);

  /**
   * Puts all keys from another container to this map, replacing the values of
   * existing keys, if such keys are present.
   * 
   * @return Returns the number of keys added to the map as a result of this
   *         call (not previously present in the map). Values of existing keys
   *         are overwritten.
   */
  public int putAll(KTypeVTypeAssociativeContainer<? extends KType, ? extends VType> container);

  /**
   * Puts all keys from an iterable cursor to this map, replacing the values of
   * existing keys, if such keys are present.
   * 
   * @return Returns the number of keys added to the map as a result of this
   *         call (not previously present in the map). Values of existing keys
   *         are overwritten.
   */
  public int putAll(Iterable<? extends KTypeVTypeCursor<? extends KType, ? extends VType>> iterable);