Package htsjdk.samtools.util
Interface SortingCollection.Codec<T>
- All Superinterfaces:
Cloneable
- All Known Implementing Classes:
BAMRecordCodec
,IntervalCodec
,VCFRecordCodec
- Enclosing class:
- SortingCollection<T>
Client must implement this class, which defines the way in which records are written to and
read from file.
-
Method Summary
Modifier and TypeMethodDescriptionclone()
Must return a cloned copy of the codec that can be used independently of the original instance.decode()
Read the next record from the input stream and convert into a java object.void
Write object to output streamvoid
Where to read encoded input fromvoid
Where to write encoded output
-
Method Details
-
setOutputStream
Where to write encoded output -
setInputStream
Where to read encoded input from -
encode
Write object to output stream- Parameters:
val
- what to write
-
decode
T decode()Read the next record from the input stream and convert into a java object.- Returns:
- null if no more records. Should throw exception if EOF is encountered in the middle of a record.
-
clone
SortingCollection.Codec<T> clone()Must return a cloned copy of the codec that can be used independently of the original instance. This is required so that multiple codecs can exist simultaneously that each is reading a separate file.
-