public class VCFHeaderLine
extends java.lang.Object
implements java.lang.Comparable, java.io.Serializable
Modifier and Type | Field and Description |
---|---|
protected static boolean |
ALLOW_UNBOUND_DESCRIPTIONS |
static long |
serialVersionUID |
protected static java.lang.String |
UNBOUND_DESCRIPTION |
Constructor and Description |
---|
VCFHeaderLine(java.lang.String key,
java.lang.String value)
create a VCF header line
|
Modifier and Type | Method and Description |
---|---|
int |
compareTo(java.lang.Object other) |
boolean |
equals(java.lang.Object o) |
java.lang.String |
getKey()
Get the key
|
java.lang.String |
getValue()
Get the value
|
int |
hashCode() |
static boolean |
isHeaderLine(java.lang.String line) |
boolean |
shouldBeAddedToDictionary()
By default the header lines won't be added to the dictionary, unless this method will be override (for example in FORMAT, INFO or FILTER header lines)
|
java.lang.String |
toString() |
protected java.lang.String |
toStringEncoding()
Should be overloaded in sub classes to do subclass specific
|
static java.lang.String |
toStringEncoding(java.util.Map<java.lang.String,? extends java.lang.Object> keyValues)
create a string of a mapping pair for the target VCF version
|
public static final long serialVersionUID
protected static final boolean ALLOW_UNBOUND_DESCRIPTIONS
protected static final java.lang.String UNBOUND_DESCRIPTION
public VCFHeaderLine(java.lang.String key, java.lang.String value)
key
- the key for this header linevalue
- the value for this header linepublic java.lang.String getKey()
public java.lang.String getValue()
public boolean shouldBeAddedToDictionary()
public java.lang.String toString()
toString
in class java.lang.Object
protected java.lang.String toStringEncoding()
public boolean equals(java.lang.Object o)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
public int compareTo(java.lang.Object other)
compareTo
in interface java.lang.Comparable
public static boolean isHeaderLine(java.lang.String line)
line
- the linepublic static java.lang.String toStringEncoding(java.util.Map<java.lang.String,? extends java.lang.Object> keyValues)
keyValues
- a mapping of the key->value pairs to output