public class VCFHeaderLine extends Object implements Comparable, Serializable
Class VCFHeaderLine
A class representing a key=value entry in the VCF header
Modifier and Type | Field and Description |
---|---|
protected static boolean |
ALLOW_UNBOUND_DESCRIPTIONS |
static long |
serialVersionUID |
protected static String |
UNBOUND_DESCRIPTION |
Constructor and Description |
---|
VCFHeaderLine(String key,
String value)
create a VCF header line
|
Modifier and Type | Method and Description |
---|---|
int |
compareTo(Object other) |
boolean |
equals(Object o) |
String |
getKey()
Get the key
|
String |
getValue()
Get the value
|
int |
hashCode() |
static boolean |
isHeaderLine(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)
|
String |
toString() |
protected String |
toStringEncoding()
Should be overloaded in sub classes to do subclass specific
|
static String |
toStringEncoding(Map<String,? extends 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 String UNBOUND_DESCRIPTION
public String getKey()
public String getValue()
public boolean shouldBeAddedToDictionary()
protected String toStringEncoding()
public int compareTo(Object other)
compareTo
in interface Comparable
public static boolean isHeaderLine(String line)
line
- the line