org.apache.beam.runners.local

Class StructuralKey<K>

java.lang.Object

org.apache.beam.runners.local.StructuralKey<K>

public abstract class StructuralKey<K>
extends java.lang.Object

A (Key, Coder) pair that uses the structural value of the key (as provided by Coder.structuralValue(Object)) to perform equality and hashing.

Method Summary

Modifier and Type	Method and Description
static StructuralKey<?>	empty() Get the empty StructuralKey.
abstract K	getKey() Returns the key that this StructuralKey was created from.
static <K> StructuralKey<K>	of(K key, Coder<K> coder) Create a new Structural Key of the provided key that can be encoded by the provided coder.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getKey

public abstract K getKey()

Returns the key that this StructuralKey was created from.

empty

public static StructuralKey<?> empty()

Get the empty StructuralKey. All instances of the empty key are considered equal.

of

public static <K> StructuralKey<K> of(K key,
                                      Coder<K> coder)

Create a new Structural Key of the provided key that can be encoded by the provided coder.