VisibleForTesting

Kotlin |Java

@Retention(value = CLASS) annotation VisibleForTesting

---

Denotes that the class, method or field has its visibility relaxed, so that it is more widely visible than otherwise necessary to make code testable.

You can optionally specify what the visibility should have been if not for testing; this allows tools to catch unintended access from within production code.

Example:

 @VisibleForTesting(otherwise = VisibleForTesting.PROTECTED)
 public String printDiagnostics() { ... }

If not specified, the intended visibility is assumed to be private.

Summary

Constants
static final @NonNull int	NONE The annotated element should never be called from production code, only from tests.
static final @NonNull int	PACKAGE_PRIVATE The annotated element would have "package private" visibility
static final @NonNull int	PRIVATE The annotated element would have "private" visibility
static final @NonNull int	PROTECTED The annotated element would have "protected" visibility

Public methods
abstract @ProductionVisibility @NonNull int	otherwise() The visibility the annotated element would have if it did not need to be made visible for testing.

Constants

NONE

@NonNull
public static final @NonNull int NONE

The annotated element should never be called from production code, only from tests.

This is equivalent to @RestrictTo.Scope.TESTS.

PACKAGE_PRIVATE

@NonNull
public static final @NonNull int PACKAGE_PRIVATE

The annotated element would have "package private" visibility

PRIVATE

@NonNull
public static final @NonNull int PRIVATE

The annotated element would have "private" visibility

PROTECTED

@NonNull
public static final @NonNull int PROTECTED

The annotated element would have "protected" visibility

Public methods

otherwise

@ProductionVisibility
@NonNull
public abstract @ProductionVisibility int otherwise()

The visibility the annotated element would have if it did not need to be made visible for testing.