public class ByteStringCoder extends AtomicCoder<com.google.protobuf.ByteString>
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.
Coder.Context, Coder.NonDeterministicException
Modifier and Type | Method and Description |
---|---|
boolean |
consistentWithEquals()
|
com.google.protobuf.ByteString |
decode(java.io.InputStream inStream)
Decodes a value of type
T from the given input stream in the given context. |
com.google.protobuf.ByteString |
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(com.google.protobuf.ByteString value,
java.io.OutputStream outStream)
Encodes the given value of type
T onto the given output stream. |
void |
encode(com.google.protobuf.ByteString 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(com.google.protobuf.ByteString value)
Returns the size in bytes of the encoded value using this coder.
|
TypeDescriptor<com.google.protobuf.ByteString> |
getEncodedTypeDescriptor()
Returns the
TypeDescriptor for the type encoded. |
boolean |
isRegisterByteSizeObserverCheap(com.google.protobuf.ByteString value)
Returns whether
Coder.registerByteSizeObserver(T, org.apache.beam.sdk.util.common.ElementByteSizeObserver) cheap enough to call for every element, that
is, if this Coder can calculate the byte size of the element to be coded in roughly
constant time (or lazily). |
static ByteStringCoder |
of() |
void |
verifyDeterministic()
Throw
Coder.NonDeterministicException if the coding is not deterministic. |
equals, getCoderArguments, getComponents, hashCode
toString
registerByteSizeObserver, structuralValue, verifyDeterministic, verifyDeterministic
public static ByteStringCoder of()
public void encode(com.google.protobuf.ByteString value, java.io.OutputStream outStream) throws java.io.IOException, CoderException
Coder
T
onto the given output stream. Multiple elements can
be encoded next to each other on the output stream, each coder should encode information to
know how many bytes to read when decoding. A common approach is to prefix the encoding with the
element's encoded length.encode
in class Coder<com.google.protobuf.ByteString>
java.io.IOException
- if writing to the OutputStream
fails for some reasonCoderException
- if the value could not be encoded for some reasonpublic void encode(com.google.protobuf.ByteString value, java.io.OutputStream outStream, Coder.Context context) throws java.io.IOException, CoderException
Coder
T
onto the given output stream in the given context.encode
in class Coder<com.google.protobuf.ByteString>
java.io.IOException
- if writing to the OutputStream
fails for some reasonCoderException
- if the value could not be encoded for some reasonpublic com.google.protobuf.ByteString decode(java.io.InputStream inStream) throws java.io.IOException
Coder
T
from the given input stream in the given context. Returns the
decoded value. Multiple elements can be encoded next to each other on the input stream, each
coder should encode information to know how many bytes to read when decoding. A common approach
is to prefix the encoding with the element's encoded length.decode
in class Coder<com.google.protobuf.ByteString>
java.io.IOException
- if reading from the InputStream
fails for some reasonCoderException
- if the value could not be decoded for some reasonpublic com.google.protobuf.ByteString decode(java.io.InputStream inStream, Coder.Context context) throws java.io.IOException
Coder
T
from the given input stream in the given context. Returns the
decoded value.decode
in class Coder<com.google.protobuf.ByteString>
java.io.IOException
- if reading from the InputStream
fails for some reasonCoderException
- if the value could not be decoded for some reasonprotected long getEncodedElementByteSize(com.google.protobuf.ByteString value) throws java.lang.Exception
Coder
getEncodedElementByteSize
in class Coder<com.google.protobuf.ByteString>
java.lang.Exception
public void verifyDeterministic()
AtomicCoder
Coder.NonDeterministicException
if the coding is not deterministic.
In order for a Coder
to be considered deterministic, the following must be true:
Object.equals()
or Comparable.compareTo()
, if supported) have the same encoding.
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.
Unless overridden, does not throw. An AtomicCoder
is presumed to be deterministic
verifyDeterministic
in class AtomicCoder<com.google.protobuf.ByteString>
public boolean consistentWithEquals()
true
if this Coder
is injective with respect to Object.equals(java.lang.Object)
.
Whenever the encoded bytes of two values are equal, then the original values are equal
according to Objects.equals()
. Note that this is well-defined for null
.
This condition is most notably false for arrays. More generally, this condition is false
whenever equals()
compares object identity, rather than performing a
semantic/structural comparison.
By default, returns false.
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)
.
consistentWithEquals
in class Coder<com.google.protobuf.ByteString>
public boolean isRegisterByteSizeObserverCheap(com.google.protobuf.ByteString value)
Coder.registerByteSizeObserver(T, org.apache.beam.sdk.util.common.ElementByteSizeObserver)
cheap enough to call for every element, that
is, if this Coder
can calculate the byte size of the element to be coded in roughly
constant time (or lazily).
Not intended to be called by user code, but instead by PipelineRunner
implementations.
By default, returns false. The default Coder.registerByteSizeObserver(T, org.apache.beam.sdk.util.common.ElementByteSizeObserver)
implementation
invokes Coder.getEncodedElementByteSize(T)
which requires re-encoding an element unless it is
overridden. This is considered expensive.
Returns true. ByteString.size()
returns the size of an array and a VarInt
.
isRegisterByteSizeObserverCheap
in class Coder<com.google.protobuf.ByteString>
public TypeDescriptor<com.google.protobuf.ByteString> getEncodedTypeDescriptor()
Coder
TypeDescriptor
for the type encoded.getEncodedTypeDescriptor
in class Coder<com.google.protobuf.ByteString>