org.broadinstitute.hellbender.tools.spark.sv.evidence

Class ReadMetadata.Serializer

java.lang.Object

com.esotericsoftware.kryo.Serializer<ReadMetadata>

org.broadinstitute.hellbender.tools.spark.sv.evidence.ReadMetadata.Serializer

Enclosing class:

ReadMetadata

public static final class ReadMetadata.Serializer
extends com.esotericsoftware.kryo.Serializer<ReadMetadata>

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	MAGIC_STRING Placed at the beginning of each standalone serialization of the meta-data identifies file that most likely are valid serializations.
static java.lang.String	VERSION_STRING Serialization version.

Constructor Summary

Constructors

Constructor and Description
Serializer()

Method Summary

Modifier and Type	Method and Description
ReadMetadata	read(com.esotericsoftware.kryo.Kryo kryo, com.esotericsoftware.kryo.io.Input input, java.lang.Class<ReadMetadata> klass)
static ReadMetadata	readStandalone(java.lang.String whereFrom) Reads a read-metadata from a file or resource.
void	write(com.esotericsoftware.kryo.Kryo kryo, com.esotericsoftware.kryo.io.Output output, ReadMetadata readMetadata)
static void	writeStandalone(ReadMetadata meta, java.lang.String whereTo) Serializes a read-metadata by itself into a file.

Methods inherited from class com.esotericsoftware.kryo.Serializer

copy, getAcceptsNull, isImmutable, setAcceptsNull, setGenerics, setImmutable

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

MAGIC_STRING

public static final java.lang.String MAGIC_STRING

Placed at the beginning of each standalone serialization of the meta-data identifies file that most likely are valid serializations.

Is not a 100% guarantee as one construct an invalid file that contains, but is extremely-unlikely to be accidental.

See Also:

Constant Field Values

VERSION_STRING

public static final java.lang.String VERSION_STRING

Serialization version.

This follows the MAGIC_STRING in the serialization file indicating the format version.

This number/string should be change every time the serialization format changes so that we can catch incompatible deserialization early.

See Also:

Constant Field Values

Constructor Detail

Serializer

public Serializer()

Method Detail

write

public void write(com.esotericsoftware.kryo.Kryo kryo,
                  com.esotericsoftware.kryo.io.Output output,
                  ReadMetadata readMetadata)

Specified by:

write in class com.esotericsoftware.kryo.Serializer<ReadMetadata>

read

public ReadMetadata read(com.esotericsoftware.kryo.Kryo kryo,
                         com.esotericsoftware.kryo.io.Input input,
                         java.lang.Class<ReadMetadata> klass)

Specified by:

read in class com.esotericsoftware.kryo.Serializer<ReadMetadata>

writeStandalone

public static void writeStandalone(ReadMetadata meta,
                                   java.lang.String whereTo)

Serializes a read-metadata by itself into a file.

Parameters:

meta - the read-metadata to serialize.

whereTo - the name of the file or resource where it will go to.

Throws:

java.lang.IllegalArgumentException - if either meta or whereTo is null.

UserException - if there was a problem during serialization.

readStandalone

public static ReadMetadata readStandalone(java.lang.String whereFrom)

Reads a read-metadata from a file or resource.

Parameters:

whereFrom - the file or resource containing the read-metadata.

Returns:

never null.

Throws:

java.lang.IllegalArgumentException - if whereFrom is null.

UserException - if any problem occurred where deserializing.