Package gnu.trove.map

Interface TShortByteMap

All Known Implementing Classes:
TShortByteHashMap, TSynchronizedShortByteMap, TUnmodifiableShortByteMap

public interface TShortByteMap
Interface for a primitive map of short keys and byte values.
  • Method Summary

    Modifier and Type
    Method
    Description
    byte
    adjustOrPutValue(short key, byte adjust_amount, byte put_amount)
    Adjusts the primitive value mapped to the key if the key is present in the map.
    boolean
    adjustValue(short key, byte amount)
    Adjusts the primitive value mapped to key.
    void
    Empties the map.
    boolean
    containsKey(short key)
    Checks for the present of key in the keys of the map.
    boolean
    containsValue(byte val)
    Checks for the presence of val in the values of the map.
    boolean
    Executes procedure for each key/value entry in the map.
    boolean
    Executes procedure for each key in the map.
    boolean
    Executes procedure for each value in the map.
    byte
    get(short key)
    Retrieves the value for key.
    short
    Returns the value that will be returned from get(short) or put(short, byte) if no entry exists for a given key.
    byte
    Returns the value that will be returned from get(short) or put(short, byte) if no entry exists for a given key.
    boolean
    increment(short key)
    Increments the primitive value mapped to key by 1
    boolean
    Returns true if this map contains no key-value mappings.
     
    short[]
    Returns the keys of the map as an array of short values.
    short[]
    keys(short[] array)
    Returns the keys of the map.
    Returns the keys of the map as a TShortSet
    byte
    put(short key, byte value)
    Inserts a key/value pair into the map.
    void
    Put all the entries from the given map into this map.
    void
    putAll(Map<? extends Short,? extends Byte> map)
    Put all the entries from the given Map into this map.
    byte
    putIfAbsent(short key, byte value)
    Inserts a key/value pair into the map if the specified key is not already associated with a value.
    byte
    remove(short key)
    Deletes a key/value pair from the map.
    boolean
    Retains only those entries in the map for which the procedure returns a true value.
    int
    Returns an int value that is the number of elements in the map.
    void
    Transform the values in this map using function.
    Returns the values of the map as a TByteCollection
    byte[]
    Returns the values of the map as an array of #e# values.
    byte[]
    values(byte[] array)
    Returns the values of the map using an existing array.
  • Method Details

    • getNoEntryKey

      short getNoEntryKey()
      Returns the value that will be returned from get(short) or put(short, byte) 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

      byte getNoEntryValue()
      Returns the value that will be returned from get(short) or put(short, byte) 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

      byte put(short key, byte 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

      byte putIfAbsent(short key, byte 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 Short,? extends Byte> 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(TShortByteMap 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

      byte get(short 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

      byte remove(short key)
      Deletes a key/value pair from the map.
      Parameters:
      key - an short 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

      TShortSet keySet()
      Returns the keys of the map as a TShortSet
      Returns:
      the keys of the map as a TShortSet
    • keys

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

      short[] keys(short[] 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

      TByteCollection valueCollection()
      Returns the values of the map as a TByteCollection
      Returns:
      the values of the map as a TByteCollection
    • values

      byte[] 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

      byte[] values(byte[] 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(byte val)
      Checks for the presence of val in the values of the map.
    • containsKey

      boolean containsKey(short key)
      Checks for the present of key in the keys of the map.
    • iterator

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

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

      boolean forEachValue(TByteProcedure 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(TShortByteProcedure procedure)
      Executes procedure for each key/value entry in the map.
      Parameters:
      procedure - a TOShortByteProcedure value
      Returns:
      false if the loop over the entries terminated because the procedure returned false for some entry.
    • transformValues

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

      boolean retainEntries(TShortByteProcedure 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(short 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(short key, byte 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

      byte adjustOrPutValue(short key, byte adjust_amount, byte 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