Flag calls to Sequenced* insertion APIs on Sorted* instances.

PiperOrigin-RevId: 683177531
google · Oct 7, 2024 · 150c60d · 150c60d
1 parent a659be5
commit 150c60d
Show file tree

Hide file tree

Showing 2 changed files with 34 additions and 0 deletions.
diff --git a/core/src/main/java/com/google/errorprone/bugpatterns/DoNotCallChecker.java b/core/src/main/java/com/google/errorprone/bugpatterns/DoNotCallChecker.java
@@ -143,6 +143,16 @@ public class DoNotCallChecker extends BugChecker
           .put(
               instanceMethod().onExactClass("java.sql.Time").named("toInstant"),
               "sqlTime.toInstant() is not supported. Did you mean to call toLocalTime() instead?")
+          .put(
+              instanceMethod()
+                  .onDescendantOf("java.util.SortedMap")
+                  .namedAnyOf("putFirst", "putLast"),
+              "Sorted collections do not support insertions with explicit positioning")
+          .put(
+              instanceMethod()
+                  .onDescendantOf("java.util.SortedSet")
+                  .namedAnyOf("addFirst", "addLast"),
+              "Sorted collections do not support insertions with explicit positioning")
           .put(
               instanceMethod()
                   .onExactClass("java.util.concurrent.ThreadLocalRandom")

diff --git a/core/src/test/java/com/google/errorprone/bugpatterns/DoNotCallCheckerTest.java b/core/src/test/java/com/google/errorprone/bugpatterns/DoNotCallCheckerTest.java
@@ -516,6 +516,30 @@ public void badApis() {
         .doTest();
   }
 
+  @Test
+  public void sortedCollectionSequencedCollectionMethods() {
+    testHelper
+        .addSourceLines(
+            "Test.java",
+            """
+            import java.util.TreeMap;
+            import java.util.TreeSet;
+            public class Test {
+              public void foo(TreeMap<String, String> map, TreeSet<String> set) {
+                // BUG: Diagnostic contains: DoNotCall
+                map.putFirst("foo", "bar");
+                // BUG: Diagnostic contains: DoNotCall
+                map.putLast("foo", "bar");
+                // BUG: Diagnostic contains: DoNotCall
+                set.addFirst("foo");
+                // BUG: Diagnostic contains: DoNotCall
+                set.addLast("foo");
+              }
+            }
+            """)
+        .doTest();
+  }
+
   @Test
   public void readLock_newCondition() {
     assertThrows(