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

Class SynchronizedObjectBooleanMap<K>

java.lang.Object
org.eclipse.collections.impl.map.mutable.primitive.SynchronizedObjectBooleanMap<K>
All Implemented Interfaces:
Serializable, BooleanIterable, MutableObjectBooleanMap<K>, ObjectBooleanMap<K>, PrimitiveIterable
public class SynchronizedObjectBooleanMap<K> extends Object implements MutableObjectBooleanMap<K>, Serializable
A synchronized view of a MutableObjectBooleanMap. It is imperative that the user manually synchronize on the collection when iterating over it using the BooleanIterator as per Collections.synchronizedCollection(Collection).

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

Since:
3.1.
See Also:

  • Constructor Details

  • Method Details

    • clear

      public void clear()
      Description copied from interface: MutableObjectBooleanMap
      Removes all entries from this map.
      Specified by:
      clear in interface MutableObjectBooleanMap<K>

    • put

      public void put(K key, boolean value)
      Description copied from interface: MutableObjectBooleanMap
      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 MutableObjectBooleanMap<K>
      Parameters:
      key - the key
      value - the value to associate with value

    • putPair

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

    • putAll

      public void putAll(ObjectBooleanMap<? extends K> map)
      Description copied from interface: MutableObjectBooleanMap
      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 MutableObjectBooleanMap<K>
      Parameters:
      map - the map to copy into this map

    • updateValues

      public void updateValues(ObjectBooleanToBooleanFunction<? super K> function)
      Description copied from interface: MutableObjectBooleanMap
      Updates the values in-place.
      Specified by:
      updateValues in interface MutableObjectBooleanMap<K>
      Parameters:
      function - that takes a key and its value and that returns a new value for this key

    • removeKey

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

    • remove

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

    • removeKeyIfAbsent

      public boolean removeKeyIfAbsent(K key, boolean value)
      Description copied from interface: MutableObjectBooleanMap
      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 MutableObjectBooleanMap<K>
      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 boolean getIfAbsentPut(K key, boolean value)
      Description copied from interface: MutableObjectBooleanMap
      Retrieves the value associated with the key if one exists; if it does not, associates a value with the key. a new value with they key
      Specified by:
      getIfAbsentPut in interface MutableObjectBooleanMap<K>
      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

    • getAndPut

      public boolean getAndPut(K key, boolean putValue, boolean defaultValue)
      Description copied from interface: MutableObjectBooleanMap
      Retrieves the value associated with the key if one exists; if it does not, associates a putValue with the key.
      Specified by:
      getAndPut in interface MutableObjectBooleanMap<K>
      Parameters:
      key - the key
      putValue - the value to associate with key if no such mapping exists
      defaultValue - the value to return if no mapping associated with key exists
      Returns:
      the value associated with key, if one exists, or defaultValue if not

    • getIfAbsentPut

      public boolean getIfAbsentPut(K key, BooleanFunction0 function)
      Description copied from interface: MutableObjectBooleanMap
      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 MutableObjectBooleanMap<K>
      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 boolean getIfAbsentPutWithKey(K key, BooleanFunction<? super K> function)
      Description copied from interface: MutableObjectBooleanMap
      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 MutableObjectBooleanMap<K>
      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> boolean getIfAbsentPutWith(K key, BooleanFunction<? super P> function, P parameter)
      Description copied from interface: MutableObjectBooleanMap
      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 MutableObjectBooleanMap<K>
      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 boolean updateValue(K key, boolean initialValueIfAbsent, BooleanToBooleanFunction function)
      Description copied from interface: MutableObjectBooleanMap
      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 MutableObjectBooleanMap<K>
      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 boolean get(Object key)
      Description copied from interface: ObjectBooleanMap
      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 ObjectBooleanMap<K>
      Parameters:
      key - the key
      Returns:
      the value associated with the key, or the default value if no such mapping exists

    • getOrThrow

      public boolean getOrThrow(Object key)
      Description copied from interface: ObjectBooleanMap
      Retrieves the value associated with the key, throwing an IllegalStateException if no such mapping exists.
      Specified by:
      getOrThrow in interface ObjectBooleanMap<K>
      Parameters:
      key - the key
      Returns:
      the value associated with the key

    • getIfAbsent

      public boolean getIfAbsent(Object key, boolean ifAbsent)
      Description copied from interface: ObjectBooleanMap
      Retrieves the value associated with the key, returning the specified default value if no such mapping exists.
      Specified by:
      getIfAbsent in interface ObjectBooleanMap<K>
      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.

    • containsKey

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

    • containsValue

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

    • forEachValue

      public void forEachValue(BooleanProcedure procedure)
      Description copied from interface: ObjectBooleanMap
      Iterates through each value in this map.
      Specified by:
      forEachValue in interface ObjectBooleanMap<K>
      Parameters:
      procedure - the procedure to invoke for each value in this map.

    • forEachKey

      public void forEachKey(Procedure<? super K> procedure)
      Description copied from interface: ObjectBooleanMap
      Iterates through each key in the map, invoking the procedure for each.
      Specified by:
      forEachKey in interface ObjectBooleanMap<K>
      Parameters:
      procedure - the procedure to invoke for each key

    • forEachKeyValue

      public void forEachKeyValue(ObjectBooleanProcedure<? super K> procedure)
      Description copied from interface: ObjectBooleanMap
      Iterates through each key/value pair in the map, invoking the procedure for each.
      Specified by:
      forEachKeyValue in interface ObjectBooleanMap<K>
      Parameters:
      procedure - the procedure to invoke for each key/value pair

    • select

      public MutableObjectBooleanMap<K> select(ObjectBooleanPredicate<? super K> predicate)
      Description copied from interface: ObjectBooleanMap
      Return a copy of this map containing only the key/value pairs that match the predicate.
      Specified by:
      select in interface MutableObjectBooleanMap<K>
      Specified by:
      select in interface ObjectBooleanMap<K>
      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 MutableObjectBooleanMap<K> reject(ObjectBooleanPredicate<? super K> predicate)
      Description copied from interface: ObjectBooleanMap
      Return a copy of this map containing only the key/value pairs that do not match the predicate.
      Specified by:
      reject in interface MutableObjectBooleanMap<K>
      Specified by:
      reject in interface ObjectBooleanMap<K>
      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

    • booleanIterator

      public MutableBooleanIterator booleanIterator()
      Must be called in a synchronized block.
      Specified by:
      booleanIterator in interface BooleanIterable
      Specified by:
      booleanIterator in interface MutableObjectBooleanMap<K>

    • each

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

    • count

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

    • anySatisfy

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

    • allSatisfy

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

    • noneSatisfy

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

    • select

      public MutableBooleanCollection select(BooleanPredicate predicate)
      Description copied from interface: BooleanIterable
      Returns a new BooleanIterable with all of the elements in the BooleanIterable that return true for the specified predicate.
      Specified by:
      select in interface BooleanIterable
      Specified by:
      select in interface MutableObjectBooleanMap<K>

    • reject

      public MutableBooleanCollection reject(BooleanPredicate predicate)
      Description copied from interface: BooleanIterable
      Returns a new BooleanIterable with all of the elements in the BooleanIterable that return false for the specified predicate.
      Specified by:
      reject in interface BooleanIterable
      Specified by:
      reject in interface MutableObjectBooleanMap<K>

    • detectIfNone

      public boolean detectIfNone(BooleanPredicate predicate, boolean ifNone)
      Specified by:
      detectIfNone in interface BooleanIterable

    • collect

      public <V1> MutableCollection<V1> collect(BooleanToObjectFunction<? extends V1> function)
      Description copied from interface: BooleanIterable
      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 BooleanIterable
      Specified by:
      collect in interface MutableObjectBooleanMap<K>

    • toArray

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

    • toArray

      public boolean[] toArray(boolean[] target)
      Description copied from interface: BooleanIterable
      Converts the BooleanIterable to a primitive boolean 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 BooleanIterable

    • contains

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

    • containsAll

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

    • containsAll

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

    • toList

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

    • toSet

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

    • toBag

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

    • asLazy

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

    • withKeyValue

      public MutableObjectBooleanMap<K> withKeyValue(K key, boolean value)
      Description copied from interface: MutableObjectBooleanMap
      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 MutableObjectBooleanMap<K>
      Parameters:
      key - the key
      value - the value to associate with value
      Returns:
      this map
      See Also:

    • withoutKey

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

    • withoutAllKeys

      public MutableObjectBooleanMap<K> withoutAllKeys(Iterable<? extends K> keys)
      Description copied from interface: MutableObjectBooleanMap
      Removes the mappings associated with all the keys, if they exist, from this map.
      Specified by:
      withoutAllKeys in interface MutableObjectBooleanMap<K>
      Parameters:
      keys - the keys to remove
      Returns:
      this map
      See Also:

    • asUnmodifiable

      public MutableObjectBooleanMap<K> asUnmodifiable()
      Specified by:
      asUnmodifiable in interface MutableObjectBooleanMap<K>

    • asSynchronized

      public MutableObjectBooleanMap<K> asSynchronized()
      Specified by:
      asSynchronized in interface MutableObjectBooleanMap<K>

    • toImmutable

      public ImmutableObjectBooleanMap<K> toImmutable()
      Description copied from interface: ObjectBooleanMap
      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 ObjectBooleanMap<K>
      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 Set<K> keySet()
      Description copied from interface: ObjectBooleanMap
      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 ObjectBooleanMap<K>
      Returns:
      a mutable set containing the keys in this map

    • values

      public MutableBooleanCollection values()
      Description copied from interface: ObjectBooleanMap
      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 ObjectBooleanMap<K>
      Returns:
      the values as a collection backed by this map

    • keysView

      public LazyIterable<K> keysView()
      Description copied from interface: ObjectBooleanMap
      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 ObjectBooleanMap<K>
      Returns:
      a view of the keys in this map

    • keyValuesView

      public RichIterable<ObjectBooleanPair<K>> keyValuesView()
      Description copied from interface: ObjectBooleanMap
      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 ObjectBooleanMap<K>
      Returns:
      a view of the keys in this map

    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Description copied from interface: ObjectBooleanMap
      Follows the same general contract as AbstractMap.toString()
      Specified by:
      toString in interface ObjectBooleanMap<K>
      Specified by:
      toString in interface PrimitiveIterable
      Overrides:
      toString in class Object
      Returns:
      a string representation of this ObjectBooleanMap
      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, ObjectBooleanToObjectFunction<? super T,? extends T> function)
      Specified by:
      injectInto in interface BooleanIterable

    • chunk

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