org.apache.beam.sdk.state

Interface SetState<T>

Type Parameters:

T - The type of elements in the set.

All Superinterfaces:

GroupingState<T,java.lang.Iterable<T>>, ReadableState<java.lang.Iterable<T>>, State

@Experimental(value=STATE)
public interface SetState<T>
extends GroupingState<T,java.lang.Iterable<T>>

A ReadableState cell containing a set of elements.

Implementations of this form of state are expected to implement set operations such as contains(Object) efficiently, reading as little of the overall set as possible.

Method Summary

Modifier and Type	Method and Description
ReadableState<java.lang.Boolean>	addIfAbsent(T t) Ensures a value is a member of the set, returning true if it was added and false otherwise.
ReadableState<java.lang.Boolean>	contains(T t) Returns true if this set contains the specified element.
SetState<T>	readLater() Indicate that the value will be read later.
void	remove(T t) Removes the specified element from this set if it is present.

Methods inherited from interface org.apache.beam.sdk.state.GroupingState

add, isEmpty

Methods inherited from interface org.apache.beam.sdk.state.ReadableState

read

Methods inherited from interface org.apache.beam.sdk.state.State

clear

Method Detail

contains

ReadableState<java.lang.Boolean> contains(T t)

Returns true if this set contains the specified element.

addIfAbsent

ReadableState<java.lang.Boolean> addIfAbsent(T t)

Ensures a value is a member of the set, returning true if it was added and false otherwise.

Elements added will not be reflected in OutputT objects returned by previous calls to ReadableState.read().

remove

void remove(T t)

Removes the specified element from this set if it is present.

Changes will not be reflected in OutputT objects returned by previous calls to ReadableState.read().

readLater

SetState<T> readLater()

Description copied from interface: ReadableState

Indicate that the value will be read later.

This allows an implementation to start an asynchronous prefetch or to include this state in the next batch of reads.

Specified by:

readLater in interface GroupingState<T,java.lang.Iterable<T>>

Specified by:

readLater in interface ReadableState<java.lang.Iterable<T>>

Returns:

this for convenient chaining