Package jgromacs.db

Class ResidueType

  • All Implemented Interfaces:
    java.lang.Cloneable
    public class ResidueType
extends java.lang.Object
implements java.lang.Cloneable
    Objects of this class represent a residue type

    • Constructor Summary

      Constructors 
      Constructor Description
      ResidueType()
      Constructs a new ResidueType object
      ResidueType​(int type)
      Constructs a new ResidueType object of a given type
      ResidueType​(java.lang.String code)
      Constructs a new ResidueType object of given code

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.Object clone()
      Returns an identical ResidueType object
      boolean equals​(java.lang.Object other)
      Returns true if the two residue types are identical
      java.lang.String get1LetterCode()
      Returns 1 letter code of residue type
      java.lang.String get3LetterCode()
      Returns 3 letter code of residue type
      java.lang.String getFullName()
      Returns full name of residue type
      int hashCode()
      Returns hash code
      boolean isAminoAcid()
      Returns true if it is an amino acid (not water or else)
      boolean isOther()
      Returns true if it is not an amino acid nor water
      boolean isWater()
      Returns true if it is water (not amino acid or else)
      java.lang.String toString()
      Returns the String representation of residue type

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • ResidueType

        public ResidueType()
        Constructs a new ResidueType object

      • ResidueType

        public ResidueType​(int type)
        Constructs a new ResidueType object of a given type
        Parameters:
        type - residue type

      • ResidueType

        public ResidueType​(java.lang.String code)
        Constructs a new ResidueType object of given code
        Parameters:
        code - residue code

    • Method Detail

      • get1LetterCode

        public java.lang.String get1LetterCode()
        Returns 1 letter code of residue type
        Returns:
        residue code

      • get3LetterCode

        public java.lang.String get3LetterCode()
        Returns 3 letter code of residue type
        Returns:
        residue code

      • getFullName

        public java.lang.String getFullName()
        Returns full name of residue type
        Returns:
        residue name

      • isAminoAcid

        public boolean isAminoAcid()
        Returns true if it is an amino acid (not water or else)

      • isWater

        public boolean isWater()
        Returns true if it is water (not amino acid or else)

      • isOther

        public boolean isOther()
        Returns true if it is not an amino acid nor water

      • toString

        public java.lang.String toString()
        Returns the String representation of residue type
        Overrides:
        toString in class java.lang.Object
        Returns:
        String representation

      • clone

        public java.lang.Object clone()
        Returns an identical ResidueType object
        Overrides:
        clone in class java.lang.Object
        Returns:
        clone of the residue type

      • equals

        public boolean equals​(java.lang.Object other)
        Returns true if the two residue types are identical
        Overrides:
        equals in class java.lang.Object
        Parameters:
        other - the other residue type

      • hashCode

        public int hashCode()
        Returns hash code
        Overrides:
        hashCode in class java.lang.Object