com.google.cloud.dataflow.sdk.coders

Class ByteArrayCoder

java.lang.Object

com.google.cloud.dataflow.sdk.coders.StandardCoder<T>

com.google.cloud.dataflow.sdk.coders.AtomicCoder<byte[]>

com.google.cloud.dataflow.sdk.coders.ByteArrayCoder

All Implemented Interfaces:

Coder<byte[]>, java.io.Serializable

public class ByteArrayCoder
extends AtomicCoder<byte[]>

A ByteArrayCoder encodes byte[] objects. If in a nested context, prefixes the encoded array with a VarInt encoding of the length.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface com.google.cloud.dataflow.sdk.coders.Coder

Coder.Context, Coder.NonDeterministicException

Method Summary

Methods

Modifier and Type	Method and Description
byte[]	decode(java.io.InputStream inStream, Coder.Context context) Decodes a value of type T from the given input stream in the given context.
void	encode(byte[] value, java.io.OutputStream outStream, Coder.Context context) Encodes the given value of type T onto the given output stream in the given context.
protected long	getEncodedElementByteSize(byte[] value, Coder.Context context) Returns the size in bytes of the encoded value using this coder.
boolean	isDeterministic() Returns true if the coding is deterministic.
boolean	isRegisterByteSizeObserverCheap(byte[] value, Coder.Context context) Returns true since registerByteSizeObserver() runs in constant time.
static ByteArrayCoder	of()

Methods inherited from class com.google.cloud.dataflow.sdk.coders.AtomicCoder

getCoderArguments, getInstanceComponents

Methods inherited from class com.google.cloud.dataflow.sdk.coders.StandardCoder

asCloudObject, equals, getComponents, hashCode, registerByteSizeObserver, toString, verifyDeterministic, verifyDeterministic, verifyDeterministic

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

of

public static ByteArrayCoder of()

encode

public void encode(byte[] value,
          java.io.OutputStream outStream,
          Coder.Context context)
            throws java.io.IOException,
                   CoderException

Description copied from interface: Coder

Encodes the given value of type T onto the given output stream in the given context.

Throws:

java.io.IOException - if writing to the OutputStream fails for some reason

CoderException - if the value could not be encoded for some reason

decode

public byte[] decode(java.io.InputStream inStream,
            Coder.Context context)
              throws java.io.IOException,
                     CoderException

Description copied from interface: Coder

Decodes a value of type T from the given input stream in the given context. Returns the decoded value.

Throws:

java.io.IOException - if reading from the InputStream fails for some reason

CoderException - if the value could not be decoded for some reason

isDeterministic

public boolean isDeterministic()

Description copied from interface: Coder

Returns true if the coding is deterministic.

In order for a Coder to be considered deterministic, the following must be true:

• two values which compare as equal (via Object.equals() or Comparable.compareTo(), if supported), have the same encoding.
• the Coder always produces a canonical encoding, which is the same for an instance of an object even if produced on different computers at different times.

isRegisterByteSizeObserverCheap

public boolean isRegisterByteSizeObserverCheap(byte[] value,
                                      Coder.Context context)

Returns true since registerByteSizeObserver() runs in constant time.

Specified by:

isRegisterByteSizeObserverCheap in interface Coder<byte[]>

Overrides:

isRegisterByteSizeObserverCheap in class StandardCoder<byte[]>

getEncodedElementByteSize

protected long getEncodedElementByteSize(byte[] value,
                             Coder.Context context)
                                  throws java.lang.Exception

Description copied from class: StandardCoder

Returns the size in bytes of the encoded value using this coder. Derived classes override this method if byte size can be computed with less computation or copying.

Overrides:

getEncodedElementByteSize in class StandardCoder<byte[]>

Throws:

java.lang.Exception