com.google.common.testing

Class NullPointerTester

java.lang.Object

com.google.common.testing.NullPointerTester

@Beta
 @GwtIncompatible
public final class NullPointerTester
extends java.lang.Object

A test utility that verifies that your methods and constructors throw NullPointerException or UnsupportedOperationException whenever null is passed to a parameter that isn't annotated with Nullable.

The tested methods and constructors are invoked -- each time with one parameter being null and the rest not null -- and the test fails if no expected exception is thrown. NullPointerTester uses best effort to pick non-null default values for many common JDK and Guava types, and also for interfaces and public classes that have public parameter-less constructors. When the non-null default value for a particular parameter type cannot be provided by NullPointerTester, the caller can provide a custom non-null default value for the parameter type via setDefault(java.lang.Class<T>, T).

Since:

10.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	NullPointerTester.ExceptionTypePolicy Strategy for exception type matching used by NullPointerTester.
private static class	NullPointerTester.Signature
static class	NullPointerTester.Visibility Visibility of any method or constructor.

Field Summary

Fields

Modifier and Type	Field and Description
private ClassToInstanceMap<java.lang.Object>	defaults
private java.util.List<java.lang.reflect.Member>	ignoredMembers
private NullPointerTester.ExceptionTypePolicy	policy

Constructor Summary

Constructors

Constructor and Description
NullPointerTester()

Method Summary

Modifier and Type	Method and Description
private java.lang.Object[]	buildParamList(Invokable<?,?> invokable, int indexOfParamToSetToNull)
private <F,T> Converter<F,T>	defaultConverter(TypeToken<F> convertFromType, TypeToken<T> convertToType)
private <T> T	getDefaultValue(TypeToken<T> type)
private static TypeToken<?>	getFirstTypeParameter(java.lang.reflect.Type type)
(package private) ImmutableList<java.lang.reflect.Method>	getInstanceMethodsToTest(java.lang.Class<?> c, NullPointerTester.Visibility minimalVisibility)
NullPointerTester	ignore(java.lang.reflect.Method method) Ignore method in the tests that follow.
private static Invokable<?,?>	invokable(java.lang.Object instance, java.lang.reflect.Method method)
private static boolean	isEquals(java.lang.reflect.Member member) Returns true if the the given member is a method that overrides Object.equals(Object).
private boolean	isIgnored(java.lang.reflect.Member member)
private static boolean	isNullable(Parameter param)
(package private) static boolean	isPrimitiveOrNullable(Parameter param)
private <T> T	newDefaultReturningProxy(TypeToken<T> type)
<T> NullPointerTester	setDefault(java.lang.Class<T> type, T value) Sets a default value that can be used for any parameter of type type.
void	testAllPublicConstructors(java.lang.Class<?> c) Runs testConstructor(java.lang.reflect.Constructor<?>) on every public constructor in class c.
void	testAllPublicInstanceMethods(java.lang.Object instance) Runs testMethod(java.lang.Object, java.lang.reflect.Method) on every public instance method of the class of instance, including those inherited from superclasses of the same package.
void	testAllPublicStaticMethods(java.lang.Class<?> c) Runs testMethod(java.lang.Object, java.lang.reflect.Method) on every public static method of class c, including those "inherited" from superclasses of the same package.
void	testConstructor(java.lang.reflect.Constructor<?> ctor) Verifies that ctor produces a NullPointerException or UnsupportedOperationException whenever any of its non-Nullable parameters are null.
void	testConstructorParameter(java.lang.reflect.Constructor<?> ctor, int paramIndex) Verifies that ctor produces a NullPointerException or UnsupportedOperationException when the parameter in position paramIndex is null.
void	testConstructors(java.lang.Class<?> c, NullPointerTester.Visibility minimalVisibility) Runs testConstructor(java.lang.reflect.Constructor<?>) on every constructor in class c that has at least minimalVisibility.
void	testInstanceMethods(java.lang.Object instance, NullPointerTester.Visibility minimalVisibility) Runs testMethod(java.lang.Object, java.lang.reflect.Method) on every instance method of the class of instance with at least minimalVisibility, including those inherited from superclasses of the same package.
void	testMethod(java.lang.Object instance, java.lang.reflect.Method method) Verifies that method produces a NullPointerException or UnsupportedOperationException whenever any of its non-Nullable parameters are null.
void	testMethodParameter(java.lang.Object instance, java.lang.reflect.Method method, int paramIndex) Verifies that method produces a NullPointerException or UnsupportedOperationException when the parameter in position paramIndex is null.
private void	testParameter(java.lang.Object instance, Invokable<?,?> invokable, int paramIndex, java.lang.Class<?> testedClass) Verifies that invokable produces a NullPointerException or UnsupportedOperationException when the parameter in position paramIndex is null.
void	testStaticMethods(java.lang.Class<?> c, NullPointerTester.Visibility minimalVisibility) Runs testMethod(java.lang.Object, java.lang.reflect.Method) on every static method of class c that has at least minimalVisibility, including those "inherited" from superclasses of the same package.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

defaults

private final ClassToInstanceMap<java.lang.Object> defaults

ignoredMembers

private final java.util.List<java.lang.reflect.Member> ignoredMembers

policy

private NullPointerTester.ExceptionTypePolicy policy

Constructor Detail

NullPointerTester

public NullPointerTester()

Method Detail

setDefault

public <T> NullPointerTester setDefault(java.lang.Class<T> type,
                                        T value)

Sets a default value that can be used for any parameter of type type. Returns this object.

ignore

public NullPointerTester ignore(java.lang.reflect.Method method)

Ignore method in the tests that follow. Returns this object.

Since:

13.0

testConstructors

public void testConstructors(java.lang.Class<?> c,
                             NullPointerTester.Visibility minimalVisibility)

Runs testConstructor(java.lang.reflect.Constructor<?>) on every constructor in class c that has at least minimalVisibility.

testAllPublicConstructors

public void testAllPublicConstructors(java.lang.Class<?> c)

Runs testConstructor(java.lang.reflect.Constructor<?>) on every public constructor in class c.

testStaticMethods

public void testStaticMethods(java.lang.Class<?> c,
                              NullPointerTester.Visibility minimalVisibility)

Runs testMethod(java.lang.Object, java.lang.reflect.Method) on every static method of class c that has at least minimalVisibility, including those "inherited" from superclasses of the same package.

testAllPublicStaticMethods

public void testAllPublicStaticMethods(java.lang.Class<?> c)

Runs testMethod(java.lang.Object, java.lang.reflect.Method) on every public static method of class c, including those "inherited" from superclasses of the same package.

testInstanceMethods

public void testInstanceMethods(java.lang.Object instance,
                                NullPointerTester.Visibility minimalVisibility)

Runs testMethod(java.lang.Object, java.lang.reflect.Method) on every instance method of the class of instance with at least minimalVisibility, including those inherited from superclasses of the same package.

getInstanceMethodsToTest

ImmutableList<java.lang.reflect.Method> getInstanceMethodsToTest(java.lang.Class<?> c,
                                                                 NullPointerTester.Visibility minimalVisibility)

testAllPublicInstanceMethods

public void testAllPublicInstanceMethods(java.lang.Object instance)

Runs testMethod(java.lang.Object, java.lang.reflect.Method) on every public instance method of the class of instance, including those inherited from superclasses of the same package.

testMethod

public void testMethod(@Nullable
                       java.lang.Object instance,
                       java.lang.reflect.Method method)

Verifies that method produces a NullPointerException or UnsupportedOperationException whenever any of its non-Nullable parameters are null.

Parameters:

instance - the instance to invoke method on, or null if method is static

testConstructor

public void testConstructor(java.lang.reflect.Constructor<?> ctor)

Verifies that ctor produces a NullPointerException or UnsupportedOperationException whenever any of its non-Nullable parameters are null.

testMethodParameter

public void testMethodParameter(@Nullable
                                java.lang.Object instance,
                                java.lang.reflect.Method method,
                                int paramIndex)

Verifies that method produces a NullPointerException or UnsupportedOperationException when the parameter in position paramIndex is null. If this parameter is marked Nullable, this method does nothing.

Parameters:

instance - the instance to invoke method on, or null if method is static

testConstructorParameter

public void testConstructorParameter(java.lang.reflect.Constructor<?> ctor,
                                     int paramIndex)

Verifies that ctor produces a NullPointerException or UnsupportedOperationException when the parameter in position paramIndex is null. If this parameter is marked Nullable, this method does nothing.

testParameter

private void testParameter(java.lang.Object instance,
                           Invokable<?,?> invokable,
                           int paramIndex,
                           java.lang.Class<?> testedClass)

Verifies that invokable produces a NullPointerException or UnsupportedOperationException when the parameter in position paramIndex is null. If this parameter is marked Nullable, this method does nothing.

Parameters:

instance - the instance to invoke invokable on, or null if invokable is static

buildParamList

private java.lang.Object[] buildParamList(Invokable<?,?> invokable,
                                          int indexOfParamToSetToNull)

getDefaultValue

private <T> T getDefaultValue(TypeToken<T> type)

defaultConverter

private <F,T> Converter<F,T> defaultConverter(TypeToken<F> convertFromType,
                                              TypeToken<T> convertToType)

getFirstTypeParameter

private static TypeToken<?> getFirstTypeParameter(java.lang.reflect.Type type)

newDefaultReturningProxy

private <T> T newDefaultReturningProxy(TypeToken<T> type)

invokable

private static Invokable<?,?> invokable(@Nullable
                                        java.lang.Object instance,
                                        java.lang.reflect.Method method)

isPrimitiveOrNullable

static boolean isPrimitiveOrNullable(Parameter param)

isNullable

private static boolean isNullable(Parameter param)

isIgnored

private boolean isIgnored(java.lang.reflect.Member member)

isEquals

private static boolean isEquals(java.lang.reflect.Member member)

Returns true if the the given member is a method that overrides Object.equals(Object).

The documentation for Object.equals(java.lang.Object) says it should accept null, so don't require an explicit @Nullable annotation (see #1819).

It is not necessary to consider visibility, return type, or type parameter declarations. The declaration of a method with the same name and formal parameters as Object.equals(java.lang.Object) that is not public and boolean-returning, or that declares any type parameters, would be rejected at compile-time.