htsjdk.samtools.metrics

Class StringHeader

java.lang.Object

htsjdk.samtools.metrics.StringHeader

All Implemented Interfaces:

Header, java.io.Serializable

public class StringHeader
extends java.lang.Object
implements Header

A simple header who's data type is a single String. Should not be used for anything other than comments or descriptive text.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
StringHeader() Default constructor.
StringHeader(java.lang.String value) Constructor that uses the supplied value as the value of the header.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o) Checks equality on the value of the header.
java.lang.String	getValue()
int	hashCode()
void	parse(java.lang.String in) Parses the data contained in the String version of the header.
void	setValue(java.lang.String value)
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

StringHeader

public StringHeader()

Default constructor.

StringHeader

public StringHeader(java.lang.String value)

Constructor that uses the supplied value as the value of the header.

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

getValue

public java.lang.String getValue()

setValue

public void setValue(java.lang.String value)

equals

public boolean equals(java.lang.Object o)

Checks equality on the value of the header.

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object