Top Description Inners Methods
org.checkerframework.checker.calledmethods.qual

public @Interface EnsuresCalledMethodsIf

extends Annotation
Annotations
@Documented
@Retention:RUNTIME
@Target:METHOD, CONSTRUCTOR
@ConditionalPostconditionAnnotation
qualifier:CalledMethods
@InheritedAnnotation
@Repeatable:List
Imports
java.lang.annotation.Documented, .ElementType, .Repeatable, .Retention, .RetentionPolicy, .Target, org.checkerframework.framework.qual.ConditionalPostconditionAnnotation, .InheritedAnnotation, .QualifierArgument

Indicates that the method, if it terminates with the given result, invokes the given methods on the given expressions.
See Also
EnsuresCalledMethods, CalledMethods

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static @interface
EnsuresCalledMethodsIf.List

A wrapper annotation that makes the EnsuresCalledMethodsIf annotation repeatable.

Method Summary

Modifier and TypeMethod and Description
public String[]

Returns:

an array of Java expressions
expression
()

Returns Java expressions that have had the given methods called on them after the method returns result.

public String[]

Returns:

the methods guaranteed to be invoked on the expressions if the result of the method is result
methods
()

The methods guaranteed to be invoked on the expressions if the result of the method is result.

public boolean

Returns:

the return value of the method under which the postcondition holds
result
()

Returns the return value of the method under which the postcondition holds.

Inherited from java.lang.annotation.Annotation:
annotationTypeequalshashCodetoString

Method Detail

expressionback to summary
public String[] expression()

Returns Java expressions that have had the given methods called on them after the method returns result.

Returns:String[]

an array of Java expressions

methodsback to summary
public String[] methods()

The methods guaranteed to be invoked on the expressions if the result of the method is result.

Returns:String[]

the methods guaranteed to be invoked on the expressions if the result of the method is result

Annotations
@QualifierArgument:value
resultback to summary
public boolean result()

Returns the return value of the method under which the postcondition holds.

Returns:boolean

the return value of the method under which the postcondition holds

org.checkerframework.checker.calledmethods.qual back to summary

public @Interface EnsuresCalledMethodsIf.List

extends Annotation
Annotations
@Documented
@Retention:RUNTIME
@Target:METHOD, CONSTRUCTOR
@ConditionalPostconditionAnnotation
qualifier:CalledMethods
@InheritedAnnotation

A wrapper annotation that makes the EnsuresCalledMethodsIf annotation repeatable.

Programmers generally do not need to write this. It is created by Java when a programmer writes more than one EnsuresCalledMethodsIf annotation at the same location.

Method Summary

Modifier and TypeMethod and Description
public EnsuresCalledMethodsIf[]

Returns:

the repeatable annotations
value
()

Return the repeatable annotations.

Inherited from java.lang.annotation.Annotation:
annotationTypeequalshashCodetoString

Method Detail

valueback to summary
public EnsuresCalledMethodsIf[] value()

Return the repeatable annotations.

Returns:EnsuresCalledMethodsIf[]

the repeatable annotations