org.apache.beam.sdk.extensions.protobuf

Class ByteStringCoder

java.lang.Object

org.apache.beam.sdk.coders.StructuredCoder<T>

org.apache.beam.sdk.coders.CustomCoder<com.google.protobuf.ByteString>

org.apache.beam.sdk.extensions.protobuf.ByteStringCoder

All Implemented Interfaces:

Serializable, Coder<com.google.protobuf.ByteString>

public class ByteStringCoder
extends CustomCoder<com.google.protobuf.ByteString>

A Coder for ByteString objects based on their encoded Protocol Buffer form.

When this code is used in a nested Coder.Context, the serialized ByteString objects are first delimited by their size.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.beam.sdk.coders.Coder

Coder.Context, Coder.NonDeterministicException

Method Summary

Modifier and Type	Method and Description
boolean	consistentWithEquals()
com.google.protobuf.ByteString	decode(InputStream inStream, Coder.Context context)
void	encode(com.google.protobuf.ByteString value, OutputStream outStream, Coder.Context context)
protected long	getEncodedElementByteSize(com.google.protobuf.ByteString value, Coder.Context context)
TypeDescriptor<com.google.protobuf.ByteString>	getEncodedTypeDescriptor()
boolean	isRegisterByteSizeObserverCheap(com.google.protobuf.ByteString value, Coder.Context context)
static ByteStringCoder	of()
void	verifyDeterministic()

Methods inherited from class org.apache.beam.sdk.coders.CustomCoder

getCoderArguments, getInstanceComponents, initializeCloudObject, of

Methods inherited from class org.apache.beam.sdk.coders.StructuredCoder

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

Methods inherited from class java.lang.Object

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

Method Detail

of

public static ByteStringCoder of()

encode

public void encode(com.google.protobuf.ByteString value,
                   OutputStream outStream,
                   Coder.Context context)
            throws IOException,
                   CoderException

Throws:

IOException

CoderException

decode

public com.google.protobuf.ByteString decode(InputStream inStream,
                                             Coder.Context context)
                                      throws IOException

Throws:

IOException

getEncodedElementByteSize

protected long getEncodedElementByteSize(com.google.protobuf.ByteString value,
                                         Coder.Context context)
                                  throws Exception

Overrides:

getEncodedElementByteSize in class StructuredCoder<com.google.protobuf.ByteString>

Throws:

Exception

verifyDeterministic

public void verifyDeterministic()

Specified by:

verifyDeterministic in interface Coder<com.google.protobuf.ByteString>

Overrides:

verifyDeterministic in class CustomCoder<com.google.protobuf.ByteString>

consistentWithEquals

public boolean consistentWithEquals()

Returns true; the encoded output of two invocations of ByteStringCoder in the same Coder.Context will be identical if and only if the original ByteString objects are equal according to Object.equals(java.lang.Object).

Specified by:

consistentWithEquals in interface Coder<com.google.protobuf.ByteString>

Overrides:

consistentWithEquals in class StructuredCoder<com.google.protobuf.ByteString>

isRegisterByteSizeObserverCheap

public boolean isRegisterByteSizeObserverCheap(com.google.protobuf.ByteString value,
                                               Coder.Context context)

Returns true. ByteString.size() returns the size of an array and a VarInt.

Specified by:

isRegisterByteSizeObserverCheap in interface Coder<com.google.protobuf.ByteString>

Overrides:

isRegisterByteSizeObserverCheap in class StructuredCoder<com.google.protobuf.ByteString>

getEncodedTypeDescriptor

public TypeDescriptor<com.google.protobuf.ByteString> getEncodedTypeDescriptor()

Specified by:

getEncodedTypeDescriptor in interface Coder<com.google.protobuf.ByteString>

Overrides:

getEncodedTypeDescriptor in class StructuredCoder<com.google.protobuf.ByteString>