[java] JSpecify annotations for org.openqa.selenium.interactions

[mk868]

User description

🔗 Related Issues

Related #14291

💥 What does this PR do?

JSpecify annotations added to the:

• org.openqa.selenium.interactions.CompositeAction
• org.openqa.selenium.interactions.Interaction
• org.openqa.selenium.interactions.Locatable
• org.openqa.selenium.interactions.MoveTargetOutOfBoundsException

🔧 Implementation Notes

💡 Additional Considerations

🔄 Types of changes

• New feature (non-breaking change which adds functionality and tests!)

---

PR Type

Enhancement

---

Description

• Add JSpecify @NullMarked annotations to interactions package classes

• Mark nullable parameters in MoveTargetOutOfBoundsException constructors

• Improve null-safety documentation for CompositeAction, Interaction, Locatable

• Enable compile-time null-safety checking for interactions API

---

Diagram Walkthrough

flowchart LR
  A["Interactions Package Classes"] -->|"Add @NullMarked"| B["CompositeAction"]
  A -->|"Add @NullMarked"| C["Interaction"]
  A -->|"Add @NullMarked"| D["Locatable"]
  A -->|"Add @NullMarked + @Nullable params"| E["MoveTargetOutOfBoundsException"]
  B --> F["Null-safety Annotations Applied"]
  C --> F
  D --> F
  E --> F

Loading

File Walkthrough

Relevant files

Enhancement

CompositeAction.java Add JSpecify @NullMarked annotation to CompositeAction      java/src/org/openqa/selenium/interactions/CompositeAction.java Added @NullMarked annotation import from org.jspecify.annotations Applied @NullMarked class-level annotation to CompositeAction Enables null-safety checking for the composite action aggregator +2/-0      Interaction.java Add JSpecify @NullMarked annotation to Interaction              java/src/org/openqa/selenium/interactions/Interaction.java Added @NullMarked annotation import from org.jspecify.annotations Applied @NullMarked class-level annotation to abstract Interaction class Marks all methods and fields as non-null by default +3/-0      Locatable.java Add JSpecify @NullMarked annotation to Locatable interface java/src/org/openqa/selenium/interactions/Locatable.java Added @NullMarked annotation import from org.jspecify.annotations Applied @NullMarked interface-level annotation to Locatable Establishes null-safety contract for coordinate retrieval +3/-0      MoveTargetOutOfBoundsException.java Add JSpecify annotations with nullable parameters to exception java/src/org/openqa/selenium/interactions/MoveTargetOutOfBoundsException.java Added imports for @NullMarked and @Nullable annotations Applied @NullMarked class-level annotation Marked String message and Throwable cause parameters as @Nullable in all three constructors Explicitly documents that exception constructors accept null arguments +6/-3

---

[qodo-code-review]

PR Compliance Guide 🔍

Below is a summary of compliance checks for this PR:

Security Compliance
⚪	Nullable exception args Description: Marking both constructors' String message and Throwable cause as @nullable may propagate null messages/causes, potentially reducing diagnostic information and complicating error handling where non-null messages are expected; verify consumers tolerate nulls. MoveTargetOutOfBoundsException.java [29-40] Referred Code public class MoveTargetOutOfBoundsException extends WebDriverException { public MoveTargetOutOfBoundsException(@Nullable String message) { super(message); } public MoveTargetOutOfBoundsException(@Nullable Throwable cause) { super(cause); } public MoveTargetOutOfBoundsException(@Nullable String message, @Nullable Throwable cause) { super(message, cause); }
Ticket Compliance
🟡	🎫 #14291 🟢 Add JSpecify Nullness annotations to Selenium framework code to indicate nullable parameters and return values. Prefer annotations over JavaDoc so IDEs and static analyzers can surface nullability issues. Improve interoperability with Kotlin via explicit nullness annotations. 🔴 Example usage suggests marking nullable methods/params with @nullable and adopting package/class-level annotations as appropriate.
Codebase Duplication Compliance
⚪	Codebase context is not defined Follow the guide to enable codebase context checks.
Custom Compliance
⚪	No custom compliance provided Follow the guide to enable custom compliance check.
Update

Compliance status legend

🟢 - Fully Compliant
🟡 - Partial Compliant
🔴 - Not Compliant
⚪ - Requires Further Human Verification
🏷️ - Compliance label

[qodo-code-review]

PR Code Suggestions ✨

Explore these optional code suggestions:

Category	Suggestion	Impact
Learned best practice	Clarify constructor nullability in Javadoc Ensure nullability annotations match the superclass API and document the nullability behavior in Javadoc. Add brief Javadoc to each constructor clarifying that null messages/causes are allowed. java/src/org/openqa/selenium/interactions/MoveTargetOutOfBoundsException.java [28-41] +/** + * Indicates that the target provided to the actions move() method is invalid - outside of the size + * of the window. + */ @NullMarked public class MoveTargetOutOfBoundsException extends WebDriverException { + /** + * Creates the exception with an optional detail message; a null message is allowed. + */ public MoveTargetOutOfBoundsException(@Nullable String message) { super(message); } + /** + * Creates the exception with an optional cause; a null cause is allowed. + */ public MoveTargetOutOfBoundsException(@Nullable Throwable cause) { super(cause); } + /** + * Creates the exception with optional message and cause; null values are allowed. + */ public MoveTargetOutOfBoundsException(@Nullable String message, @Nullable Throwable cause) { super(message, cause); } } Apply / Chat Suggestion importance[1-10]: 6 __ Why: Relevant best practice - Keep API and documentation accurate and consistent by aligning annotations with superclass contracts and documenting nullability intent.	Low
Update