Package vcf

Class VcfMetaInfo

java.lang.Object
vcf.VcfMetaInfo
public final class VcfMetaInfo extends Object

Class VcfMetaInfo represents a VCF meta-information line.

Instances of class VcfMetaInfo are immutable.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final char
    DELIMITER
    The VCF meta-information line key-value delimiter: '='
    static final String
    PREFIX
    The VCF meta-information line prefix: "##"

  • Constructor Summary

    Constructors
    Constructor
    Description
    VcfMetaInfo(String line)
    Constructs a VcfMetaInfo instance representing the specified VCF meta-information line.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    key()
    Returns the VCF meta-information line key.
    String
    toString()
    Returns the VCF meta-information line represented by this.
    String
    value()
    Returns the VCF meta-information line value.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

  • Field Details

    • PREFIX

      public static final String PREFIX
      The VCF meta-information line prefix: "##"
      See Also:

    • DELIMITER

      public static final char DELIMITER
      The VCF meta-information line key-value delimiter: '='
      See Also:

  • Constructor Details

    • VcfMetaInfo

      public VcfMetaInfo(String line)
      Constructs a VcfMetaInfo instance representing the specified VCF meta-information line.
      Parameters:
      line - a VCF meta-information line
      Throws:
      IllegalArgumentException - if the specified information line, after removing any beginning and ending white-space, does not begin with VcfMetaInfo.PREFIX, and does not contain non-empty key and value strings separated by the VcfMetaInfo.DELIMITER character
      NullPointerException - if line == null

  • Method Details

    • key

      public String key()
      Returns the VCF meta-information line key.
      Returns:
      the VCF meta-information line key

    • value

      public String value()
      Returns the VCF meta-information line value.
      Returns:
      the VCF meta-information line value

    • toString

      public String toString()
      Returns the VCF meta-information line represented by this.
      Overrides:
      toString in class Object
      Returns:
      the VCF meta-information line represented by this