Package org.apache.beam.sdk.io

Class ReadableFileCoder

java.lang.Object

org.apache.beam.sdk.coders.Coder<FileIO.ReadableFile>

org.apache.beam.sdk.coders.StructuredCoder<FileIO.ReadableFile>

org.apache.beam.sdk.io.ReadableFileCoder

All Implemented Interfaces:

Serializable

public class ReadableFileCoder
extends StructuredCoder<FileIO.ReadableFile>

A Coder for FileIO.ReadableFile.

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	Description
FileIO.ReadableFile	decode(@UnknownKeyFor @NonNull @Initialized InputStream inStream)	Decodes a value of type T from the given input stream in the given context.
void	encode(FileIO.ReadableFile value, @UnknownKeyFor @NonNull @Initialized OutputStream outStream)	Encodes the given value of type T onto the given output stream.
@UnknownKeyFor @NonNull @Initialized List<? extends Coder<?>>	getCoderArguments()	If this is a Coder for a parameterized type, returns the list of Coders being used for each of the parameters in the same order they appear within the parameterized type's type signature.
Coder<MatchResult.Metadata>	getMetadataCoder()
static ReadableFileCoder	of()
static ReadableFileCoder	of(Coder<MatchResult.Metadata> metadataCoder)
void	verifyDeterministic()	Throw Coder.NonDeterministicException if the coding is not deterministic.

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

equals, getComponents, hashCode, toString

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

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

Methods inherited from class java.lang.Object

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

Method Details

of

public static ReadableFileCoder of(Coder<MatchResult.Metadata> metadataCoder)

of

public static ReadableFileCoder of()

getMetadataCoder

public Coder<MatchResult.Metadata> getMetadataCoder()

encode

public void encode(FileIO.ReadableFile value,
 @UnknownKeyFor @NonNull @Initialized OutputStream outStream)
            throws CoderException,
IOException

Description copied from class: Coder

Encodes the given value of type 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.

Specified by:

encode in class Coder<FileIO.ReadableFile>

Throws:

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

IOException - if writing to the OutputStream fails for some reason

decode

public FileIO.ReadableFile decode(@UnknownKeyFor @NonNull @Initialized InputStream inStream)
                           throws CoderException,
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. 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.

Specified by:

decode in class Coder<FileIO.ReadableFile>

Throws:

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

IOException - if reading from the InputStream fails for some reason

getCoderArguments

public @UnknownKeyFor @NonNull @Initialized List<? extends Coder<?>> getCoderArguments()

Description copied from class: Coder

If this is a Coder for a parameterized type, returns the list of Coders being used for each of the parameters in the same order they appear within the parameterized type's type signature. If this cannot be done, or this Coder does not encode/decode a parameterized type, returns the empty list.

Specified by:

getCoderArguments in class Coder<FileIO.ReadableFile>

verifyDeterministic

public void verifyDeterministic()
                         throws Coder.NonDeterministicException

Description copied from class: Coder

Throw Coder.NonDeterministicException if the coding is not deterministic.

In order for a Coder to be considered deterministic, the following must be true:

• two values that compare as equal (via Object.equals() or Comparable.compareTo(), if supported) have the same encoding.
• the 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.

Specified by:

verifyDeterministic in class Coder<FileIO.ReadableFile>

Throws:

Coder.NonDeterministicException - if this coder is not deterministic.