htsjdk.variant.vcf

Class VCFFormatHeaderLine

java.lang.Object

htsjdk.variant.vcf.VCFHeaderLine

htsjdk.variant.vcf.VCFCompoundHeaderLine

htsjdk.variant.vcf.VCFFormatHeaderLine

All Implemented Interfaces:

VCFIDHeaderLine, java.io.Serializable, java.lang.Comparable

public class VCFFormatHeaderLine
extends VCFCompoundHeaderLine

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class htsjdk.variant.vcf.VCFCompoundHeaderLine

VCFCompoundHeaderLine.SupportedHeaderLineType

Field Summary

Fields inherited from class htsjdk.variant.vcf.VCFHeaderLine

ALLOW_UNBOUND_DESCRIPTIONS, serialVersionUID, UNBOUND_DESCRIPTION

Constructor Summary

Constructors

Constructor and Description
VCFFormatHeaderLine(java.lang.String name, int count, VCFHeaderLineType type, java.lang.String description)
VCFFormatHeaderLine(java.lang.String name, VCFHeaderLineCount count, VCFHeaderLineType type, java.lang.String description)
VCFFormatHeaderLine(java.lang.String line, VCFHeaderVersion version)

Method Summary

Modifier and Type	Method and Description
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)

Methods inherited from class htsjdk.variant.vcf.VCFCompoundHeaderLine

equals, equalsExcludingDescription, getCount, getCount, getCountType, getDescription, getID, getType, hashCode, isFixedCount, sameLineTypeAndName, setNumberToUnbounded, toStringEncoding

Methods inherited from class htsjdk.variant.vcf.VCFHeaderLine

compareTo, getKey, getValue, isHeaderLine, toString, toStringEncoding

Methods inherited from class java.lang.Object

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

Constructor Detail

VCFFormatHeaderLine

public VCFFormatHeaderLine(java.lang.String name,
                           int count,
                           VCFHeaderLineType type,
                           java.lang.String description)

VCFFormatHeaderLine

public VCFFormatHeaderLine(java.lang.String name,
                           VCFHeaderLineCount count,
                           VCFHeaderLineType type,
                           java.lang.String description)

VCFFormatHeaderLine

public VCFFormatHeaderLine(java.lang.String line,
                           VCFHeaderVersion version)

Method Detail

shouldBeAddedToDictionary

public boolean shouldBeAddedToDictionary()

Description copied from class: VCFHeaderLine

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)

Overrides:

shouldBeAddedToDictionary in class VCFHeaderLine

Returns:

false