Interface ChainNumberICode

All Superinterfaces:
Comparable<ChainNumberICode>, Serializable
All Known Subinterfaces:
PdbResidue
All Known Implementing Classes:
DefaultPdbResidue, ImmutableDefaultPdbResidue, ImmutablePdbAtomLine, ImmutablePdbModresLine, ImmutablePdbNamedResidueIdentifier, ImmutablePdbRemark465Line, ImmutablePdbResidueIdentifier, PdbAtomLine, PdbModresLine, PdbNamedResidueIdentifier, PdbRemark465Line, PdbResidueIdentifier

public interface ChainNumberICode extends Comparable<ChainNumberICode>, Serializable
A set of methods that allow to address a residue by its chain name, residue number and insertion code.
  • Method Details

    • chainIdentifier

      String chainIdentifier()
      Returns:
      The identifier of the chain a residue belongs to.
    • residueNumber

      int residueNumber()
      Returns:
      The number of a residue in the chain.
    • insertionCode

      Optional<String> insertionCode()
      Returns:
      Optional insertion code, used in some PDB and mmCIF files to represent "inserted" residues while maintaining the original numbering.
    • compareTo

      default int compareTo(ChainNumberICode t)
      Specified by:
      compareTo in interface Comparable<ChainNumberICode>