Package util

Record Class Bio.ReferenceContext

java.lang.Object
java.lang.Record
util.Bio.ReferenceContext
Record Components:
character - The nucleotide or aminoacid character at the position.
extension - The maximal observed insertion length (extension) for the position.
Enclosing class:
Bio
public static record Bio.ReferenceContext(char character, int extension) extends Record
Represents information about a single position in a reference sequence.

This record stores the nucleotide or aminoacid character at a specific position and the maximum insertion length (extension) associated with a set of samples. The position itself and the samples are not stored.

  • Constructor Summary

    Constructors
    Constructor
    Description
    ReferenceContext(char character, int extension)
    Creates an instance of a ReferenceContext record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    char
    character()
    Returns the value of the character record component.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    int
    extension()
    Returns the value of the extension record component.
    final int
    hashCode()
    Returns a hash code value for this object.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • ReferenceContext

      public ReferenceContext(char character, int extension)
      Creates an instance of a ReferenceContext record class.
      Parameters:
      character - the value for the character record component
      extension - the value for the extension record component

  • Method Details

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with '=='.
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • character

      public char character()
      Returns the value of the character record component.
      Returns:
      the value of the character record component

    • extension

      public int extension()
      Returns the value of the extension record component.
      Returns:
      the value of the extension record component