Package htsjdk.tribble.IntervalList
Class IntervalListCodec
- All Implemented Interfaces:
FeatureCodec<Interval,LineIterator>
A tribble codec for IntervalLists.
Also contains the parsing code for the non-tribble parsing of IntervalLists
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbooleanThis function returns true iff the File potentialInput can be parsed by this codec.readActualHeader(LineIterator lineIterator) Read and return the header, or null if there is no header.Methods inherited from class htsjdk.tribble.AsciiFeatureCodec
close, decode, isDone, makeIndexableSourceFromStream, makeSourceFromStream, readHeaderMethods inherited from class htsjdk.tribble.AbstractFeatureCodec
decodeLoc, getFeatureTypeMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface htsjdk.tribble.FeatureCodec
getPathToDataFile, getTabixFormat
-
Constructor Details
-
IntervalListCodec
public IntervalListCodec() -
IntervalListCodec
-
-
Method Details
-
decode
- Specified by:
decodein classAsciiFeatureCodec<Interval>- See Also:
-
readActualHeader
Description copied from class:AsciiFeatureCodecRead and return the header, or null if there is no header.- Specified by:
readActualHeaderin classAsciiFeatureCodec<Interval>- Returns:
- the actual header data in the file, or null if none is available
-
canDecode
Description copied from interface:FeatureCodecThis function returns true iff the File potentialInput can be parsed by this codec. Note that checking the file's extension is a perfectly acceptable implementation of this method and file contents only rarely need to be checked.
There is an assumption that there's never a situation where two different Codecs return true for the same file. If this occurs, the recommendation would be to error out.
Note this function must never throw an error. All errors should be trapped and false returned.- Parameters:
s- the file to test for parsability with this codec- Returns:
- true if potentialInput can be parsed, false otherwise
-