Package org.eclipse.collections.impl.map.mutable.primitive

Class SynchronizedByteShortMap

java.lang.Object
org.eclipse.collections.impl.map.mutable.primitive.SynchronizedByteShortMap
All Implemented Interfaces:
Serializable, ByteShortMap, MutableByteShortMap, MutableShortValuesMap, ShortValuesMap, PrimitiveIterable, ShortIterable
public class SynchronizedByteShortMap extends Object implements MutableByteShortMap, Serializable
A synchronized view of a MutableByteShortMap. It is imperative that the user manually synchronize on the collection when iterating over it using the MutableShortIterator as per Collections.synchronizedCollection(Collection).

This file was automatically generated from template file synchronizedPrimitivePrimitiveMap.stg.

Since:
3.1.
See Also:

  • Constructor Details

  • Method Details

    • clear

      public void clear()
      Description copied from interface: MutableShortValuesMap
      Removes all entries from this map.
      Specified by:
      clear in interface MutableShortValuesMap

    • put

      public void put(byte key, short value)
      Description copied from interface: MutableByteShortMap
      Associates a value with the specified key. If a value is already associated with the key in this map, it will be replaced with value.
      Specified by:
      put in interface MutableByteShortMap
      Parameters:
      key - the key
      value - the value to associate with value

    • putPair

      public void putPair(ByteShortPair keyValuePair)
      Description copied from interface: MutableByteShortMap
      This method allows MutableByteShortMap the ability to add an element in the form of ByteShortPair.
      Specified by:
      putPair in interface MutableByteShortMap
      See Also:

    • putAll

      public void putAll(ByteShortMap map)
      Description copied from interface: MutableByteShortMap
      Puts all of the key/value mappings from the specified map into this map. If this map already has a value associated with one of the keys in the map, it will be replaced with the value in map.
      Specified by:
      putAll in interface MutableByteShortMap
      Parameters:
      map - the map to copy into this map

    • updateValues

      public void updateValues(ByteShortToShortFunction function)
      Description copied from interface: MutableByteShortMap
      Updates the values in-place.
      Specified by:
      updateValues in interface MutableByteShortMap
      Parameters:
      function - that takes a key and its value and that returns a new value for this key

    • removeKey

      public void removeKey(byte key)
      Description copied from interface: MutableByteShortMap
      Removes the mapping associated with the key, if one exists, from the map.
      Specified by:
      removeKey in interface MutableByteShortMap
      Parameters:
      key - the key to remove
      See Also:

    • remove

      public void remove(byte key)
      Description copied from interface: MutableByteShortMap
      Removes the mapping associated with the key, if one exists, from the map.
      Specified by:
      remove in interface MutableByteShortMap
      Parameters:
      key - the key to remove
      See Also:

    • removeKeyIfAbsent

      public short removeKeyIfAbsent(byte key, short value)
      Description copied from interface: MutableByteShortMap
      Removes the mapping associated with the key, if one exists, from the map, returning the previously associated value with the key. If no mapping existed for the key, the specified default value is returned.
      Specified by:
      removeKeyIfAbsent in interface MutableByteShortMap
      Parameters:
      key - the key to remove
      value - the default value to return if no mapping for the key exists
      Returns:
      the value previously associated with the key, if one existed, or value if not

    • getIfAbsentPut

      public short getIfAbsentPut(byte key, short value)
      Description copied from interface: MutableByteShortMap
      Retrieves the value associated with the key if one exists; if it does not, associates a value with the key.
      Specified by:
      getIfAbsentPut in interface MutableByteShortMap
      Parameters:
      key - the key
      value - the value to associate with key if no such mapping exists
      Returns:
      the value associated with key, if one exists, or value if not

    • getIfAbsentPut

      public short getIfAbsentPut(byte key, ShortFunction0 function)
      Description copied from interface: MutableByteShortMap
      Retrieves the value associated with the key if one exists; if it does not, invokes the supplier and associates the result with the key.
      Specified by:
      getIfAbsentPut in interface MutableByteShortMap
      Parameters:
      key - the key
      function - the supplier that provides the value if no mapping exists for key
      Returns:
      the value associated with the key, if one exists, or the result of invoking function if not

    • getIfAbsentPutWithKey

      public short getIfAbsentPutWithKey(byte key, ByteToShortFunction function)
      Description copied from interface: MutableByteShortMap
      Retrieves the value associated with the key if one exists; if it does not, associates the result of invoking the value function with the key.
      Specified by:
      getIfAbsentPutWithKey in interface MutableByteShortMap
      Parameters:
      key - the key
      function - the function that provides the value if no mapping exists. The key will be passed as the argument to the function.
      Returns:
      the value associated with the key, if one exists, or the result of invoking function with key if not

    • getIfAbsentPutWith

      public <P> short getIfAbsentPutWith(byte key, ShortFunction<? super P> function, P parameter)
      Description copied from interface: MutableByteShortMap
      Retrieves the value associated with the key if one exists; if it does not, invokes the value function with the parameter and associates the result with the key.
      Specified by:
      getIfAbsentPutWith in interface MutableByteShortMap
      Type Parameters:
      P - the type of the value function's parameter
      Parameters:
      key - the key
      function - the function that provides the value if no mapping exists. The specified parameter will be passed as the argument to the function.
      parameter - the parameter to provide to function if no value exists for key
      Returns:
      the value associated with the key, if one exists, or the result of invoking function with parameter if not

    • updateValue

      public short updateValue(byte key, short initialValueIfAbsent, ShortToShortFunction function)
      Description copied from interface: MutableByteShortMap
      Updates or sets the value associated with the key by applying the function to the existing value, if one exists, or to the specified initial value if one does not.
      Specified by:
      updateValue in interface MutableByteShortMap
      Parameters:
      key - the key
      initialValueIfAbsent - the initial value to supply to the function if no mapping exists for the key
      function - the function that returns the updated value based on the current value or the initial value, if no value exists
      Returns:
      the new value associated with the key, either as a result of applying function to the value already associated with the key or as a result of applying it to initialValueIfAbsent and associating the result with key

    • get

      public short get(byte key)
      Description copied from interface: ByteShortMap
      Retrieves the value associated with the key. If no mapping exists for the key, the default value (usually 0) is returned.
      Specified by:
      get in interface ByteShortMap
      Parameters:
      key - the key
      Returns:
      the value associated with the key, or the default value if no such mapping exists

    • getIfAbsent

      public short getIfAbsent(byte key, short ifAbsent)
      Description copied from interface: ByteShortMap
      Retrieves the value associated with the key, returning the specified default value if no such mapping exists.
      Specified by:
      getIfAbsent in interface ByteShortMap
      Parameters:
      key - the key
      ifAbsent - the default value to return if no mapping exists for key
      Returns:
      the value associated with the key, or ifAbsent if no such mapping exists.

    • getOrThrow

      public short getOrThrow(byte key)
      Description copied from interface: ByteShortMap
      Retrieves the value associated with the key, throwing an IllegalStateException if no such mapping exists.
      Specified by:
      getOrThrow in interface ByteShortMap
      Parameters:
      key - the key
      Returns:
      the value associated with the key

    • containsKey

      public boolean containsKey(byte key)
      Description copied from interface: ByteShortMap
      Returns whether or not the key is present in the map.
      Specified by:
      containsKey in interface ByteShortMap
      Parameters:
      key - the key
      Returns:
      if a mapping exists in this map for the key

    • containsValue

      public boolean containsValue(short value)
      Description copied from interface: ShortValuesMap
      Returns whether or not this map contains the value.
      Specified by:
      containsValue in interface ShortValuesMap
      Parameters:
      value - the value to test
      Returns:
      if this collection contains the value

    • forEachValue

      public void forEachValue(ShortProcedure procedure)
      Description copied from interface: ShortValuesMap
      Iterates through each value in this map.
      Specified by:
      forEachValue in interface ShortValuesMap
      Parameters:
      procedure - the procedure to invoke for each value in this map.

    • forEachKey

      public void forEachKey(ByteProcedure procedure)
      Description copied from interface: ByteShortMap
      Iterates through each key in the map, invoking the procedure for each.
      Specified by:
      forEachKey in interface ByteShortMap
      Parameters:
      procedure - the procedure to invoke for each key

    • forEachKeyValue

      public void forEachKeyValue(ByteShortProcedure procedure)
      Description copied from interface: ByteShortMap
      Iterates through each key/value pair in the map, invoking the procedure for each.
      Specified by:
      forEachKeyValue in interface ByteShortMap
      Parameters:
      procedure - the procedure to invoke for each key/value pair

    • keysView

      public LazyByteIterable keysView()
      Description copied from interface: ByteShortMap
      Returns a view of the keys in this map. This iterable is backed by the map, so any modifications to the underlying map will be reflected in the keys returned by the iterable.
      Specified by:
      keysView in interface ByteShortMap
      Returns:
      a view of the keys in this map

    • keyValuesView

      public RichIterable<ByteShortPair> keyValuesView()
      Description copied from interface: ByteShortMap
      Returns a view of the key/value pairs in this map. This iterable is backed by the map, so any modifications to the underlying map will be reflected in the pairs returned by the iterable.
      Specified by:
      keyValuesView in interface ByteShortMap
      Returns:
      a view of the keys in this map

    • flipUniqueValues

      public MutableShortByteMap flipUniqueValues()
      Description copied from interface: ByteShortMap
      Return the ShortByteMap that is obtained by flipping the direction of this map and making the associations from value to key.
      Specified by:
      flipUniqueValues in interface ByteShortMap
      Specified by:
      flipUniqueValues in interface MutableByteShortMap

    • select

      public MutableByteShortMap select(ByteShortPredicate predicate)
      Description copied from interface: ByteShortMap
      Return a copy of this map containing only the key/value pairs that match the predicate.
      Specified by:
      select in interface ByteShortMap
      Specified by:
      select in interface MutableByteShortMap
      Parameters:
      predicate - the predicate to determine which key/value pairs in this map should be included in the returned map
      Returns:
      a copy of this map with the matching key/value pairs

    • reject

      public MutableByteShortMap reject(ByteShortPredicate predicate)
      Description copied from interface: ByteShortMap
      Return a copy of this map containing only the key/value pairs that do not match the predicate.
      Specified by:
      reject in interface ByteShortMap
      Specified by:
      reject in interface MutableByteShortMap
      Parameters:
      predicate - the predicate to determine which key/value pairs in this map should be excluded from the returned map
      Returns:
      a copy of this map without the matching key/value pairs

    • shortIterator

      public MutableShortIterator shortIterator()
      This must be manually synchronized by the developer.
      Specified by:
      shortIterator in interface MutableShortValuesMap
      Specified by:
      shortIterator in interface ShortIterable

    • forEach

      public void forEach(ShortProcedure procedure)
      Description copied from interface: ShortIterable
      Applies the ShortProcedure to each element in the ShortIterable.
      Specified by:
      forEach in interface ShortIterable

    • each

      public void each(ShortProcedure procedure)
      Description copied from interface: ShortIterable
      A synonym for forEach.
      Specified by:
      each in interface ShortIterable
      Since:
      7.0.

    • count

      public int count(ShortPredicate predicate)
      Description copied from interface: ShortIterable
      Returns a count of the number of elements in the ShortIterable that return true for the specified predicate.
      Specified by:
      count in interface ShortIterable

    • anySatisfy

      public boolean anySatisfy(ShortPredicate predicate)
      Description copied from interface: ShortIterable
      Returns true if any of the elements in the ShortIterable return true for the specified predicate, otherwise returns false.
      Specified by:
      anySatisfy in interface ShortIterable

    • allSatisfy

      public boolean allSatisfy(ShortPredicate predicate)
      Description copied from interface: ShortIterable
      Returns true if all of the elements in the ShortIterable return true for the specified predicate, otherwise returns false.
      Specified by:
      allSatisfy in interface ShortIterable

    • noneSatisfy

      public boolean noneSatisfy(ShortPredicate predicate)
      Description copied from interface: ShortIterable
      Returns true if none of the elements in the ShortIterable return true for the specified predicate, otherwise returns false.
      Specified by:
      noneSatisfy in interface ShortIterable

    • select

      public MutableShortBag select(ShortPredicate predicate)
      Description copied from interface: ShortIterable
      Returns a new ShortIterable with all of the elements in the ShortIterable that return true for the specified predicate.
      Specified by:
      select in interface MutableShortValuesMap
      Specified by:
      select in interface ShortIterable
      Specified by:
      select in interface ShortValuesMap

    • reject

      public MutableShortBag reject(ShortPredicate predicate)
      Description copied from interface: ShortIterable
      Returns a new ShortIterable with all of the elements in the ShortIterable that return false for the specified predicate.
      Specified by:
      reject in interface MutableShortValuesMap
      Specified by:
      reject in interface ShortIterable
      Specified by:
      reject in interface ShortValuesMap

    • collect

      public <V> MutableBag<V> collect(ShortToObjectFunction<? extends V> function)
      Description copied from interface: ShortIterable
      Returns a new collection with the results of applying the specified function on each element of the source collection. This method is also commonly called transform or map.
      Specified by:
      collect in interface MutableShortValuesMap
      Specified by:
      collect in interface ShortIterable
      Specified by:
      collect in interface ShortValuesMap

    • detectIfNone

      public short detectIfNone(ShortPredicate predicate, short ifNone)
      Specified by:
      detectIfNone in interface ShortIterable

    • sum

      public long sum()
      Specified by:
      sum in interface ShortIterable

    • max

      public short max()
      Specified by:
      max in interface ShortIterable

    • maxIfEmpty

      public short maxIfEmpty(short defaultValue)
      Specified by:
      maxIfEmpty in interface ShortIterable

    • min

      public short min()
      Specified by:
      min in interface ShortIterable

    • minIfEmpty

      public short minIfEmpty(short defaultValue)
      Specified by:
      minIfEmpty in interface ShortIterable

    • average

      public double average()
      Specified by:
      average in interface ShortIterable

    • median

      public double median()
      Specified by:
      median in interface ShortIterable

    • addToValue

      public short addToValue(byte key, short toBeAdded)
      Description copied from interface: MutableByteShortMap
      Increments and updates the value associated with the key, if a value exists, or sets the value to be the specified value if one does not.
      Specified by:
      addToValue in interface MutableByteShortMap
      Parameters:
      key - the key
      toBeAdded - the amount to increment the existing value, if one exists, or to use as the initial value if one does not
      Returns:
      the value after incrementing toBeAdded to the existing value associated with key or toBeAdded if one does not

    • toSortedArray

      public short[] toSortedArray()
      Specified by:
      toSortedArray in interface ShortIterable

    • toSortedList

      public MutableShortList toSortedList()
      Specified by:
      toSortedList in interface ShortIterable

    • toArray

      public short[] toArray()
      Description copied from interface: ShortIterable
      Converts the ShortIterable to a primitive short array.
      Specified by:
      toArray in interface ShortIterable

    • toArray

      public short[] toArray(short[] target)
      Description copied from interface: ShortIterable
      Converts the ShortIterable to a primitive short array. If the collection fits into the provided array it is used to store its elements and is returned from the method, otherwise a new array of the appropriate size is allocated and returned. If the iterable is empty, the target array is returned unchanged.
      Specified by:
      toArray in interface ShortIterable

    • contains

      public boolean contains(short value)
      Description copied from interface: ShortIterable
      Returns true if the value is contained in the ShortIterable, and false if it is not.
      Specified by:
      contains in interface ShortIterable

    • containsAll

      public boolean containsAll(short... source)
      Description copied from interface: ShortIterable
      Returns true if all of the values specified in the source array are contained in the ShortIterable, and false if they are not.
      Specified by:
      containsAll in interface ShortIterable

    • containsAll

      public boolean containsAll(ShortIterable source)
      Description copied from interface: ShortIterable
      Returns true if all of the values specified in the source ShortIterable are contained in the ShortIterable, and false if they are not.
      Specified by:
      containsAll in interface ShortIterable

    • toList

      public MutableShortList toList()
      Description copied from interface: ShortIterable
      Converts the ShortIterable to a new MutableShortList.
      Specified by:
      toList in interface ShortIterable

    • toSet

      public MutableShortSet toSet()
      Description copied from interface: ShortIterable
      Converts the ShortIterable to a new MutableShortSet.
      Specified by:
      toSet in interface ShortIterable

    • toBag

      public MutableShortBag toBag()
      Description copied from interface: ShortIterable
      Converts the ShortIterable to a new MutableShortBag.
      Specified by:
      toBag in interface ShortIterable

    • asLazy

      public LazyShortIterable asLazy()
      Description copied from interface: ShortIterable
      Returns a LazyShortIterable adapter wrapping the source ShortIterable.
      Specified by:
      asLazy in interface ShortIterable

    • withKeyValue

      public MutableByteShortMap withKeyValue(byte key, short value)
      Description copied from interface: MutableByteShortMap
      Associates a value with the specified key. If a value is already associated with the key in this map, it will be replaced with value.
      Specified by:
      withKeyValue in interface MutableByteShortMap
      Parameters:
      key - the key
      value - the value to associate with value
      Returns:
      this map
      See Also:

    • withoutKey

      public MutableByteShortMap withoutKey(byte key)
      Description copied from interface: MutableByteShortMap
      Removes the mapping associated with the key, if one exists, from this map.
      Specified by:
      withoutKey in interface MutableByteShortMap
      Parameters:
      key - the key to remove
      Returns:
      this map
      See Also:

    • withoutAllKeys

      public MutableByteShortMap withoutAllKeys(ByteIterable keys)
      Description copied from interface: MutableByteShortMap
      Removes the mappings associated with all the keys, if they exist, from this map.
      Specified by:
      withoutAllKeys in interface MutableByteShortMap
      Parameters:
      keys - the keys to remove
      Returns:
      this map
      See Also:

    • asUnmodifiable

      public MutableByteShortMap asUnmodifiable()
      Description copied from interface: MutableByteShortMap
      Returns an unmodifiable view of this map, delegating all read-only operations to this map and throwing an UnsupportedOperationException for all mutating operations. This avoids the overhead of copying the map when calling ByteShortMap.toImmutable() while still providing immutability.
      Specified by:
      asUnmodifiable in interface MutableByteShortMap
      Returns:
      an unmodifiable view of this map

    • asSynchronized

      public MutableByteShortMap asSynchronized()
      Description copied from interface: MutableByteShortMap
      Returns a synchronized view of this map, delegating all operations to this map but ensuring only one caller has access to the map at a time.
      Specified by:
      asSynchronized in interface MutableByteShortMap
      Returns:
      a synchronized view of this map

    • toImmutable

      public ImmutableByteShortMap toImmutable()
      Description copied from interface: ByteShortMap
      Returns a copy of this map that is immutable (if this map is mutable) or itself if it is already immutable.
      Specified by:
      toImmutable in interface ByteShortMap
      Returns:
      an immutable map that is equivalent to this one

    • size

      public int size()
      Description copied from interface: PrimitiveIterable
      Returns the number of items in this iterable.
      Specified by:
      size in interface PrimitiveIterable

    • isEmpty

      public boolean isEmpty()
      Description copied from interface: PrimitiveIterable
      Returns true if this iterable has zero items.
      Specified by:
      isEmpty in interface PrimitiveIterable

    • notEmpty

      public boolean notEmpty()
      Description copied from interface: PrimitiveIterable
      The English equivalent of !this.isEmpty()
      Specified by:
      notEmpty in interface PrimitiveIterable

    • keySet

      public MutableByteSet keySet()
      Description copied from interface: ByteShortMap
      Returns a set containing all the keys in this map. The set is backed by the map, so any modifications to the returned set will affect this map.
      Specified by:
      keySet in interface ByteShortMap
      Returns:
      a mutable set containing the keys in this map

    • values

      public MutableShortCollection values()
      Description copied from interface: ShortValuesMap
      Returns the values in this map as a separate collection. The returned collection is backed by the map, so any changes made to the returned collection will affect the state of this map.
      Specified by:
      values in interface ShortValuesMap
      Returns:
      the values as a collection backed by this map

    • equals

      public boolean equals(Object otherMap)
      Description copied from interface: ByteShortMap
      Follows the same general contract as Map.equals(Object).
      Specified by:
      equals in interface ByteShortMap
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Description copied from interface: ByteShortMap
      Follows the same general contract as Map.hashCode().
      Specified by:
      hashCode in interface ByteShortMap
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Description copied from interface: ByteShortMap
      Follows the same general contract as AbstractMap.toString()
      Specified by:
      toString in interface ByteShortMap
      Specified by:
      toString in interface PrimitiveIterable
      Overrides:
      toString in class Object
      Returns:
      a string representation of this ByteShortMap
      See Also:

    • makeString

      public String makeString()
      Description copied from interface: PrimitiveIterable
      Returns a string representation of this collection by delegating to PrimitiveIterable.makeString(String) and defaulting the separator parameter to the characters ", " (comma and space).
      Specified by:
      makeString in interface PrimitiveIterable
      Returns:
      a string representation of this collection.

    • makeString

      public String makeString(String separator)
      Description copied from interface: PrimitiveIterable
      Returns a string representation of this collection by delegating to PrimitiveIterable.makeString(String, String, String) and defaulting the start and end parameters to "" (the empty String).
      Specified by:
      makeString in interface PrimitiveIterable
      Returns:
      a string representation of this collection.

    • makeString

      public String makeString(String start, String separator, String end)
      Description copied from interface: PrimitiveIterable
      Returns a string representation of this collection with the elements separated by the specified separator and enclosed between the start and end strings.
      Specified by:
      makeString in interface PrimitiveIterable
      Returns:
      a string representation of this collection.

    • appendString

      public void appendString(Appendable appendable)
      Description copied from interface: PrimitiveIterable
      Prints a string representation of this collection onto the given Appendable. Prints the string returned by PrimitiveIterable.makeString().
      Specified by:
      appendString in interface PrimitiveIterable

    • appendString

      public void appendString(Appendable appendable, String separator)
      Description copied from interface: PrimitiveIterable
      Prints a string representation of this collection onto the given Appendable. Prints the string returned by PrimitiveIterable.makeString(String).
      Specified by:
      appendString in interface PrimitiveIterable

    • appendString

      public void appendString(Appendable appendable, String start, String separator, String end)
      Description copied from interface: PrimitiveIterable
      Prints a string representation of this collection onto the given Appendable. Prints the string returned by PrimitiveIterable.makeString(String, String, String).
      Specified by:
      appendString in interface PrimitiveIterable

    • injectInto

      public <T> T injectInto(T injectedValue, ObjectShortToObjectFunction<? super T,? extends T> function)
      Specified by:
      injectInto in interface ShortIterable

    • chunk

      public RichIterable<ShortIterable> chunk(int size)
      Description copied from interface: ShortIterable
      Partitions elements in fixed size chunks.
      Specified by:
      chunk in interface ShortIterable
      Parameters:
      size - the number of elements per chunk
      Returns:
      A RichIterable containing ShortIterables of size size, except the last will be truncated if the elements don't divide evenly.