Package vcf

Class VcfMetaInfo

  • public final class VcfMetaInfo
extends java.lang.Object

    Class VcfMetaInfo represents a VCF meta-information line.

    Instances of class VcfMetaInfo are immutable.

    • Field Summary

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

    • Constructor Summary

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

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String key()
      Returns the VCF meta-information line key.
      java.lang.String toString()
      Returns the VCF meta-information line represented by this.
      java.lang.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 Detail

      • PREFIX

        public static final java.lang.String PREFIX
        The VCF meta-information line prefix: "##"
        See Also:
        Constant Field Values

      • DELIMITER

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

    • Constructor Detail

      • VcfMetaInfo

        public VcfMetaInfo​(java.lang.String line)
        Constructs a VcfMetaInfo instance representing the specified VCF meta-information line.
        Parameters:
        line - a VCF meta-information line
        Throws:
        java.lang.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
        java.lang.NullPointerException - if line == null

    • Method Detail

      • key

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

      • value

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

      • toString

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