Package org.checkerframework.framework.util

Enum Contract.Kind

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<Contract.Kind>
    Enclosing class:
    Contract
    public static enum Contract.Kind
extends java.lang.Enum<Contract.Kind>
    Enumerates the kinds of contracts.

    • Field Summary

      Fields 
      Modifier and Type Field Description
      java.lang.String errorKey
      Used for constructing error messages.
      java.lang.Class<? extends java.lang.annotation.Annotation> frameworkContractClass
      The built-in framework qualifier for this contract.
      java.lang.Class<? extends java.lang.annotation.Annotation> frameworkContractListClass
      The built-in framework qualifier for repeated occurrences of this contract.
      java.lang.Class<? extends java.lang.annotation.Annotation> metaAnnotation
      The meta-annotation identifying annotations of this kind.

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static Contract.Kind valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static Contract.Kind[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.

      • Methods inherited from class java.lang.Enum

        clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait

    • Enum Constant Detail

      • PRECONDITION

        public static final Contract.Kind PRECONDITION
        A precondition.

      • POSTCONDITION

        public static final Contract.Kind POSTCONDITION
        A postcondition.

      • CONDITIONALPOSTCONDITION

        public static final Contract.Kind CONDITIONALPOSTCONDITION
        A conditional postcondition.

    • Field Detail

      • errorKey

        public final java.lang.String errorKey
        Used for constructing error messages.

      • metaAnnotation

        public final java.lang.Class<? extends java.lang.annotation.Annotation> metaAnnotation
        The meta-annotation identifying annotations of this kind.

      • frameworkContractClass

        public final java.lang.Class<? extends java.lang.annotation.Annotation> frameworkContractClass
        The built-in framework qualifier for this contract.

      • frameworkContractListClass

        public final java.lang.Class<? extends java.lang.annotation.Annotation> frameworkContractListClass
        The built-in framework qualifier for repeated occurrences of this contract.

    • Method Detail

      • values

        public static Contract.Kind[] 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 (Contract.Kind c : Contract.Kind.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static Contract.Kind 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