checker.src.org.checkerframework.checker.lock.qual.GuardedByUnknown Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of checker 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.42.0

Show newest version

package org.checkerframework.checker.lock.qual;

import java.lang.annotation.*;

import org.checkerframework.framework.qual.DefaultInUncheckedCodeFor;
import org.checkerframework.framework.qual.SubtypeOf;
import org.checkerframework.framework.qual.TypeUseLocation;

/**
 * It is unknown what locks guard the value referred to by the annotated
 * variable.  Therefore, the value can never be dereferenced.  The locks
 * that guard it might not even be in scope (might be inaccessible) at the
 * location where the @GuardedByUnknown annotation is
 * written.
 * 
 *
 * @GuardedByUnknown is the top of the GuardedBy qualifier
 * hierarchy.  Any value can be assigned into a variable of type
 * @GuardedByUnknown.
 *
 * @checker_framework.manual #lock-checker Lock Checker
 */
@SubtypeOf({})
@Retention(RetentionPolicy.RUNTIME)
@DefaultInUncheckedCodeFor({ TypeUseLocation.RECEIVER })
@Target({ ElementType.TYPE_USE, ElementType.TYPE_PARAMETER })
public @interface GuardedByUnknown {}