Package htsjdk.tribble
Class BinaryFeatureCodec<T extends Feature>
- java.lang.Object
-
- htsjdk.tribble.BinaryFeatureCodec<T>
-
- All Implemented Interfaces:
FeatureCodec<T,PositionalBufferedStream>
- Direct Known Subclasses:
BCF2Codec,ExampleBinaryCodec
public abstract class BinaryFeatureCodec<T extends Feature> extends Object implements FeatureCodec<T,PositionalBufferedStream>
Implements common methods ofFeatureCodecs that read fromPositionalBufferedStreams.
-
-
Constructor Summary
Constructors Constructor Description BinaryFeatureCodec()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidclose(PositionalBufferedStream source)Adapter method that closes the providedFeatureCodec.TabixFormatgetTabixFormat()Marked as final because binary features could not be tabix indexedbooleanisDone(PositionalBufferedStream source)Adapter method that assesses whether the providedFeatureCodechas more data.LocationAwaremakeIndexableSourceFromStream(InputStream bufferedInputStream)PositionalBufferedStreamis alreadyLocationAware.PositionalBufferedStreammakeSourceFromStream(InputStream bufferedInputStream)Generates a reader of typeFeatureCodecappropriate for use by this codec from the generic input stream.-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface htsjdk.tribble.FeatureCodec
canDecode, decode, decodeLoc, getFeatureType, getPathToDataFile, readHeader
-
-
-
-
Method Detail
-
makeSourceFromStream
public PositionalBufferedStream makeSourceFromStream(InputStream bufferedInputStream)
Description copied from interface:FeatureCodecGenerates a reader of typeFeatureCodecappropriate for use by this codec from the generic input stream. Implementers should assume the stream is buffered.- Specified by:
makeSourceFromStreamin interfaceFeatureCodec<T extends Feature,PositionalBufferedStream>
-
makeIndexableSourceFromStream
public LocationAware makeIndexableSourceFromStream(InputStream bufferedInputStream)
PositionalBufferedStreamis alreadyLocationAware.- Specified by:
makeIndexableSourceFromStreamin interfaceFeatureCodec<T extends Feature,PositionalBufferedStream>
-
close
public void close(PositionalBufferedStream source)
Description copied from interface:FeatureCodecAdapter method that closes the providedFeatureCodec.- Specified by:
closein interfaceFeatureCodec<T extends Feature,PositionalBufferedStream>
-
isDone
public boolean isDone(PositionalBufferedStream source)
Description copied from interface:FeatureCodecAdapter method that assesses whether the providedFeatureCodechas more data. True if it does, false otherwise.- Specified by:
isDonein interfaceFeatureCodec<T extends Feature,PositionalBufferedStream>
-
getTabixFormat
public final TabixFormat getTabixFormat()
Marked as final because binary features could not be tabix indexed- Specified by:
getTabixFormatin interfaceFeatureCodec<T extends Feature,PositionalBufferedStream>- Returns:
- the format to use with tabix
-
-