com.carrotsearch.hppcrt.CharObjectMap Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of hppcrt Show documentation

High Performance Primitive Collections Realtime (fork of HPPC from Carrotsearch) Fundamental data structures (maps, sets, lists, queues, heaps, sorts) generated for combinations of object and primitive types to conserve JVM memory and speed up execution. The Realtime fork intends to extend the existing collections, by tweaking to remove any dynamic allocations at runtime, and to obtain low variance execution times whatever the input nature.

There is a newer version: 0.7.5

Show newest version

package com.carrotsearch.hppcrt;

import com.carrotsearch.hppcrt.cursors.CharObjectCursor;

/**
 * An associative container with unique binding from keys to a single value.
 */
  
 @javax.annotation.Generated(date = "2014-10-25T20:54:14+0200", value = "HPPC-RT generated from: CharObjectMap.java") 
public interface CharObjectMap
extends CharObjectAssociativeContainer
{
    /**
     * 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.
     */
    VType put(char key, VType 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 char key, final VType value);

      
      

      
     

    /**
     * @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.
     *
     */
    VType get(char 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(CharObjectAssociativeContainer 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.
     */
    VType remove(char key);
}