Enum Class AnnotationId

java.lang.Object
java.lang.Enum<AnnotationId>
io.github.cvc5.AnnotationId
All Implemented Interfaces:
Serializable, Comparable<AnnotationId>, Constable

public enum AnnotationId extends Enum<AnnotationId>
Enum representing the set of possible values for AnnotationId.
  • Enum Constant Details

    • NONE

      public static final AnnotationId NONE
      This enumeration represents the kinds of annotations that may appear in proofs. This enumeration is used as the first argument to the ANNOTATE <cvc5.ProofRule.ANNOTATE> proof rule.
      Note:
      This enumeration is experimental and may change in future versions.
    • THEORY_LEMMA

      public static final AnnotationId THEORY_LEMMA
      Theory lemma Annotates the proof of a lemma sent by a theory. The second argument of the ANNOTATE <cvc5.ProofRule.ANNOTATE> step is an identifier of the theory that sent the lemma.
  • Method Details

    • values

      public static AnnotationId[] 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 AnnotationId 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
    • fromInt

      public static AnnotationId fromInt(int value) throws CVC5ApiException
      Converts an integer value to the corresponding enum constant.
      Parameters:
      value - the integer representation of the enum constant.
      Returns:
      the corresponding enum constant for the given integer value.
      Throws:
      CVC5ApiException - if the value is outside the valid range, or if no corresponding enum constant exists.
    • getValue

      public int getValue()
      Get the integer value associated with this enum constant.
      Returns:
      the integer representation of the enum constant.