Top Description Methods
org.checkerframework.checker.mustcall.qual

public @Interface MustCall

extends Annotation
Annotations
@Retention:RUNTIME
@Target:TYPE_USE, TYPE_PARAMETER
@SubtypeOf:MustCallUnknown
@DefaultQualifierInHierarchy
@DefaultFor:EXCEPTION_PARAMETER, UPPER_BOUND
Imports
java.lang.annotation.ElementType, .Retention, .RetentionPolicy, .Target, org.checkerframework.framework.qual.DefaultFor, .DefaultQualifierInHierarchy, .SubtypeOf, .TypeUseLocation

An expression of type @MustCall({"m1", "m2"}) may be obligated to call m1() and/or m2() before it is deallocated, but it is not obligated to call any other methods.

This annotation is enforced by the Object Construction Checker's -AcheckMustCall mode. It enforces that the methods m1() and m2() are called on the annotated expression before it is deallocated.

The subtyping relationship is:

@MustCall({"m1"}) <: @MustCall({"m1", "m2"})

Method Summary

Modifier and TypeMethod and Description
public String[]

Returns:

methods that might need to be called
value
()

Methods that might need to be called on the expression whose type is annotated.

Inherited from java.lang.annotation.Annotation:
annotationTypeequalshashCodetoString

Method Detail

valueback to summary
public String[] value()

Methods that might need to be called on the expression whose type is annotated.

Returns:String[]

methods that might need to be called