htsjdk.samtools.metrics

Class VersionHeader

java.lang.Object

htsjdk.samtools.metrics.VersionHeader

All Implemented Interfaces:

Header

public class VersionHeader
extends java.lang.Object
implements Header

Header that stores information about the version of some piece of software or data used to create the metrics file. Payload consists of a name or description of the versioned item and a version string.

Constructor Summary

Constructors

Constructor and Description
VersionHeader()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o) Equals method that checks that both the item and version string are equal.
java.lang.String	getVersionedItem()
java.lang.String	getVersionString()
int	hashCode()
void	parse(java.lang.String in) Parses the data contained in the String version of the header.
void	setVersionedItem(java.lang.String versionedItem)
void	setVersionString(java.lang.String versionString)
java.lang.String	toString() Converts the header to a String for persisting to a file.

Methods inherited from class java.lang.Object

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

Constructor Detail

VersionHeader

public VersionHeader()

Method Detail

parse

public void parse(java.lang.String in)

Description copied from interface: Header

Parses the data contained in the String version of the header.

Specified by:

parse in interface Header

toString

public java.lang.String toString()

Description copied from interface: Header

Converts the header to a String for persisting to a file.

Specified by:

toString in interface Header

Overrides:

toString in class java.lang.Object

getVersionedItem

public java.lang.String getVersionedItem()

setVersionedItem

public void setVersionedItem(java.lang.String versionedItem)

getVersionString

public java.lang.String getVersionString()

setVersionString

public void setVersionString(java.lang.String versionString)

equals

public boolean equals(java.lang.Object o)

Equals method that checks that both the item and version string are equal.

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object