Enum Class Aromatizer

java.lang.Object
java.lang.Enum<Aromatizer>
com.chemaxon.search.transformation.transformers.Aromatizer
All Implemented Interfaces:
com.chemaxon.search.transformation.AromatizationDataProvider, Transformer, Serializable, Comparable<Aromatizer>, java.lang.constant.Constable

@PublicAPI public enum Aromatizer extends Enum<Aromatizer> implements Transformer, com.chemaxon.search.transformation.AromatizationDataProvider
Aromatizer transformer. Performs aromatization according to the specified method.
Since:
JChem 5.12
  • Enum Constant Details

  • Field Details

    • IDENTITY

      public static final Aromatizer IDENTITY
      Identity transformer.
  • Method Details

    • values

      public static Aromatizer[] 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 Aromatizer 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
    • getAromatizationMethod

      public com.chemaxon.search.AromatizationMethod getAromatizationMethod()
      Specified by:
      getAromatizationMethod in interface com.chemaxon.search.transformation.AromatizationDataProvider
    • transform

      public com.chemaxon.search.transformation.AtomIndexMapper transform(Molecule m)
      Description copied from interface: Transformer

      Transforms a Molecule. The molecule object is changed during the transformation, the mappings between old and new atom indexes are returned by the transformation.

      TODO: revise this interface, do we really want to force implementations to change the input molecule rather than return a one?
      Specified by:
      transform in interface Transformer
      Parameters:
      m - the molecule
      Returns:
      AtomIndexMapper between old and new atom indexes
    • fromMethod

      public static Aromatizer fromMethod(com.chemaxon.search.AromatizationMethod method)
      Gets the aromatizer-transformer corresponding to the specified aromatization method
      Parameters:
      method - the specified aromatization method.
      Returns:
      returns an Aromatizer corresponding to the specified aromatization method