trait ListState[S] extends Serializable
- Annotations
- @Evolving()
- Source
- ListState.scala
- Alphabetic
- By Inheritance
- ListState
- Serializable
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Abstract Value Members
- abstract def appendList(newState: Array[S]): Unit
Function to append a list of entries to the existing state list.
Function to append a list of entries to the existing state list.
Note that if this is the first time the state is being appended to, the state will be initialized to an empty list before appending the new entries.
- newState
- list of elements to be appended
- abstract def appendValue(newState: S): Unit
Function to append a single entry to the existing state list.
Function to append a single entry to the existing state list.
Note that if this is the first time the state is being appended to, the state will be initialized to an empty list before appending the new entry.
- newState
- single list element to be appended
- abstract def clear(): Unit
Function to remove the state for the current grouping key.
- abstract def exists(): Boolean
Function to check whether state exists for current grouping key or not.
Function to check whether state exists for current grouping key or not.
- returns
- true if state exists, false otherwise.
- abstract def get(): Iterator[S]
Function to get the list of elements in the state as an iterator.
Function to get the list of elements in the state as an iterator. If the state does not exist, an empty iterator is returned.
Note that it's always recommended to check whether the state exists or not by calling exists() before calling get().
- returns
- an iterator of elements in the state if it exists, an empty iterator otherwise.
- abstract def put(newState: Array[S]): Unit
Function to update the value of the state with a new list.
Function to update the value of the state with a new list.
Note that this will replace the existing value with the new value.
- newState
- new list of elements
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)