org.checkerframework.common.aliasing.qual.LeakedToResult Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of framework-all Show documentation

The Checker Framework enhances Java's type system to make it more powerful and useful. This lets software developers detect and prevent errors in their Java programs. The Checker Framework includes compiler plug-ins ("checkers") that find bugs or verify their absence. It also permits you to write your own compiler plug-ins.

There is a newer version: 3.0.0-b2

Show newest version

package org.checkerframework.common.aliasing.qual;

import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
import org.checkerframework.framework.qual.SubtypeOf;

/**
 * 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 {@link StringBuffer#append(String s)} is annotated as
 * {@code @LeakedToResult}, because the method returns the updated receiver.
 *
 * @see NonLeaked
 * @checker_framework.manual #aliasing-checker Aliasing Checker
 *     TODO: This annotation is currently trusted. A verification must be implemented.
 */

// This is a type qualifier because of a checker framework limitation (Issue 383), but its
// hierarchy is ignored. Once the stub parser gets updated to read non-type-qualifers
// annotations on stub files, this annotation won't be a type qualifier anymore.

@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.TYPE_USE})
@SubtypeOf({NonLeaked.class})
public @interface LeakedToResult {}