Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $
You can buy this project and download/modify it how often you want.
com.google.errorprone.bugpatterns.apidiff.AndroidJdkLibsChecker Maven / Gradle / Ivy
/*
* Copyright 2018 The Error Prone Authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.google.errorprone.bugpatterns.apidiff;
import static com.google.errorprone.BugPattern.SeverityLevel.ERROR;
import static com.google.errorprone.matchers.Description.NO_MATCH;
import static com.google.errorprone.matchers.method.MethodMatchers.instanceMethod;
import com.google.common.collect.ImmutableMultimap;
import com.google.common.collect.ImmutableSet;
import com.google.common.collect.ImmutableSetMultimap;
import com.google.errorprone.BugPattern;
import com.google.errorprone.ErrorProneFlags;
import com.google.errorprone.VisitorState;
import com.google.errorprone.bugpatterns.apidiff.ApiDiff.ClassMemberKey;
import com.google.errorprone.matchers.Description;
import com.google.errorprone.matchers.Matcher;
import com.sun.source.tree.ExpressionTree;
import java.util.Map;
import java.util.stream.Collectors;
/**
* Checks for uses of classes, fields, or methods that are not compatible with legacy Android
* devices. As of Android N, that includes all of JDK8 (which is only supported on Nougat) except
* type and repeated annotations, which are compiled in a backwards compatible way.
*/
@BugPattern(
name = "AndroidJdkLibsChecker",
altNames = {"Java7ApiChecker", "AndroidApiChecker"},
summary = "Use of class, field, or method that is not compatible with legacy Android devices",
severity = ERROR)
// TODO(b/32513850): Allow Android N+ APIs, e.g., by computing API diff using android.jar
public class AndroidJdkLibsChecker extends ApiDiffChecker {
private final boolean allowJava8;
public AndroidJdkLibsChecker(ErrorProneFlags flags) {
this(flags.getBoolean("Android:Java8Libs").orElse(false));
}
public AndroidJdkLibsChecker() {
this(false);
}
private AndroidJdkLibsChecker(boolean allowJava8) {
super(deriveApiDiff(allowJava8));
this.allowJava8 = allowJava8;
}
private static final Matcher FOREACH_ON_COLLECTION =
instanceMethod()
.onDescendantOf("java.util.Collection")
.named("forEach")
.withParameters("java.util.function.Consumer");
@Override
protected Description check(ExpressionTree tree, VisitorState state) {
Description description = super.check(tree, state);
if (description.equals(NO_MATCH)) {
return NO_MATCH;
}
if (allowJava8 && FOREACH_ON_COLLECTION.matches(tree, state)) {
return NO_MATCH;
}
return description;
}
private static ApiDiff deriveApiDiff(boolean allowJava8) {
ClassSupportInfo support = new ClassSupportInfo(allowJava8);
ImmutableSet unsupportedClasses =
ImmutableSet.builder()
.addAll(
Java7ApiChecker.API_DIFF.unsupportedClasses().stream()
.filter(cls -> !support.allowedPackages.contains(packageName(cls)))
.filter(cls -> !support.allowedClasses.contains(cls))
.collect(Collectors.toSet()))
.addAll(support.bannedClasses)
.build();
ImmutableMultimap unsupportedMembers =
ImmutableSetMultimap.builder()
.putAll(
Java7ApiChecker.API_DIFF.unsupportedMembersByClass().entries().stream()
.filter(e -> !support.allowedPackages.contains(packageName(e.getKey())))
.filter(e -> !support.allowedClasses.contains(e.getKey()))
.filter(e -> support.bannedMembers.isEmpty() || !support.memberIsAllowed(e))
.collect(Collectors.toSet()))
.putAll(support.bannedMembers)
.build();
return ApiDiff.fromMembers(unsupportedClasses, unsupportedMembers);
}
private static String packageName(String className) {
return className.substring(0, className.lastIndexOf('/') + 1);
}
private static final ImmutableSetMultimap
ADDITIONAL_MEMBERS_REQUIRING_DESUGAR =
ImmutableSetMultimap.builder()
.put(
"com/google/common/base/Stopwatch",
ClassMemberKey.create("elapsed", "()Ljava/time/Duration;"))
.build();
private static class ClassSupportInfo {
private final ImmutableSet allowedPackages;
private final ImmutableSet allowedClasses;
private final ImmutableSet bannedClasses;
private final ImmutableSetMultimap allowedMembers;
private final ImmutableSetMultimap bannedMembers;
ClassSupportInfo(boolean allowJava8) {
allowedPackages = allowJava8 ? DESUGAR_ALLOWED_PACKAGES : ImmutableSet.of();
allowedClasses = allowJava8 ? DESUGAR_ALLOWED_CLASSES : BASE_ALLOWED_CLASSES;
bannedClasses = BASE_BANNED_CLASSES;
allowedMembers = allowJava8 ? DESUGAR_ALLOWED_MEMBERS : BASE_ALLOWED_MEMBERS;
bannedMembers = allowJava8 ? DESUGAR_BANNED_MEMBERS : ADDITIONAL_MEMBERS_REQUIRING_DESUGAR;
}
private boolean memberIsAllowed(Map.Entry member) {
return allowedMembers.containsEntry(member.getKey(), member.getValue())
|| allowedMembers.get(member.getKey()).stream()
.anyMatch(
memberKey ->
memberKey.descriptor().isEmpty()
&& memberKey.identifier().equals(member.getValue().identifier()));
}
// Desugar support info from
// https://github.com/bazelbuild/bazel/blob/master/tools/android/desugar.sh
private static final ImmutableSet DESUGAR_ALLOWED_PACKAGES =
ImmutableSet.of(
"java/time/", //
"java/time/chrono/",
"java/time/temporal/",
"java/time/zone/",
"java/util/stream/",
"java/util/function/");
private static final ImmutableSet BASE_ALLOWED_CLASSES =
ImmutableSet.of(
"java/lang/annotation/Repeatable", //
"java/lang/annotation/ElementType",
"java/nio/IntBuffer",
"java/nio/CharBuffer",
"java/nio/FloatBuffer",
"java/nio/DoubleBuffer",
"java/nio/ShortBuffer",
"java/nio/LongBuffer",
"java/nio/ByteBuffer",
"java/nio/MappedIntBuffer",
"java/nio/MappedCharBuffer",
"java/nio/MappedFloatBuffer",
"java/nio/MappedDoubleBuffer",
"java/nio/MappedShortBuffer",
"java/nio/MappedLongBuffer",
"java/nio/MappedByteBuffer");
private static final ImmutableSet DESUGAR_ALLOWED_CLASSES =
ImmutableSet.builder()
.addAll(BASE_ALLOWED_CLASSES)
.add("java/io/UncheckedIOException")
.add("java/util/ArrayList")
.add("java/util/Collection")
.add("java/util/Comparator")
.add("java/util/DoubleSummaryStatistics")
.add("java/util/IntSummaryStatistics")
.add("java/util/Iterator")
.add("java/util/List")
.add("java/util/LongSummaryStatistics")
.add("java/util/Map")
.add("java/util/HashMap")
.add("java/util/Map\\$$Entry")
.add("java/util/Objects")
.add("java/util/Optional")
.add("java/util/OptionalDouble")
.add("java/util/OptionalInt")
.add("java/util/OptionalLong")
.add("java/util/PrimitiveIterator")
.add("java/util/Set")
.add("java/util/Spliterator")
.add("java/util/Spliterator$OfDouble")
.add("java/util/Spliterator$OfInt")
.add("java/util/Spliterator$OfLong")
.add("java/util/Spliterator$OfPrimitive")
.add("java/util/Spliterators")
.add("java/util/Spliterators$AbstractDoubleSpliterator")
.add("java/util/Spliterators$AbstractIntSpliterator")
.add("java/util/Spliterators$AbstractLongSpliterator")
.add("java/util/Spliterators$AbstractSpliterator")
.add("java/util/StringJoiner")
.add("java/util/concurrent/ConcurrentHashMap")
.add("java/util/concurrent/ConcurrentMap")
.add("java/util/concurrent/atomic/AtomicInteger")
.add("java/util/concurrent/atomic/AtomicLong")
.add("java/util/concurrent/atomic/AtomicReference")
.build();
private static final ImmutableSet BASE_BANNED_CLASSES =
// see b/72354470, https://github.com/typetools/checker-framework/issues/1781
ImmutableSet.of("javax/lang/model/type/TypeKind");
private static final ImmutableSetMultimap BASE_ALLOWED_MEMBERS =
ImmutableSetMultimap.builder()
.put("java/util/zip/Checksum", ClassMemberKey.create("update", ""))
.build();
// Descriptor is empty string to match on any member with same simple name.
// TODO(b/185137972): Automate the generation of desugar-supported method-level APIs.
private static final ImmutableSetMultimap DESUGAR_ALLOWED_MEMBERS =
ImmutableSetMultimap.builder()
.putAll(BASE_ALLOWED_MEMBERS)
.put("java/util/Arrays", ClassMemberKey.create("stream", ""))
.put("java/util/Date", ClassMemberKey.create("from", ""))
.put("java/util/Date", ClassMemberKey.create("toInstant", ""))
.put("java/util/Calendar", ClassMemberKey.create("toInstant", ""))
.put("java/util/GregorianCalendar", ClassMemberKey.create("from", ""))
.put("java/util/GregorianCalendar", ClassMemberKey.create("toZonedDateTime", ""))
.put("java/util/TimeZone", ClassMemberKey.create("getTimeZone", ""))
.put("java/util/TimeZone", ClassMemberKey.create("toZoneId", ""))
.put("java/lang/Integer", ClassMemberKey.create("sum", ""))
.put("java/lang/Integer", ClassMemberKey.create("min", ""))
.put("java/lang/Integer", ClassMemberKey.create("max", ""))
.put("java/lang/Long", ClassMemberKey.create("sum", ""))
.put("java/lang/Long", ClassMemberKey.create("min", ""))
.put("java/lang/Long", ClassMemberKey.create("max", ""))
.put("java/lang/Double", ClassMemberKey.create("sum", ""))
.put("java/lang/Double", ClassMemberKey.create("min", ""))
.put("java/lang/Double", ClassMemberKey.create("max", ""))
.put("java/lang/Math", ClassMemberKey.create("toIntExact", ""))
.put("java/lang/Math", ClassMemberKey.create("addExact", ""))
.put("java/lang/Math", ClassMemberKey.create("subtractExact", ""))
.put("java/lang/Math", ClassMemberKey.create("multiplyExact", ""))
.put("java/lang/Math", ClassMemberKey.create("multiplyFull", ""))
.put("java/lang/Math", ClassMemberKey.create("multiplyHigh", ""))
.put("java/lang/Math", ClassMemberKey.create("incrementExact", ""))
.put("java/lang/Math", ClassMemberKey.create("decrementExact", ""))
.put("java/lang/Math", ClassMemberKey.create("negateExact", ""))
.put("java/lang/Math", ClassMemberKey.create("floorDiv", ""))
.put("java/lang/Math", ClassMemberKey.create("floorMod", ""))
.put("java/lang/Math", ClassMemberKey.create("nextDown", ""))
.put("java/io/BufferedReader", ClassMemberKey.create("lines", ""))
.build();
private static final ImmutableSetMultimap DESUGAR_BANNED_MEMBERS =
ImmutableSetMultimap.builder()
.put("java/util/Collection", ClassMemberKey.create("parallelStream", ""))
.put("java/util/stream/BaseStream", ClassMemberKey.create("parallel", ""))
.build();
}
}
