Packages

trait ListState[S] extends Serializable

Annotations
@Evolving()
Source
ListState.scala
Linear Supertypes
Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ListState
  2. Serializable
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. 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

  2. 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

  3. abstract def clear(): Unit

    Function to remove the state for the current grouping key.

  4. 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.

  5. 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.

  6. 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

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  9. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  10. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  11. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  13. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  14. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  15. def toString(): String
    Definition Classes
    AnyRef → Any
  16. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  17. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  18. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped