Package org.biojava.nbio.structure

Enum Class ExperimentalTechnique

java.lang.Object
java.lang.Enum<ExperimentalTechnique>
org.biojava.nbio.structure.ExperimentalTechnique
All Implemented Interfaces:
Serializable, Comparable<ExperimentalTechnique>, Constable
public enum ExperimentalTechnique extends Enum<ExperimentalTechnique>
An enum to represent the experimental technique of a PDB structure
Author:
duarte_j

  • Enum Constant Details

  • Method Details

    • values

      public static ExperimentalTechnique[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static ExperimentalTechnique valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null

    • getName

      public String getName()

    • isCrystallographic

      public boolean isCrystallographic()

    • isNmr

      public boolean isNmr()

    • getByName

      public static ExperimentalTechnique getByName(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(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:
      NullPointerException - if input is null

    • isNmr

      public static boolean isNmr(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:
      NullPointerException - if input is null

    • toString

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