Package htsjdk.variant.vcf
Class VCFHeaderLine
java.lang.Object
htsjdk.variant.vcf.VCFHeaderLine
- All Implemented Interfaces:
Serializable
,Comparable
- Direct Known Subclasses:
VCFCompoundHeaderLine
,VCFSimpleHeaderLine
- See Also:
-
Field Summary
Modifier and TypeFieldDescriptionprotected static final boolean
static final long
protected static final String
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionint
boolean
getKey()
Get the keygetValue()
Get the valueint
hashCode()
static boolean
isHeaderLine
(String line) boolean
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)toString()
protected String
Should be overloaded in sub classes to do subclass specificstatic String
toStringEncoding
(Map<String, ? extends Object> keyValues) create a string of a mapping pair for the target VCF version
-
Field Details
-
serialVersionUID
public static final long serialVersionUID- See Also:
-
ALLOW_UNBOUND_DESCRIPTIONS
protected static final boolean ALLOW_UNBOUND_DESCRIPTIONS- See Also:
-
UNBOUND_DESCRIPTION
- See Also:
-
-
Constructor Details
-
VCFHeaderLine
create a VCF header line- Parameters:
key
- the key for this header linevalue
- the value for this header line
-
-
Method Details
-
getKey
Get the key- Returns:
- the key
-
getValue
Get the value- Returns:
- the value
-
shouldBeAddedToDictionary
public 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)- Returns:
- false
-
toString
-
toStringEncoding
Should be overloaded in sub classes to do subclass specific- Returns:
- the string encoding
-
equals
-
hashCode
public int hashCode() -
compareTo
- Specified by:
compareTo
in interfaceComparable
-
isHeaderLine
- Parameters:
line
- the line- Returns:
- true if the line is a VCF meta data line, or false if it is not
-
toStringEncoding
create a string of a mapping pair for the target VCF version- Parameters:
keyValues
- a mapping of the key->value pairs to output- Returns:
- a string, correctly formatted
-