htsjdk.beta.plugin

Class HtsVersion

java.lang.Object

htsjdk.beta.plugin.HtsVersion

All Implemented Interfaces:

java.lang.Comparable<HtsVersion>

public class HtsVersion
extends java.lang.Object
implements java.lang.Comparable<HtsVersion>

A class for representing 3-part versions with major, minor and patch segments. Used by HtsCodec, HtsEncoder and HtsDecoder for HTS file format and codec versions.

Field Summary

Fields

Modifier and Type	Field and Description
static HtsVersion	NEWEST_VERSION Sentinel constant used to indicate the newest version available

Constructor Summary

Constructors

Constructor and Description
HtsVersion(int major, int minor, int patch) Construct a 3 part version number.
HtsVersion(java.lang.String versionString) Construct a 3 part version number from a string withe the format major.minor.patch, where each of major/minor/patch is an integer.

Method Summary

Modifier and Type	Method and Description
int	compareTo(HtsVersion o)
boolean	equals(java.lang.Object o)
int	getMajorVersion() Get the major version integer for this version.
int	getMinorVersion() Get the minor version integer for this version.
int	getPatchVersion() Get the patch version integer for this version.
int	hashCode()
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

NEWEST_VERSION

public static final HtsVersion NEWEST_VERSION

Sentinel constant used to indicate the newest version available

Constructor Detail

HtsVersion

public HtsVersion(int major,
                  int minor,
                  int patch)

Construct a 3 part version number.

Parameters:

major - major version number

minor - minor version number

patch - patch number

HtsVersion

public HtsVersion(java.lang.String versionString)

Construct a 3 part version number from a string withe the format major.minor.patch, where each of major/minor/patch is an integer.

Parameters:

versionString - the version string from which to construct this version

Method Detail

getMajorVersion

public int getMajorVersion()

Get the major version integer for this version.

Returns:

the major version integer for this version

getMinorVersion

public int getMinorVersion()

Get the minor version integer for this version.

Returns:

the minor version integer for this version

getPatchVersion

public int getPatchVersion()

Get the patch version integer for this version.

Returns:

the patch version integer for this version

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

compareTo

public int compareTo(HtsVersion o)

Specified by:

compareTo in interface java.lang.Comparable<HtsVersion>