com.uber.nullaway.annotations.EnsuresNonNull Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of nullaway Show documentation

A fast annotation-based null checker for Java

There is a newer version: 0.12.3

package com.uber.nullaway.annotations;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * Can annotate a methods with @EnsuresNonnull(param) annotation where param is one of the classes
 * fields. It indicates a post-condition for the method, that at every call site to this method, the
 * class field in the argument is @Nonnull at exit point. If a method is annotated
 * with @EnsuresNonnull(param), NullAway checks weather the @Nonnull assumption of the field at exit
 * point is valid.
 */
@Retention(RetentionPolicy.CLASS)
@Target({ElementType.METHOD, ElementType.CONSTRUCTOR})
public @interface EnsuresNonNull {
  String[] value();
}