com.carrotsearch.hppcrt.maps.ShortCharMap Maven / Gradle / Ivy

Go to download
package com.carrotsearch.hppcrt.maps;

import com.carrotsearch.hppcrt.ShortCharAssociativeContainer;
import com.carrotsearch.hppcrt.cursors.ShortCharCursor;

/**
 * An associative container with unique binding from keys to a single value.
 */
  
 @javax.annotation.Generated(date = "2014-08-19T19:56:32+0200", value = "HPPC-RT generated from: ShortCharMap.java") 
public interface ShortCharMap
extends ShortCharAssociativeContainer
{
    /**
     * Place a given key and value in the container.
     * @return Returns the value previously stored under the given key in the map if an equal key is part of the map, and replaces the existing
     *  value only  with the argument value. If no previous key existed,
     * the default value is returned and the (key, value) pair is inserted.
     */
    char put(short key, char value);

    /**
     * Trove-inspired API method. An equivalent
     * of the following code:
     *      * if (!map.containsKey(key))
     *      map.put(key, value);
     * 
     * 
     * @param key The key of the value to check.
     * @param value The value to put if key does not exist.
     * @return true if key did not exist and value
     * was placed in the map.
     */
    boolean putIfAbsent(final short key, final char value);

      
    /**
     * An equivalent of calling
     *      *  putOrAdd(key, additionValue, additionValue);
     * 
     * 
     * @param key The key of the value to adjust.
     * @param additionValue The value to put or add to the existing value if key exists.
     * @return Returns the current value associated with key (after changes).
     */
      
          char addTo(short key, char additionValue);
     

     
    /**
     * Trove-inspired API method. A logical
     * equivalent of the following code (but does not update {@link #lastSlot):
     *      *  if (containsKey(key))
     *  {
     *      char v = (char) (lget() + additionValue);
     *      lset(v);
     *      return v;
     *  }
     *  else
     *  {
     *     put(key, putValue);
     *     return putValue;
     *  }
     * 
     * 
     * @param key The key of the value to adjust.
     * @param putValue The value to put if key does not exist.
     * @param additionValue The value to add to the existing value if key exists.
     * @return Returns the current value associated with key (after changes).
     */
      
         char putOrAdd(short key, char putValue, char additionValue);
     

    /**
     * @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.
     *
     */
    char get(short key);

    /**
     * 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.
     */
    int putAll(ShortCharAssociativeContainer 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.
     */
    int putAll(Iterable iterable);

    /**
     * Remove all values at the given key. The default value for the key type is returned
     * if the value does not exist in the map.
     */
    char remove(short key);
}