org.checkerframework.checker.lock.qual

Annotation Type GuardedByBottom

@SubtypeOf(value={GuardedBy.class,GuardSatisfied.class})
 @Documented
 @Target(value={TYPE_USE,TYPE_PARAMETER})
 @TargetLocations(value={EXPLICIT_LOWER_BOUND,EXPLICIT_UPPER_BOUND})
 @Retention(value=RUNTIME)
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