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

public @Interface RequiresCalledMethods

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

Indicates a method precondition: when the method is invoked, the specified expressions must have had the specified methods called on them.

Do not use this annotation for formal parameters; instead, give their type a @CalledMethods annotation. The @RequiresCalledMethods annotation is intended for other expressions, such as field accesses or method calls.

Nested and Inner Type Summary

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

A wrapper annotation that makes the RequiresCalledMethods annotation repeatable.

Method Summary

Modifier and TypeMethod and Description
public String[]

Returns:

the methods guaranteed to be invoked on the expressions
methods
()

The methods guaranteed to be invoked on the expressions.

public String[]

Returns:

the Java expressions that must have had methods called on them
value
()

The Java expressions that must have had methods called on them.

Inherited from java.lang.annotation.Annotation:
annotationTypeequalshashCodetoString

Method Detail

methodsback to summary
public String[] methods()

The methods guaranteed to be invoked on the expressions.

Returns:String[]

the methods guaranteed to be invoked on the expressions

Annotations
@QualifierArgument:value
valueback to summary
public String[] value()

The Java expressions that must have had methods called on them.

Returns:String[]

the Java expressions that must have had methods called on them

See Also
org.checkerframework.framework.qual.EnsuresQualifier
org.checkerframework.checker.calledmethods.qual back to summary

public @Interface RequiresCalledMethods.List

extends Annotation
Annotations
@Documented
@Retention:RUNTIME
@Target:METHOD, CONSTRUCTOR

A wrapper annotation that makes the RequiresCalledMethods annotation repeatable.

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

Method Summary

Modifier and TypeMethod and Description
public RequiresCalledMethods[]

Returns:

the repeatable annotations
value
()

Returns the repeatable annotations.

Inherited from java.lang.annotation.Annotation:
annotationTypeequalshashCodetoString

Method Detail

valueback to summary
public RequiresCalledMethods[] value()

Returns the repeatable annotations.

Returns:RequiresCalledMethods[]

the repeatable annotations