com.google.errorprone.bugpatterns.time.ProtoTimestampGetSecondsGetNano 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.time;
import static com.google.errorprone.BugPattern.SeverityLevel.WARNING;
import static com.google.errorprone.bugpatterns.time.NearbyCallers.containsCallToSameReceiverNearby;
import static com.google.errorprone.matchers.method.MethodMatchers.instanceMethod;
import com.google.errorprone.BugPattern;
import com.google.errorprone.VisitorState;
import com.google.errorprone.bugpatterns.BugChecker;
import com.google.errorprone.bugpatterns.BugChecker.MethodInvocationTreeMatcher;
import com.google.errorprone.matchers.Description;
import com.google.errorprone.matchers.Matcher;
import com.sun.source.tree.ExpressionTree;
import com.sun.source.tree.MethodInvocationTree;
/**
* This checker warns about accessing the underlying nanosecond-adjustment field of a protobuf
* timestamp without a "nearby" access of the underlying seconds field.
*
* @author [email protected] (Kurt Alfred Kluever)
*/
@BugPattern(
name = "ProtoTimestampGetSecondsGetNano",
summary = "getNanos() only accesses the underlying nanosecond-adjustment of the instant.",
explanation =
"If you call timestamp.getNanos(), you must also call timestamp.getSeconds() in 'nearby' "
+ "code. If you are trying to convert this timestamp to nanoseconds, "
+ "you probably meant to use Timestamps.toNanos(timestamp) instead.",
severity = WARNING)
public final class ProtoTimestampGetSecondsGetNano extends BugChecker
implements MethodInvocationTreeMatcher {
private static final Matcher GET_SECONDS =
instanceMethod().onExactClass("com.google.protobuf.Timestamp").named("getSeconds");
private static final Matcher GET_NANOS =
instanceMethod().onExactClass("com.google.protobuf.Timestamp").named("getNanos");
@Override
public Description matchMethodInvocation(MethodInvocationTree tree, VisitorState state) {
if (GET_NANOS.matches(tree, state)) {
if (!containsCallToSameReceiverNearby(tree, GET_SECONDS, state, /*checkProtoChains=*/ true)) {
return describeMatch(tree);
}
}
return Description.NO_MATCH;
}
}