com.google.common.testing
Class NullPointerTester

java.lang.Object
  com.google.common.testing.NullPointerTester

@Beta
public final class NullPointerTester
extends Object

A test utility that verifies that your methods throw NullPointerException or UnsupportedOperationException whenever any of their parameters are null. To use it, you must first provide valid default values for the parameter types used by the class.

Since:

10.0

Author:

Kevin Bourrillion

Constructor Summary

NullPointerTester()

Method Summary

NullPointerTester	ignore(Member member) Ignore a member (constructor or method) in testAllXxx methods.
<T> NullPointerTester	setDefault(Class<T> type, T value) Sets a default value that can be used for any parameter of type type.
void	testAllPublicConstructors(Class<?> c) Runs testConstructor(java.lang.reflect.Constructor) on every public constructor in class c.
void	testAllPublicInstanceMethods(Object instance) Runs testMethod(java.lang.Object, java.lang.reflect.Method) on every public instance method of instance.
void	testAllPublicStaticMethods(Class<?> c) Runs testMethod(java.lang.Object, java.lang.reflect.Method) on every public static method in class c.
void	testConstructor(Constructor<?> ctor) Verifies that ctor produces a NullPointerException or UnsupportedOperationException whenever any of its non-Nullable parameters are null.
void	testConstructorParameter(Constructor<?> ctor, int paramIndex) Verifies that ctor produces a NullPointerException or UnsupportedOperationException when the parameter in position paramIndex is null.
void	testMethod(Object instance, Method method) Verifies that method produces a NullPointerException or UnsupportedOperationException whenever any of its non-Nullable parameters are null.
void	testMethodParameter(Object instance, Method method, int paramIndex) Verifies that method produces a NullPointerException or UnsupportedOperationException when the parameter in position paramIndex is null.

Methods inherited from class java.lang.Object

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

Constructor Detail

NullPointerTester

public NullPointerTester()

Method Detail

setDefault

public <T> NullPointerTester setDefault(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(Member member)

Ignore a member (constructor or method) in testAllXxx methods. Returns this object.

testAllPublicConstructors

public void testAllPublicConstructors(Class<?> c)
                               throws Exception

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

Throws:

Exception

testAllPublicStaticMethods

public void testAllPublicStaticMethods(Class<?> c)
                                throws Exception

Runs testMethod(java.lang.Object, java.lang.reflect.Method) on every public static method in class c.

Throws:

Exception

testAllPublicInstanceMethods

public void testAllPublicInstanceMethods(Object instance)
                                  throws Exception

Runs testMethod(java.lang.Object, java.lang.reflect.Method) on every public instance method of instance.

Throws:

Exception

testMethod

public void testMethod(Object instance,
                       Method method)
                throws Exception

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

Throws:

Exception

testConstructor

public void testConstructor(Constructor<?> ctor)
                     throws Exception

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

Throws:

Exception

testMethodParameter

public void testMethodParameter(Object instance,
                                Method method,
                                int paramIndex)
                         throws Exception

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

Throws:

Exception

testConstructorParameter

public void testConstructorParameter(Constructor<?> ctor,
                                     int paramIndex)
                              throws Exception

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.

Throws:

Exception