public class ReadableFileCoder extends StructuredCoder<FileIO.ReadableFile>
Coder
for FileIO.ReadableFile
.Coder.Context, Coder.NonDeterministicException
Modifier and Type | Method and Description |
---|---|
FileIO.ReadableFile |
decode(@UnknownKeyFor @NonNull @Initialized java.io.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 java.io.OutputStream outStream)
Encodes the given value of type
T onto the given output stream. |
@UnknownKeyFor @NonNull @Initialized java.util.List<? extends Coder<?>> |
getCoderArguments()
|
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. |
equals, getComponents, hashCode, toString
consistentWithEquals, decode, encode, getEncodedElementByteSize, getEncodedTypeDescriptor, isRegisterByteSizeObserverCheap, registerByteSizeObserver, structuralValue, verifyDeterministic, verifyDeterministic
public static ReadableFileCoder of(Coder<MatchResult.Metadata> metadataCoder)
public static ReadableFileCoder of()
public Coder<MatchResult.Metadata> getMetadataCoder()
public void encode(FileIO.ReadableFile value, @UnknownKeyFor @NonNull @Initialized java.io.OutputStream outStream) throws CoderException, java.io.IOException
Coder
T
onto the given output stream.encode
in class Coder<FileIO.ReadableFile>
CoderException
- if the value could not be encoded for some reasonjava.io.IOException
- if writing to the OutputStream
fails for some reasonpublic FileIO.ReadableFile decode(@UnknownKeyFor @NonNull @Initialized java.io.InputStream inStream) throws CoderException, java.io.IOException
Coder
T
from the given input stream in the given context. Returns the
decoded value.decode
in class Coder<FileIO.ReadableFile>
CoderException
- if the value could not be decoded for some reasonjava.io.IOException
- if reading from the InputStream
fails for some reasonpublic @UnknownKeyFor @NonNull @Initialized java.util.List<? extends Coder<?>> getCoderArguments()
Coder
Coder
for a parameterized type, returns the list of Coder
s 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.getCoderArguments
in class Coder<FileIO.ReadableFile>
public void verifyDeterministic() throws Coder.NonDeterministicException
Coder
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.
verifyDeterministic
in class Coder<FileIO.ReadableFile>
Coder.NonDeterministicException
- if this coder is not deterministic.