org.apache.beam.sdk.io.fs

Class MetadataCoder

java.lang.Object

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

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

org.apache.beam.sdk.coders.AtomicCoder<MatchResult.Metadata>

org.apache.beam.sdk.io.fs.MetadataCoder

All Implemented Interfaces:

java.io.Serializable

public class MetadataCoder
extends AtomicCoder<MatchResult.Metadata>

A Coder for MatchResult.Metadata.

The MatchResult.Metadata.lastModifiedMillis() field was added after this coder was already deployed, so this class decodes a default value for backwards compatibility. See MetadataCoderV2 for retaining timestamp information.

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() Returns true if this Coder is injective with respect to Object.equals(java.lang.Object).
MatchResult.Metadata	decode(java.io.InputStream is) Decodes a value of type T from the given input stream in the given context.
void	encode(MatchResult.Metadata value, java.io.OutputStream os) Encodes the given value of type T onto the given output stream.
static MetadataCoder	of() Returns the singleton MetadataCoder instance.

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

equals, getCoderArguments, getComponents, hashCode, verifyDeterministic

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

toString

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

decode, encode, getEncodedElementByteSize, getEncodedTypeDescriptor, isRegisterByteSizeObserverCheap, registerByteSizeObserver, structuralValue, verifyDeterministic, verifyDeterministic

Methods inherited from class java.lang.Object

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

Method Detail

of

public static MetadataCoder of()

Returns the singleton MetadataCoder instance.

encode

public void encode(MatchResult.Metadata value,
                   java.io.OutputStream os)
            throws java.io.IOException

Description copied from class: Coder

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

Specified by:

encode in class Coder<MatchResult.Metadata>

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 MatchResult.Metadata decode(java.io.InputStream is)
                            throws java.io.IOException

Description copied from class: Coder

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

Specified by:

decode in class Coder<MatchResult.Metadata>

Throws:

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

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

consistentWithEquals

public boolean consistentWithEquals()

Description copied from class: Coder

Returns 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.

Overrides:

consistentWithEquals in class Coder<MatchResult.Metadata>