org.checkerframework.checker.mustcall.qual.Owning Maven / Gradle / Ivy
package org.checkerframework.checker.mustcall.qual;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
* Annotation indicating that ownership should be transferred to the annotated parameter, field, or
* (when written on a method) return type, for the purposes of Must Call checking. Static fields
* cannot be owning.
*
* Method return types are treated as if they have this annotation by default unless their method
* is annotated as {@link NotOwning}.
*
*
When the -AnoLightweightOwnership command-line argument is passed to the checker, this
* annotation and {@link NotOwning} are ignored.
*
* @checker_framework.manual #resource-leak-checker Resource Leak Checker
*/
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.METHOD, ElementType.PARAMETER, ElementType.FIELD})
public @interface Owning {}