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

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

Checker Qual is the set of annotations (qualifiers) and supporting classes used by the Checker Framework to type check Java source code. Please see artifact: org.checkerframework:checker

There is a newer version: 3.45.0

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.DefaultFor;
import org.checkerframework.framework.qual.TypeUseLocation;
import org.checkerframework.framework.qual.SubtypeOf;

/**
 * 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 @Unique if the
 * constructor does not leak references to the constructed object.
 * For example, the String() constructor return type
 * is annotated as @Unique.
 *
 * @see MaybeAliased
 * @checker_framework.manual #aliasing-checker Aliasing Checker
 */

@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target({ ElementType.TYPE_USE, ElementType.TYPE_PARAMETER })
@SubtypeOf({MaybeAliased.class})
@DefaultFor(TypeUseLocation.LOWER_BOUND)
public @interface Unique {}