checker.src.org.checkerframework.checker.lock.qual.GuardedByBottom Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of checker Show documentation
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.
package org.checkerframework.checker.lock.qual;
import java.lang.annotation.*;
import org.checkerframework.framework.qual.ImplicitFor;
import org.checkerframework.framework.qual.LiteralKind;
import org.checkerframework.framework.qual.SubtypeOf;
/**
* The bottom of the GuardedBy qualifier hierarchy.
* If a variable {@code x} has type {@code @GuardedByBottom}, then
* the value referred to by {@code x} is {@code null} and can never
* be dereferenced.
*
*
* @checker_framework.manual #lock-checker Lock Checker
*/
@SubtypeOf({GuardedBy.class, GuardSatisfied.class})
@ImplicitFor(literals = { LiteralKind.NULL })
@Documented
@Target({ ElementType.TYPE_USE, ElementType.TYPE_PARAMETER })
@Retention(RetentionPolicy.RUNTIME)
public @interface GuardedByBottom {}