-
Notifications
You must be signed in to change notification settings - Fork 742
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Replace public constructor on an abstract class with
protected Fixes #776 ------------- Created by MOE: https://github.com/google/moe MOE_MIGRATED_REVID=312188474
- Loading branch information
1 parent
50fc80b
commit 2c1e984
Showing
3 changed files
with
149 additions
and
0 deletions.
There are no files selected for viewing
68 changes: 68 additions & 0 deletions
68
core/src/main/java/com/google/errorprone/bugpatterns/PublicConstructorForAbstractClass.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,68 @@ | ||
/* | ||
* Copyright 2020 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; | ||
|
||
import static com.google.errorprone.BugPattern.SeverityLevel.WARNING; | ||
import static com.google.errorprone.matchers.Description.NO_MATCH; | ||
import static com.google.errorprone.matchers.Matchers.allOf; | ||
import static com.google.errorprone.matchers.Matchers.enclosingClass; | ||
import static com.google.errorprone.matchers.Matchers.hasModifier; | ||
import static com.google.errorprone.matchers.Matchers.methodHasVisibility; | ||
import static com.google.errorprone.matchers.Matchers.methodIsConstructor; | ||
import static javax.lang.model.element.Modifier.ABSTRACT; | ||
|
||
import com.google.errorprone.BugPattern; | ||
import com.google.errorprone.VisitorState; | ||
import com.google.errorprone.bugpatterns.BugChecker.MethodTreeMatcher; | ||
import com.google.errorprone.fixes.SuggestedFix; | ||
import com.google.errorprone.fixes.SuggestedFixes; | ||
import com.google.errorprone.matchers.Description; | ||
import com.google.errorprone.matchers.Matcher; | ||
import com.google.errorprone.matchers.MethodVisibility; | ||
import com.sun.source.tree.MethodTree; | ||
import javax.lang.model.element.Modifier; | ||
|
||
/** A {@link BugChecker}; see the associated {@link BugPattern} annotation for details. */ | ||
@BugPattern( | ||
name = "PublicConstructorForAbstractClass", | ||
summary = | ||
"Constructors of on an abstract class can be declared protected as there is never a need" | ||
+ " for them to be public", | ||
explanation = | ||
"Abstract classes' constructors are only ever called by subclasses, never directly by" | ||
+ " another class. Therefore they never need public constructors: protected is" | ||
+ " accessible enough.", | ||
severity = WARNING) | ||
public class PublicConstructorForAbstractClass extends BugChecker implements MethodTreeMatcher { | ||
|
||
private static final Matcher<MethodTree> PUBLIC_ABSTRACT_CONSTRUCTOR = | ||
allOf( | ||
methodIsConstructor(), | ||
methodHasVisibility(MethodVisibility.Visibility.PUBLIC), | ||
enclosingClass(hasModifier(ABSTRACT))); | ||
|
||
@Override | ||
public Description matchMethod(MethodTree tree, VisitorState state) { | ||
if (!PUBLIC_ABSTRACT_CONSTRUCTOR.matches(tree, state)) { | ||
return NO_MATCH; | ||
} | ||
SuggestedFix.Builder fix = SuggestedFix.builder(); | ||
SuggestedFixes.removeModifiers(tree, state, Modifier.PUBLIC).ifPresent(fix::merge); | ||
SuggestedFixes.addModifiers(tree, state, Modifier.PROTECTED).ifPresent(fix::merge); | ||
return describeMatch(tree, fix.build()); | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
79 changes: 79 additions & 0 deletions
79
...rc/test/java/com/google/errorprone/bugpatterns/PublicConstructorForAbstractClassTest.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,79 @@ | ||
/* | ||
* Copyright 2020 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; | ||
|
||
import com.google.errorprone.BugCheckerRefactoringTestHelper; | ||
import com.google.errorprone.CompilationTestHelper; | ||
import java.io.IOException; | ||
import org.junit.Test; | ||
import org.junit.runner.RunWith; | ||
import org.junit.runners.JUnit4; | ||
|
||
/** {@link PublicConstructorForAbstractClass}Test */ | ||
@RunWith(JUnit4.class) | ||
public class PublicConstructorForAbstractClassTest { | ||
|
||
@Test | ||
public void basicRefactoringTest() throws IOException { | ||
BugCheckerRefactoringTestHelper testHelper = | ||
BugCheckerRefactoringTestHelper.newInstance( | ||
new PublicConstructorForAbstractClass(), getClass()); | ||
testHelper | ||
.addInputLines( | ||
"in/Test.java", // | ||
"public abstract class Test {", | ||
" public Test() {", | ||
" }", | ||
"}") | ||
.addOutputLines( | ||
"out/Test.java", // | ||
"public abstract class Test {", | ||
" protected Test() {", | ||
" }", | ||
"}") | ||
.doTest(); | ||
} | ||
|
||
@Test | ||
public void basicUsageTest() { | ||
CompilationTestHelper testHelper = | ||
CompilationTestHelper.newInstance(PublicConstructorForAbstractClass.class, getClass()); | ||
testHelper | ||
.addSourceLines( | ||
"in/Test.java", | ||
"public abstract class Test {", | ||
" // BUG: Diagnostic contains:", | ||
" public Test() {", | ||
" }", | ||
"}") | ||
.doTest(); | ||
} | ||
|
||
@Test | ||
public void basicNegativeTest() { | ||
CompilationTestHelper testHelper = | ||
CompilationTestHelper.newInstance(PublicConstructorForAbstractClass.class, getClass()); | ||
testHelper | ||
.addSourceLines( | ||
"in/Test.java", // | ||
"public class Test {", | ||
" public Test() {", | ||
" }", | ||
"}") | ||
.doTest(); | ||
} | ||
} |