org.checkerframework.framework.util

Enum Contract.Kind

java.lang.Object

java.lang.Enum<Contract.Kind>

org.checkerframework.framework.util.Contract.Kind

All Implemented Interfaces:

Serializable, Comparable<Contract.Kind>

Enclosing class:

Contract

public static enum Contract.Kind
extends Enum<Contract.Kind>

Enumerates the kinds of contracts.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CONDITIONALPOSTCONDITION A conditional postcondition.
POSTCONDITION A postcondition.
PRECONDITION A precondition.

Field Summary

Fields

Modifier and Type	Field and Description
String	errorKey Used for constructing error messages.
String	expressionElementName The name of the element that contains the Java expressions on which a contract is enforced.
Class<? extends Annotation>	frameworkContractClass The built-in framework qualifier for this contract.
Class<? extends Annotation>	frameworkContractsClass The built-in framework qualifier for repeated occurrences of this contract.
Class<? extends Annotation>	metaAnnotation The meta-annotation identifying annotations of this kind.

Method Summary

Modifier and Type	Method and Description
static Contract.Kind	valueOf(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 String errorKey

Used for constructing error messages.

metaAnnotation

public final Class<? extends Annotation> metaAnnotation

The meta-annotation identifying annotations of this kind.

frameworkContractClass

public final Class<? extends Annotation> frameworkContractClass

The built-in framework qualifier for this contract.

frameworkContractsClass

public final Class<? extends Annotation> frameworkContractsClass

The built-in framework qualifier for repeated occurrences of this contract.

expressionElementName

public final String expressionElementName

The name of the element that contains the Java expressions on which a contract is enforced.

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(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:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null