com.uber.nullaway.LibraryModels Maven / Gradle / Ivy
Show all versions of nullaway Show documentation
/*
* Copyright (c) 2017 Uber Technologies, Inc.
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*/
package com.uber.nullaway;
import com.google.common.collect.ImmutableSet;
import com.google.common.collect.ImmutableSetMultimap;
import com.sun.tools.javac.code.Symbol;
import java.util.Objects;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
/** Provides models for library routines for the null checker. */
public interface LibraryModels {
/**
* Get methods which fail/error out when passed null.
*
* @return map from the names of null-rejecting methods to the indexes of the arguments that
* aren't permitted to be null.
*/
ImmutableSetMultimap failIfNullParameters();
/**
* Get (method, parameter) pairs that must be modeled as if explicitly annotated with @Nullable.
*
* @return map from the names of methods with @Nullable parameters to the indexes of the arguments
* that are @Nullable.
* This is taken into account for override checks, requiring methods that override the
* methods listed here to take @Nullable parameters on the same indexes. The main use for this
* is to document which API callbacks can be passed null values.
*/
ImmutableSetMultimap explicitlyNullableParameters();
/**
* Get (method, parameter) pairs that must be modeled as @NonNull.
*
* @return map from the names of methods with @NonNull parameters to the indexes of the arguments
* that are @NonNull.
* Note that these methods are different from the {@link #failIfNullParameters()} methods,
* in that we expect the null checker to ensure that the parameters passed to these methods
* are @NonNull. In contrast, the null checker does no such enforcement for methods in {@link
* #failIfNullParameters()}, it just learns that after the call the relevant parameters cannot
* be null.
*/
ImmutableSetMultimap nonNullParameters();
/**
* Get (method, parameter) pairs that cause the method to return true when null.
*
* @return map from the names of null-querying methods to the indexes of the arguments that are
* compared against null.
*/
ImmutableSetMultimap nullImpliesTrueParameters();
/**
* Get (method, parameter) pairs that cause the method to return false when null.
*
* @return map from the names of non-null-querying methods to the indexes of the arguments that
* are compared against null.
*/
ImmutableSetMultimap nullImpliesFalseParameters();
/**
* Get (method, parameter) pairs that cause the method to return null when passed
* null on that parameter.
*
* This is equivalent to annotating a method with a contract like:
*
*
@Contract("!null -> !null") @Nullable
*
* @return map from the names of null-in-implies-null out methods to the indexes of the arguments
* that determine nullness of the return.
*/
ImmutableSetMultimap nullImpliesNullParameters();
/**
* Get the set of library methods that may return null.
*
* @return set of library methods that may return null
*/
ImmutableSet nullableReturns();
/**
* Get the set of library methods that are assumed not to return null.
*
* @return set of library methods that are assumed not to return null
*/
ImmutableSet nonNullReturns();
/**
* representation of a method as a qualified class name + a signature for the method
*
* The formatting of a method signature should match the result of calling {@link
* Symbol.MethodSymbol#toString()} on the corresponding symbol. See {@link
* com.uber.nullaway.handlers.LibraryModelsHandler.DefaultLibraryModels} for examples. Basic
* principles:
*
*
* - signature is a method name plus argument types, e.g.,
foo(java.lang.Object,
* java.lang.String)
* - constructor for class Foo looks like
Foo(java.lang.String)
* - If the method has its own type parameters, they need to be declared, like
* <T>checkNotNull(T)
* - Type bounds matter for generics, e.g.,
addAll(java.lang.Iterable<? extends
* E>)
*
*
*/
final class MethodRef {
public final String enclosingClass;
/**
* we store the method name separately to enable fast comparison with MethodSymbols. See {@link
* com.uber.nullaway.handlers.LibraryModelsHandler.OptimizedLibraryModels}
*/
public final String methodName;
public final String fullMethodSig;
private MethodRef(String enclosingClass, String methodName, String fullMethodSig) {
this.enclosingClass = enclosingClass;
this.methodName = methodName;
this.fullMethodSig = fullMethodSig;
}
private static final Pattern METHOD_SIG_PATTERN = Pattern.compile("^(<.*>)?(\\w+)(\\(.*\\))$");
/**
* Construct a method reference.
*
* @param enclosingClass containing class
* @param methodSignature method signature in the appropriate format (see class docs)
* @return corresponding {@link MethodRef}
*/
public static MethodRef methodRef(String enclosingClass, String methodSignature) {
Matcher matcher = METHOD_SIG_PATTERN.matcher(methodSignature);
if (matcher.find()) {
String methodName = matcher.group(2);
if (methodName.equals(enclosingClass.substring(enclosingClass.lastIndexOf('.') + 1))) {
// constructor
methodName = "";
}
return new MethodRef(enclosingClass, methodName, methodSignature);
} else {
throw new IllegalArgumentException("malformed method signature " + methodSignature);
}
}
public static MethodRef fromSymbol(Symbol.MethodSymbol symbol) {
String methodStr = symbol.toString();
return new MethodRef(
symbol.owner.getQualifiedName().toString(), symbol.name.toString(), methodStr);
}
@Override
public boolean equals(Object o) {
if (this == o) {
return true;
}
if (o == null || getClass() != o.getClass()) {
return false;
}
MethodRef methodRef = (MethodRef) o;
return Objects.equals(enclosingClass, methodRef.enclosingClass)
&& Objects.equals(fullMethodSig, methodRef.fullMethodSig);
}
@Override
public int hashCode() {
return Objects.hash(enclosingClass, fullMethodSig);
}
@Override
public String toString() {
return "MethodRef{"
+ "enclosingClass='"
+ enclosingClass
+ '\''
+ ", fullMethodSig='"
+ fullMethodSig
+ '\''
+ '}';
}
}
}