Package org.checkerframework.checker.lock.qual

Annotation Interface GuardedByBottom

@Documented
@Retention(RUNTIME)
@Target({TYPE_USE,TYPE_PARAMETER})
@TargetLocations({LOWER_BOUND,UPPER_BOUND})
@SubtypeOf(NewObject.class)
public @interface GuardedByBottom

The bottom type in the GuardedBy type system. Programmers should rarely write this type.

If a variable x has type @GuardedByBottom, then the value referred to by x is null (or dead code) and can never be dereferenced.

See the Checker Framework Manual:

Lock Checker, the bottom type