com.google.cloud.dataflow.sdk.util

Class CoderUtils

java.lang.Object

com.google.cloud.dataflow.sdk.util.CoderUtils

public final class CoderUtils
extends Object

Utilities for working with Coders.

Field Summary

Fields

Modifier and Type	Field and Description
static String	KIND_PAIR Coder class-name alias for a key-value type.
static String	KIND_STREAM Coder class-name alias for a stream type.

Method Summary

Modifier and Type	Method and Description
static <T> T	clone(Coder<T> coder, T value) Clones the given value by encoding and then decoding it with the specified Coder.
static <T> T	decodeFromBase64(Coder<T> coder, String encodedValue) Parses a value from a base64-encoded String using the given coder.
static <T> T	decodeFromByteArray(Coder<T> coder, byte[] encodedValue) Decodes the given bytes using the specified Coder, and returns the resulting decoded value.
static <T> T	decodeFromByteArray(Coder<T> coder, byte[] encodedValue, Coder.Context context)
static <T> String	encodeToBase64(Coder<T> coder, T value) Encodes the given value using the specified Coder, and returns the Base64 encoding of the encoded bytes.
static <T> byte[]	encodeToByteArray(Coder<T> coder, T value) Encodes the given value using the specified Coder, and returns the encoded bytes.
static <T> byte[]	encodeToByteArray(Coder<T> coder, T value, Coder.Context context)
static TypeDescriptor	getCodedType(TypeDescriptor coderDescriptor) If coderType is a subclass of Coder<T> for a specific type T, returns T.class.
static CloudObject	makeCloudEncoding(String type, CloudObject... componentSpecs)

Methods inherited from class java.lang.Object

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

Field Detail

KIND_PAIR

public static final String KIND_PAIR

Coder class-name alias for a key-value type.

See Also:

Constant Field Values

KIND_STREAM

public static final String KIND_STREAM

Coder class-name alias for a stream type.

See Also:

Constant Field Values

Method Detail

encodeToByteArray

public static <T> byte[] encodeToByteArray(Coder<T> coder,
                                           T value)
                                    throws CoderException

Encodes the given value using the specified Coder, and returns the encoded bytes.

This function is not reentrant; it should not be called from methods of the provided Coder.

Throws:

CoderException

encodeToByteArray

public static <T> byte[] encodeToByteArray(Coder<T> coder,
                                           T value,
                                           Coder.Context context)
                                    throws CoderException

Throws:

CoderException

decodeFromByteArray

public static <T> T decodeFromByteArray(Coder<T> coder,
                                        byte[] encodedValue)
                                 throws CoderException

Decodes the given bytes using the specified Coder, and returns the resulting decoded value.

Throws:

CoderException

decodeFromByteArray

public static <T> T decodeFromByteArray(Coder<T> coder,
                                        byte[] encodedValue,
                                        Coder.Context context)
                                 throws CoderException

Throws:

CoderException

clone

public static <T> T clone(Coder<T> coder,
                          T value)
                   throws CoderException

Clones the given value by encoding and then decoding it with the specified Coder.

This function is not reentrant; it should not be called from methods of the provided Coder.

Throws:

CoderException

encodeToBase64

public static <T> String encodeToBase64(Coder<T> coder,
                                        T value)
                                 throws CoderException

Encodes the given value using the specified Coder, and returns the Base64 encoding of the encoded bytes.

Throws:

CoderException - if there are errors during encoding.

decodeFromBase64

public static <T> T decodeFromBase64(Coder<T> coder,
                                     String encodedValue)
                              throws CoderException

Parses a value from a base64-encoded String using the given coder.

Throws:

CoderException

getCodedType

public static TypeDescriptor getCodedType(TypeDescriptor coderDescriptor)

If coderType is a subclass of Coder<T> for a specific type T, returns T.class.

makeCloudEncoding

public static CloudObject makeCloudEncoding(String type,
                                            CloudObject... componentSpecs)