org.apache.beam.sdk.extensions.protobuf

Class ByteStringCoder

java.lang.Object

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

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

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

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

All Implemented Interfaces:

Serializable

public class ByteStringCoder
extends AtomicCoder<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 class 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)
com.google.protobuf.ByteString	decode(InputStream inStream, Coder.Context context)
void	encode(com.google.protobuf.ByteString value, OutputStream outStream)
void	encode(com.google.protobuf.ByteString value, OutputStream outStream, Coder.Context context)
protected long	getEncodedElementByteSize(com.google.protobuf.ByteString value)
TypeDescriptor<com.google.protobuf.ByteString>	getEncodedTypeDescriptor()
boolean	isRegisterByteSizeObserverCheap(com.google.protobuf.ByteString value)
static ByteStringCoder	of()
void	verifyDeterministic()

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

equals, getCoderArguments, getComponents, hashCode

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

structuralValue, toString

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

registerByteSizeObserver, 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)
            throws IOException,
                   CoderException

Specified by:

encode in class Coder<com.google.protobuf.ByteString>

Throws:

IOException

CoderException

encode

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

Overrides:

encode in class Coder<com.google.protobuf.ByteString>

Throws:

IOException

CoderException

decode

public com.google.protobuf.ByteString decode(InputStream inStream)
                                      throws IOException

Specified by:

decode in class Coder<com.google.protobuf.ByteString>

Throws:

IOException

decode

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

Overrides:

decode in class Coder<com.google.protobuf.ByteString>

Throws:

IOException

getEncodedElementByteSize

protected long getEncodedElementByteSize(com.google.protobuf.ByteString value)
                                  throws Exception

Overrides:

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

Throws:

Exception

verifyDeterministic

public void verifyDeterministic()

Overrides:

verifyDeterministic in class AtomicCoder<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).

Overrides:

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

isRegisterByteSizeObserverCheap

public boolean isRegisterByteSizeObserverCheap(com.google.protobuf.ByteString value)

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

Overrides:

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

getEncodedTypeDescriptor

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

Overrides:

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