Google Cloud Dataflow SDK for Java, version 1.9.1
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.DeterministicStandardCoder<T>
-
- com.google.cloud.dataflow.sdk.coders.AtomicCoder<byte[]>
-
- com.google.cloud.dataflow.sdk.coders.ByteArrayCoder
-
- All Implemented Interfaces:
- Coder<byte[]>, Serializable
public class ByteArrayCoder extends AtomicCoder<byte[]>
ACoder
forbyte[]
.The encoding format is as follows:
- If in a non-nested context (the
byte[]
is the only value in the stream), the bytes are read/written directly. - If in a nested context, the bytes are prefixed with the length of the array,
encoded via a
VarIntCoder
.
- 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
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method and Description byte[]
decode(InputStream inStream, Coder.Context context)
Decodes a value of typeT
from the given input stream in the given context.void
encode(byte[] value, OutputStream outStream, Coder.Context context)
Encodes the given value of typeT
onto the given output stream in the given context.void
encodeAndOwn(byte[] value, OutputStream outStream, Coder.Context context)
Encodes the providedvalue
with the identical encoding toencode(byte[], java.io.OutputStream, com.google.cloud.dataflow.sdk.coders.Coder.Context)
, but with optimizations that take ownership of the value.protected long
getEncodedElementByteSize(byte[] value, Coder.Context context)
Returns the size in bytes of the encoded value using this coder.boolean
isRegisterByteSizeObserverCheap(byte[] value, Coder.Context context)
Returns whetherCoder.registerByteSizeObserver(T, com.google.cloud.dataflow.sdk.util.common.ElementByteSizeObserver, com.google.cloud.dataflow.sdk.coders.Coder.Context)
cheap enough to call for every element, that is, if thisCoder
can calculate the byte size of the element to be coded in roughly constant time (or lazily).static ByteArrayCoder
of()
Object
structuralValue(byte[] value)
Returns an object with anObject.equals()
method that represents structural equality on the argument.-
Methods inherited from class com.google.cloud.dataflow.sdk.coders.AtomicCoder
getCoderArguments, getInstanceComponents
-
Methods inherited from class com.google.cloud.dataflow.sdk.coders.DeterministicStandardCoder
verifyDeterministic
-
Methods inherited from class com.google.cloud.dataflow.sdk.coders.StandardCoder
asCloudObject, consistentWithEquals, equals, getAllowedEncodings, getComponents, getEncodingId, hashCode, registerByteSizeObserver, toString, verifyDeterministic, verifyDeterministic
-
-
-
-
Method Detail
-
of
public static ByteArrayCoder of()
-
encode
public void encode(byte[] value, OutputStream outStream, Coder.Context context) throws IOException, CoderException
Description copied from interface:Coder
Encodes the given value of typeT
onto the given output stream in the given context.- Throws:
IOException
- if writing to theOutputStream
fails for some reasonCoderException
- if the value could not be encoded for some reason
-
encodeAndOwn
public void encodeAndOwn(byte[] value, OutputStream outStream, Coder.Context context) throws IOException, CoderException
Encodes the providedvalue
with the identical encoding toencode(byte[], java.io.OutputStream, com.google.cloud.dataflow.sdk.coders.Coder.Context)
, but with optimizations that take ownership of the value.Once passed to this method,
value
should never be observed or mutated again.- Throws:
IOException
CoderException
-
decode
public byte[] decode(InputStream inStream, Coder.Context context) throws IOException, CoderException
Description copied from interface:Coder
Decodes a value of typeT
from the given input stream in the given context. Returns the decoded value.- Throws:
IOException
- if reading from theInputStream
fails for some reasonCoderException
- if the value could not be decoded for some reason
-
structuralValue
public Object structuralValue(byte[] value)
Returns an object with anObject.equals()
method that represents structural equality on the argument.For any two values
x
andy
of typeT
, if their encoded bytes are the same, then it must be the case thatstructuralValue(x).equals(@code structuralValue(y)
.Most notably:
- The structural value for an array coder should perform a structural comparison of the contents of the arrays, rather than the default behavior of comparing according to object identity.
- The structural value for a coder accepting
null
should be a proper object with anequals()
method, even if the input value isnull
.
See also
Coder.consistentWithEquals()
.- Specified by:
structuralValue
in interfaceCoder<byte[]>
- Overrides:
structuralValue
in classStandardCoder<byte[]>
- Returns:
- objects that are equal if the two arrays contain the same bytes.
-
isRegisterByteSizeObserverCheap
public boolean isRegisterByteSizeObserverCheap(byte[] value, Coder.Context context)
Returns whetherCoder.registerByteSizeObserver(T, com.google.cloud.dataflow.sdk.util.common.ElementByteSizeObserver, com.google.cloud.dataflow.sdk.coders.Coder.Context)
cheap enough to call for every element, that is, if thisCoder
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.- Specified by:
isRegisterByteSizeObserverCheap
in interfaceCoder<byte[]>
- Overrides:
isRegisterByteSizeObserverCheap
in classStandardCoder<byte[]>
- Returns:
true
sincegetEncodedElementByteSize(byte[], com.google.cloud.dataflow.sdk.coders.Coder.Context)
runs in constant time using thelength
of the provided array.
-
getEncodedElementByteSize
protected long getEncodedElementByteSize(byte[] value, Coder.Context context) throws Exception
Description copied from class:StandardCoder
Returns the size in bytes of the encoded value using this coder.- Overrides:
getEncodedElementByteSize
in classStandardCoder<byte[]>
- Throws:
Exception
-
-