trait MapState[K, V] extends Serializable
- Annotations
- @Evolving()
- Source
- MapState.scala
- Alphabetic
- By Inheritance
- MapState
- Serializable
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Abstract Value Members
- abstract def clear(): Unit
Function to remove the state for the current grouping key.
Function to remove the state for the current grouping key. Note that this removes the entire map state associated with the current grouping key.
- abstract def containsKey(key: K): Boolean
Function to check if the user map key is contained in the map for the current grouping key.
Function to check if the user map key is contained in the map for the current grouping key.
- key
- user map key
- returns
- true if the user key is present in the map, false otherwise.
- abstract def exists(): Boolean
Function to check whether any user map entry exists for current grouping key or not.
Function to check whether any user map entry exists for current grouping key or not.
- returns
- true if state exists, false otherwise.
- abstract def getValue(key: K): V
Function to get the state value for current grouping key and user map key.
Function to get the state value for current grouping key and user map key. If the state exists, the value is returned. If the state does not exist, the default value for the type is returned for AnyVal types and null for AnyRef types.
Note that it's always recommended to check whether the state exists or not by calling exists() before calling get().
- returns
- the value of the state if it exists. If the state does not exist, the default value for the type is returned for AnyVal types and null for AnyRef types.
- abstract def iterator(): Iterator[(K, V)]
Function to return the iterator of user map key-value pairs present in the map for the current grouping key.
Function to return the iterator of user map key-value pairs present in the map for the current grouping key.
- returns
- iterator of user map key-value pairs if the map is not empty and empty iterator otherwise.
- abstract def keys(): Iterator[K]
Function to return the user map keys present in the map for the current grouping key.
Function to return the user map keys present in the map for the current grouping key.
- returns
- iterator of user map keys if the map is not empty, empty iterator otherwise.
- abstract def removeKey(key: K): Unit
Function to remove the user map key from the map for the current grouping key.
Function to remove the user map key from the map for the current grouping key.
Note that this function will remove the user map key and its associated value from the map associated with the current grouping key. If the user map key is not present in the map, this function will not do anything.
- key
- user map key
- abstract def updateValue(key: K, value: V): Unit
Function to add or update the map entry for the current grouping key.
Function to add or update the map entry for the current grouping key.
Note that this function will add the user map key and value if the user map key is not present in the map associated with the current grouping key. If the user map key is already present in the associated map, the value for the user key will be updated to the new user map value.
- key
- user map key
- value
- user map value
- abstract def values(): Iterator[V]
Function to return the user map values present in the map for the current grouping key.
Function to return the user map values present in the map for the current grouping key.
- returns
- iterator of user map values if the map is not empty, empty iterator otherwise.
Concrete Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @IntrinsicCandidate() @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @IntrinsicCandidate() @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @IntrinsicCandidate() @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @IntrinsicCandidate() @native()
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
Deprecated Value Members
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated
(Since version 9)