Enum ExperimentalTechnique

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<ExperimentalTechnique>

    public enum ExperimentalTechnique
    extends java.lang.Enum<ExperimentalTechnique>
    An enum to represent the experimental technique of a PDB structure
    Author:
    duarte_j
    • Method Detail

      • values

        public static ExperimentalTechnique[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
        for (ExperimentalTechnique c : ExperimentalTechnique.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared
      • valueOf

        public static ExperimentalTechnique valueOf​(java.lang.String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null
      • getName

        public java.lang.String getName()
      • isCrystallographic

        public boolean isCrystallographic()
      • isNmr

        public boolean isNmr()
      • getByName

        public static ExperimentalTechnique getByName​(java.lang.String expTechniqueName)
        Returns the ExpTechnique given an experimental technique name as used in the PDB, e.g. "X-RAY DIFFRACTION" returns XRAY_DIFFRACTION
        Parameters:
        expTechniqueName - the ExpTechnique value or null if string doesn't match one of the known PDB experimental strings
        Returns:
      • isCrystallographic

        public static boolean isCrystallographic​(java.util.Set<ExperimentalTechnique> techniques)
        Given a Set of ExperimentalTechniques returns true if at least one is crystallographic
        Returns:
        true if at least 1 of the techniques is crystallographic, false if none of the techniques are crystallographic
        Throws:
        java.lang.NullPointerException - if input is null
      • isNmr

        public static boolean isNmr​(java.util.Set<ExperimentalTechnique> techniques)
        Given a Set of ExperimentalTechniques returns true if at least one is NMR
        Returns:
        true if at least 1 of the techniques is NMR, false if none of the techniques are NMR
        Throws:
        java.lang.NullPointerException - if input is null
      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Enum<ExperimentalTechnique>