com.google.java.contract

Annotation Type Requires

@Documented
@Target(value={METHOD,CONSTRUCTOR})
@Retention(value=RUNTIME)
public @interface Requires

Specifies preconditions that apply to the annotated method. Callers must establish the preconditions of methods they call.

When run time checking of contracts is enabled, preconditions are checked at method entry and throw a PreconditionError when they are violated.

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
java.lang.String[]	value The list of precondition expressions that must be met by the annotated method, written as strings.

Element Detail

value

public abstract java.lang.String[] value

The list of precondition expressions that must be met by the annotated method, written as strings. The expressions must be valid Java code and can reference all things visible to every caller of the method, as well as the method's arguments.

Expressions may also reference things that are not visible to the caller, such as private fields when the method is public, but this is considered bad style.