Package gnu.trove.map

Interface TIntShortMap

All Known Implementing Classes:
TIntShortHashMap, TSynchronizedIntShortMap, TUnmodifiableIntShortMap
public interface TIntShortMap
Interface for a primitive map of int keys and short values.

  • Method Summary

    Modifier and Type
    Method
    Description
    short
    adjustOrPutValue(int key, short adjust_amount, short put_amount)
    Adjusts the primitive value mapped to the key if the key is present in the map.
    boolean
    adjustValue(int key, short amount)
    Adjusts the primitive value mapped to key.
    void
    clear()
    Empties the map.
    boolean
    containsKey(int key)
    Checks for the present of key in the keys of the map.
    boolean
    containsValue(short val)
    Checks for the presence of val in the values of the map.
    boolean
    forEachEntry(TIntShortProcedure procedure)
    Executes procedure for each key/value entry in the map.
    boolean
    forEachKey(TIntProcedure procedure)
    Executes procedure for each key in the map.
    boolean
    forEachValue(TShortProcedure procedure)
    Executes procedure for each value in the map.
    short
    get(int key)
    Retrieves the value for key.
    int
    getNoEntryKey()
    Returns the value that will be returned from get(int) or put(int, short) if no entry exists for a given key.
    short
    getNoEntryValue()
    Returns the value that will be returned from get(int) or put(int, short) if no entry exists for a given key.
    boolean
    increment(int key)
    Increments the primitive value mapped to key by 1
    boolean
    isEmpty()
    Returns true if this map contains no key-value mappings.
    TIntShortIterator
    iterator()
     
    int[]
    keys()
    Returns the keys of the map as an array of int values.
    int[]
    keys(int[] array)
    Returns the keys of the map.
    TIntSet
    keySet()
    Returns the keys of the map as a TIntSet
    short
    put(int key, short value)
    Inserts a key/value pair into the map.
    void
    putAll(TIntShortMap map)
    Put all the entries from the given map into this map.
    void
    putAll(Map<? extends Integer,? extends Short> map)
    Put all the entries from the given Map into this map.
    short
    putIfAbsent(int key, short value)
    Inserts a key/value pair into the map if the specified key is not already associated with a value.
    short
    remove(int key)
    Deletes a key/value pair from the map.
    boolean
    retainEntries(TIntShortProcedure procedure)
    Retains only those entries in the map for which the procedure returns a true value.
    int
    size()
    Returns an int value that is the number of elements in the map.
    void
    transformValues(TShortFunction function)
    Transform the values in this map using function.
    TShortCollection
    valueCollection()
    Returns the values of the map as a TShortCollection
    short[]
    values()
    Returns the values of the map as an array of #e# values.
    short[]
    values(short[] array)
    Returns the values of the map using an existing array.

  • Method Details

    • getNoEntryKey

      int getNoEntryKey()
      Returns the value that will be returned from get(int) or put(int, short) if no entry exists for a given key. The default value is generally zero, but can be configured during construction of the collection.
      Returns:
      the value that represents a null key in this collection.

    • getNoEntryValue

      short getNoEntryValue()
      Returns the value that will be returned from get(int) or put(int, short) if no entry exists for a given key. The default value is generally zero, but can be configured during construction of the collection.
      Returns:
      the value that represents a null value in this collection.

    • put

      short put(int key, short value)
      Inserts a key/value pair into the map.
      Returns:
      the previous value associated with key, or the "no entry" value if none was found (see getNoEntryValue()).

    • putIfAbsent

      short putIfAbsent(int key, short value)
      Inserts a key/value pair into the map if the specified key is not already associated with a value.
      Returns:
      the previous value associated with key, or the "no entry" value if none was found (see getNoEntryValue()).

    • putAll

      void putAll(Map<? extends Integer,? extends Short> map)
      Put all the entries from the given Map into this map.
      Parameters:
      map - The Map from which entries will be obtained to put into this map.

    • putAll

      void putAll(TIntShortMap map)
      Put all the entries from the given map into this map.
      Parameters:
      map - The map from which entries will be obtained to put into this map.

    • get

      short get(int key)
      Retrieves the value for key.
      Returns:
      the previous value associated with key, or the "no entry" value if none was found (see getNoEntryValue()).

    • clear

      void clear()
      Empties the map.

    • isEmpty

      boolean isEmpty()
      Returns true if this map contains no key-value mappings.
      Returns:
      true if this map contains no key-value mappings

    • remove

      short remove(int key)
      Deletes a key/value pair from the map.
      Parameters:
      key - an int value
      Returns:
      the previous value associated with key, or the "no entry" value if none was found (see getNoEntryValue()).

    • size

      int size()
      Returns an int value that is the number of elements in the map.
      Returns:
      an int value that is the number of elements in the map.

    • keySet

      TIntSet keySet()
      Returns the keys of the map as a TIntSet
      Returns:
      the keys of the map as a TIntSet

    • keys

      int[] keys()
      Returns the keys of the map as an array of int values.
      Returns:
      the keys of the map as an array of int values.

    • keys

      int[] keys(int[] array)
      Returns the keys of the map.
      Parameters:
      array - the array into which the elements of the list are to be stored, if it is big enough; otherwise, a new array of the same type is allocated for this purpose.
      Returns:
      the keys of the map as an array.

    • valueCollection

      TShortCollection valueCollection()
      Returns the values of the map as a TShortCollection
      Returns:
      the values of the map as a TShortCollection

    • values

      short[] values()
      Returns the values of the map as an array of #e# values.
      Returns:
      the values of the map as an array of #e# values.

    • values

      short[] values(short[] array)
      Returns the values of the map using an existing array.
      Parameters:
      array - the array into which the elements of the list are to be stored, if it is big enough; otherwise, a new array of the same type is allocated for this purpose.
      Returns:
      the values of the map as an array of #e# values.

    • containsValue

      boolean containsValue(short val)
      Checks for the presence of val in the values of the map.

    • containsKey

      boolean containsKey(int key)
      Checks for the present of key in the keys of the map.

    • iterator

      TIntShortIterator iterator()
      Returns:
      a TIntShortIterator with access to this map's keys and values

    • forEachKey

      boolean forEachKey(TIntProcedure procedure)
      Executes procedure for each key in the map.
      Parameters:
      procedure - a TIntProcedure value
      Returns:
      false if the loop over the keys terminated because the procedure returned false for some key.

    • forEachValue

      boolean forEachValue(TShortProcedure procedure)
      Executes procedure for each value in the map.
      Parameters:
      procedure - a T#F#Procedure value
      Returns:
      false if the loop over the values terminated because the procedure returned false for some value.

    • forEachEntry

      boolean forEachEntry(TIntShortProcedure procedure)
      Executes procedure for each key/value entry in the map.
      Parameters:
      procedure - a TOIntShortProcedure value
      Returns:
      false if the loop over the entries terminated because the procedure returned false for some entry.

    • transformValues

      void transformValues(TShortFunction function)
      Transform the values in this map using function.
      Parameters:
      function - a TShortFunction value

    • retainEntries

      boolean retainEntries(TIntShortProcedure procedure)
      Retains only those entries in the map for which the procedure returns a true value.
      Parameters:
      procedure - determines which entries to keep
      Returns:
      true if the map was modified.

    • increment

      boolean increment(int key)
      Increments the primitive value mapped to key by 1
      Parameters:
      key - the key of the value to increment
      Returns:
      true if a mapping was found and modified.

    • adjustValue

      boolean adjustValue(int key, short amount)
      Adjusts the primitive value mapped to key.
      Parameters:
      key - the key of the value to increment
      amount - the amount to adjust the value by.
      Returns:
      true if a mapping was found and modified.

    • adjustOrPutValue

      short adjustOrPutValue(int key, short adjust_amount, short put_amount)
      Adjusts the primitive value mapped to the key if the key is present in the map. Otherwise, the put_amount is put in the map.
      Parameters:
      key - the key of the value to increment
      adjust_amount - the amount to adjust the value by
      put_amount - the value put into the map if the key is not present
      Returns:
      the value present in the map after the adjustment or put operation