[java] JSpecify annotations for immutable models and enums (SeleniumHQ#14395)

Co-authored-by: Puja Jagani <[email protected]>
Co-authored-by: Diego Molina <[email protected]>

Author: 3 people

java/src/org/openqa/selenium/Dimension.java

@@ -18,8 +18,11 @@
 package org.openqa.selenium;
 
 import java.util.Objects;
+import org.jspecify.annotations.NullMarked;
+import org.jspecify.annotations.Nullable;
 
 /** Similar to Point - implement locally to avoid depending on GWT. */
+@NullMarked
 public class Dimension {
   public final int width;
   public final int height;
@@ -38,7 +41,7 @@ public int getHeight() {
   }
 
   @Override
-  public boolean equals(Object o) {
+  public boolean equals(@Nullable Object o) {
     if (!(o instanceof Dimension)) {
       return false;
     }

java/src/org/openqa/selenium/Keys.java

@@ -18,6 +18,8 @@
 package org.openqa.selenium;
 
 import java.util.Arrays;
+import org.jspecify.annotations.NullMarked;
+import org.jspecify.annotations.Nullable;
 
 /**
  * Representations of pressable keys that aren't text. These are stored in the Unicode PUA (Private
@@ -26,6 +28,7 @@
  * @see <a
  *     href="http://www.google.com.au/search?&amp;q=unicode+pua&amp;btnK=Search">http://www.google.com.au/search?&amp;q=unicode+pua&amp;btnK=Search</a>
  */
+@NullMarked
 public enum Keys implements CharSequence {
   NULL('\uE000'),
   CANCEL('\uE001'), // ^break
@@ -180,7 +183,7 @@ public static String chord(Iterable<CharSequence> value) {
    * @param key unicode character code
    * @return special key linked to the character code, or null if character is not a special key
    */
-  public static Keys getKeyFromUnicode(char key) {
+  public static @Nullable Keys getKeyFromUnicode(char key) {
     for (Keys unicodeKey : values()) {
       if (unicodeKey.charAt(0) == key) {
         return unicodeKey;

java/src/org/openqa/selenium/Point.java

@@ -18,8 +18,11 @@
 package org.openqa.selenium;
 
 import java.util.Objects;
+import org.jspecify.annotations.NullMarked;
+import org.jspecify.annotations.Nullable;
 
 /** A copy of java.awt.Point, to remove dependency on awt. */
+@NullMarked
 public class Point {
   public int x;
   public int y;
@@ -42,7 +45,7 @@ public Point moveBy(int xOffset, int yOffset) {
   }
 
   @Override
-  public boolean equals(Object o) {
+  public boolean equals(@Nullable Object o) {
     if (!(o instanceof Point)) {
       return false;
     }

java/src/org/openqa/selenium/Rectangle.java

@@ -19,7 +19,10 @@
 
 import java.util.Map;
 import java.util.Objects;
+import org.jspecify.annotations.NullMarked;
+import org.jspecify.annotations.Nullable;
 
+@NullMarked
 public class Rectangle {
 
   public final int x;
@@ -70,7 +73,7 @@ private Map<String, Object> toJson() {
   }
 
   @Override
-  public boolean equals(Object o) {
+  public boolean equals(@Nullable Object o) {
     if (this == o) {
       return true;
     }

java/src/org/openqa/selenium/UsernameAndPassword.java

@@ -18,9 +18,11 @@
 package org.openqa.selenium;
 
 import java.util.function.Supplier;
+import org.jspecify.annotations.NullMarked;
 import org.openqa.selenium.internal.Require;
 
 /** A combination of username and password to use when authenticating a browser with a website. */
+@NullMarked
 public class UsernameAndPassword implements Credentials {
 
   private final String username;