Class NullabilityUtil

java.lang.Object

com.ibm.wala.util.nullability.NullabilityUtil

public class NullabilityUtil
extends Object

Utility methods for targeted suppressions of NullAway warnings.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	NullabilityUtil.CastToNonNullFailedException	Exception thrown when a castToNonNull(Object) call fails.

Constructor Summary

Constructors

Constructor	Description
NullabilityUtil()

Method Summary

Modifier and Type	Method	Description
static <T> T	castToNonNull(@Nullable T obj)	Casts a reference to a @NonNull type, throwing an exception if the reference is null.
static <T extends @Nullable Object> T	uncheckedNull()	Returns a null reference with a @NonNull type.

Methods inherited from class Object

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

Constructor Details

NullabilityUtil

public NullabilityUtil()

Method Details

castToNonNull

public static <T> T castToNonNull(@Nullable T obj)
                           throws NullabilityUtil.CastToNonNullFailedException

Casts a reference to a @NonNull type, throwing an exception if the reference is null.

Parameters:

obj - the reference

Returns:

the reference itself

Throws:

NullabilityUtil.CastToNonNullFailedException - if obj is null

uncheckedNull

public static <T extends @Nullable Object> T uncheckedNull()

Returns a null reference with a @NonNull type. Useful, e.g., where a method is allowed to return null, but the NullAway type system can only express a @NonNull return type.

Returns:

a null reference