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

Go to download

Show more of this group Show more artifacts with this name
Show all versions of checker-qual-android Show documentation

checker-qual-android contains annotations (type qualifiers) that a programmer writes to specify Java code for type-checking by the Checker Framework. The checker-qual-android artifact is identical to the checker-qual artifact, except that in checker-qual-android annotations have classfile retention. The default Android Gradle plugin retains types annotated with runtime annotations in the main dex, but strips out class-retention annotations.

There is a newer version: 3.42.0-eisop5

Show newest version

package org.checkerframework.common.aliasing.qual;

import org.checkerframework.framework.qual.SubtypeOf;

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;

/**
 * An expression with this type has no aliases. In other words, no other expression, evaluated at
 * the same program point, would evaluate to the exact same object value.
 *
 * A constructor's return type should be annotated with {@code @Unique} if the constructor does
 * not leak references to the constructed object. For example, the {@code String()} constructor
 * return type is annotated as {@code @Unique}.
 *
 * @see MaybeAliased
 * @checker_framework.manual #aliasing-checker Aliasing Checker
 */
@Documented
@Retention(RetentionPolicy.CLASS)
@Target({ElementType.TYPE_USE, ElementType.TYPE_PARAMETER})
@SubtypeOf({MaybeAliased.class})
public @interface Unique {}