org.checkerframework.common.aliasing.qual

Annotation Type LeakedToResult

@Documented
 @Retention(value=RUNTIME)
 @Target(value=TYPE_USE)
 @SubtypeOf(value=NonLeaked.class)
public @interface LeakedToResult

This annotation is used on a formal parameter to indicate that the parameter may be returned, but it is not otherwise leaked. (A parameter is leaked if it is stored in a field where it could be accessed later, and in that case this annotation would not apply.)

For example, the receiver parameter of StringBuffer.append(String s) is annotated as @LeakedToResult, because the method returns the updated receiver.

See Also:

NonLeaked

See the Checker Framework Manual:

Aliasing Checker

TODO: This annotation is currently trusted. A verification must be implemented.