htsjdk.variant.bcf2

Class BCFVersion

java.lang.Object

htsjdk.variant.bcf2.BCFVersion

public class BCFVersion
extends java.lang.Object

Simple holder for BCF version information User: depristo Date: 8/2/12 Time: 2:16 PM

Field Summary

Fields

Modifier and Type	Field and Description
static byte[]	MAGIC_HEADER_START BCF2 begins with the MAGIC info BCF_M_m where M is the major version (currently 2) and m is the minor version, currently 1

Constructor Summary

Constructors

Constructor and Description
BCFVersion(int majorVersion, int minorVersion)

Method Summary

Modifier and Type	Method and Description
int	getMajorVersion()
int	getMinorVersion()
static BCFVersion	readBCFVersion(java.io.InputStream stream) Return a new BCFVersion object describing the major and minor version of the BCF file in stream Note that stream must be at the very start of the file.
java.lang.String	toString()
void	write(java.io.OutputStream out) Write out the BCF magic information indicating this is a BCF file with corresponding major and minor versions

Methods inherited from class java.lang.Object

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

Field Detail

MAGIC_HEADER_START

public static final byte[] MAGIC_HEADER_START

BCF2 begins with the MAGIC info BCF_M_m where M is the major version (currently 2) and m is the minor version, currently 1

Constructor Detail

BCFVersion

public BCFVersion(int majorVersion,
                  int minorVersion)

Method Detail

getMajorVersion

public int getMajorVersion()

Returns:

the major version number of this BCF file

getMinorVersion

public int getMinorVersion()

Returns:

the minor version number of this BCF file

readBCFVersion

public static BCFVersion readBCFVersion(java.io.InputStream stream)
                                 throws java.io.IOException

Return a new BCFVersion object describing the major and minor version of the BCF file in stream Note that stream must be at the very start of the file.

Parameters:

stream -

Returns:

a BCFVersion object, or null if stream doesn't contain a BCF file

Throws:

java.io.IOException

write

public void write(java.io.OutputStream out)
           throws java.io.IOException

Write out the BCF magic information indicating this is a BCF file with corresponding major and minor versions

Parameters:

out -

Throws:

java.io.IOException

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object