Class VCFHeaderLine

    • Constructor Detail

      • VCFHeaderLine

        public VCFHeaderLine​(String key,
                             String value)
        create a VCF header line
        Parameters:
        key - the key for this header line
        value - the value for this header line
    • Method Detail

      • getKey

        public String getKey()
        Get the key
        Returns:
        the key
      • getValue

        public String 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
      • toStringEncoding

        protected String toStringEncoding()
        Should be overloaded in sub classes to do subclass specific
        Returns:
        the string encoding
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object
      • isHeaderLine

        public static boolean isHeaderLine​(String line)
        Parameters:
        line - the line
        Returns:
        true if the line is a VCF meta data line, or false if it is not
      • toStringEncoding

        public static String toStringEncoding​(Map<String,​? extends Object> keyValues)
        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