Skip to content

Commit

Permalink
For NamedLikeContextualKeyword checker, remove granular flags that ma…
Browse files Browse the repository at this point in the history 
…nage internal behavior

* Can still be disabled at the checker level e.g. using annotations or flags

PiperOrigin-RevId: 553168041
  • Loading branch information
@java-team-github-bot
java-team-github-bot authored and Error Prone Team committed Aug 22, 2023
1 parent 24065a9 commit 1f365fe
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 61 deletions.
21 changes: 0 additions & 21 deletions core/src/main/java/com/google/errorprone/bugpatterns/NamedLikeContextualKeyword.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,6 @@

import com.google.common.collect.ImmutableSet;
import com.google.errorprone.BugPattern;
import com.google.errorprone.ErrorProneFlags;
import com.google.errorprone.VisitorState;
import com.google.errorprone.bugpatterns.BugChecker.ClassTreeMatcher;
import com.google.errorprone.bugpatterns.BugChecker.MethodInvocationTreeMatcher;
Expand All @@ -47,7 +46,6 @@
import com.sun.tools.javac.code.Symbol.ClassSymbol;
import com.sun.tools.javac.code.Symbol.MethodSymbol;
import java.util.Collections;
import javax.inject.Inject;

/**
* Warns on classes or methods being named similarly to contextual keywords, or invoking such
Expand Down Expand Up @@ -87,23 +85,8 @@ public final class NamedLikeContextualKeyword extends BugChecker
"com.google.auto.value.processor.AutoValueProcessor",
"com.google.auto.value.processor.AutoOneOfProcessor");

private final boolean enableMethodNames;
private final boolean enableClassNames;

@Inject
NamedLikeContextualKeyword(ErrorProneFlags flags) {
this.enableMethodNames =
flags.getBoolean("NamedLikeContextualKeyword:EnableMethodNames").orElse(false);
this.enableClassNames =
flags.getBoolean("NamedLikeContextualKeyword:EnableClassNames").orElse(false);
}

@Override
public Description matchMethod(MethodTree tree, VisitorState state) {
if (!this.enableMethodNames) {
return NO_MATCH;
}

MethodSymbol methodSymbol = ASTHelpers.getSymbol(tree);

// Don't alert if an @Auto... class (safe since reference always qualified).
Expand All @@ -122,10 +105,6 @@ public Description matchMethod(MethodTree tree, VisitorState state) {

@Override
public Description matchClass(ClassTree tree, VisitorState state) {
if (!this.enableClassNames) {
return NO_MATCH;
}

if (DISALLOWED_CLASS_NAMES.contains(tree.getSimpleName().toString())) {
return describeMatch(tree);
}
Expand Down
43 changes: 3 additions & 40 deletions core/src/test/java/com/google/errorprone/bugpatterns/NamedLikeContextualKeywordTest.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,6 @@ public void instanceMethodName_error() {
" foo = new NullPointerException(\"uh oh\");",
" }",
"}")
.setArgs(ImmutableList.of("-XepOpt:NamedLikeContextualKeyword:EnableMethodNames"))
.doTest();
}

Expand All @@ -65,7 +64,6 @@ public void staticMethodName_error() {
" foo = new NullPointerException(\"uh oh\");",
" }",
"}")
.setArgs(ImmutableList.of("-XepOpt:NamedLikeContextualKeyword:EnableMethodNames"))
.doTest();
}

Expand All @@ -85,7 +83,6 @@ public void autoOneOfMethodName_noError() {
" foo = new NullPointerException(\"uh oh\");",
" }",
"}")
.setArgs("-XepOpt:NamedLikeContextualKeyword:EnableMethodNames")
.doTest();
}

Expand All @@ -105,7 +102,6 @@ public void autoValueMethodName_noError() {
" foo = new NullPointerException(\"uh oh\");",
" }",
"}")
.setArgs("-XepOpt:NamedLikeContextualKeyword:EnableMethodNames")
.doTest();
}

Expand All @@ -126,7 +122,6 @@ public void generatedButNotAuto_error() {
" foo = new NullPointerException(\"uh oh\");",
" }",
"}")
.setArgs("-XepOpt:NamedLikeContextualKeyword:EnableMethodNames")
.doTest();
}

Expand All @@ -140,7 +135,6 @@ public void className_error() {
" public module() {",
" }",
"}")
.setArgs(ImmutableList.of("-XepOpt:NamedLikeContextualKeyword:EnableClassNames"))
.doTest();
}

Expand All @@ -161,10 +155,6 @@ public void yieldInSwitch_noError() {
" };",
" }",
"}")
.setArgs(
ImmutableList.of(
"-XepOpt:NamedLikeContextualKeyword:EnableMethodNames",
"-XepOpt:NamedLikeContextualKeyword:EnableClassNames"))
.doTest();
}

Expand All @@ -188,10 +178,6 @@ public void interfaceImplementation_noError() {
" @SuppressWarnings(\"NamedLikeContextualKeyword\")",
" void yield();",
"}")
.setArgs(
ImmutableList.of(
"-XepOpt:NamedLikeContextualKeyword:EnableMethodNames",
"-XepOpt:NamedLikeContextualKeyword:EnableClassNames"))
.doTest();
}

Expand All @@ -215,10 +201,6 @@ public void nonAnnotatedOverride_noError() {
" @SuppressWarnings(\"NamedLikeContextualKeyword\")",
" void yield() {}",
"}")
.setArgs(
ImmutableList.of(
"-XepOpt:NamedLikeContextualKeyword:EnableMethodNames",
"-XepOpt:NamedLikeContextualKeyword:EnableClassNames"))
.doTest();
}

Expand All @@ -243,10 +225,6 @@ public void annotatedOverride_noError() {
" @SuppressWarnings(\"NamedLikeContextualKeyword\")",
" void yield() {}",
"}")
.setArgs(
ImmutableList.of(
"-XepOpt:NamedLikeContextualKeyword:EnableMethodNames",
"-XepOpt:NamedLikeContextualKeyword:EnableClassNames"))
.doTest();
}

Expand All @@ -263,12 +241,7 @@ public void positive() {
" yield();",
" }",
"}")
.setArgs(
ImmutableList.of(
"--release",
"11",
"-XepOpt:NamedLikeContextualKeyword:EnableMethodNames",
"-XepOpt:NamedLikeContextualKeyword:EnableClassNames"))
.setArgs(ImmutableList.of("--release", "11"))
.doTest();
}

Expand All @@ -291,12 +264,7 @@ public void enclosing() {
" }",
" }",
"}")
.setArgs(
ImmutableList.of(
"--release",
"11",
"-XepOpt:NamedLikeContextualKeyword:EnableMethodNames",
"-XepOpt:NamedLikeContextualKeyword:EnableClassNames"))
.setArgs(ImmutableList.of("--release", "11"))
.doTest();
}

Expand All @@ -315,12 +283,7 @@ public void staticMethod() {
" }",
" }",
"}")
.setArgs(
ImmutableList.of(
"--release",
"11",
"-XepOpt:NamedLikeContextualKeyword:EnableMethodNames",
"-XepOpt:NamedLikeContextualKeyword:EnableClassNames"))
.setArgs(ImmutableList.of("--release", "11"))
.doTest();
}
}

0 comments on commit 1f365fe

Please sign in to comment.