org.apache.beam.sdk.io.fs

Class ResourceIdCoder

java.lang.Object

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

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

org.apache.beam.sdk.coders.AtomicCoder<ResourceId>

org.apache.beam.sdk.io.fs.ResourceIdCoder

All Implemented Interfaces:

java.io.Serializable

public class ResourceIdCoder
extends AtomicCoder<ResourceId>

A Coder for ResourceId.

See Also:

Serialized Form

Nested Class Summary

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

Coder.Context, Coder.NonDeterministicException

Constructor Summary

Constructors

Constructor and Description
ResourceIdCoder()

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).
ResourceId	decode(java.io.InputStream is) Decodes a value of type T from the given input stream in the given context.
void	encode(ResourceId value, java.io.OutputStream os) Encodes the given value of type T onto the given output stream.
static ResourceIdCoder	of() Creates a ResourceIdCoder.

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

Constructor Detail

ResourceIdCoder

public ResourceIdCoder()

Method Detail

of

public static ResourceIdCoder of()

Creates a ResourceIdCoder.

encode

public void encode(ResourceId 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<ResourceId>

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 ResourceId 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<ResourceId>

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<ResourceId>