Skip to content

[πŸš€ Feature]: JSpecify Nullness annotations for JavaΒ #14291

Closed

Description

@mk868

Feature and motivation

I suggest adding JSpecify Nullness annotations to the Selenium framework code.
These annotations allow you to specify which parameters and return values can be null.
I'm aware that information about potential null values are already placed in the JavaDoc, but using annotations will be transparent to IDEs and static code analyzers.
This will give developers better exposure of potential problems with their code in order to avoid NullPointerExceptions.

Using annotations will also improve interoperability with Kotlin.

Links:

Usage example

The annotated method would look like this:

// ...

import org.jspecify.annotations.Nullable;

public interface WebElement extends SearchContext, TakesScreenshot {
// ...

@Nullable String getAttribute(String name);

// ...
}

Then the IDE/static code analyzer will display a warning about unsafe code:

var element = webDriver.findElement(By.tagName("img"));
var cssClasses = element.getAttribute("class").split(" "); // warning here, possible NullPointerException

Activity

  1. github-actions commented on Jul 22, 2024

    @github-actions
    Contributor

    @mk868, thank you for creating this issue. We will troubleshoot it as soon as we can.


    Info for maintainers

    Triage this issue by using labels.

    If information is missing, add a helpful comment and then I-issue-template label.

    If the issue is a question, add the I-question label.

    If the issue is valid but there is no time to troubleshoot it, consider adding the help wanted label.

    If the issue requires changes or fixes from an external project (e.g., ChromeDriver, GeckoDriver, MSEdgeDriver, W3C), add the applicable G-* label, and it will provide the correct link and auto-close the issue.

    After troubleshooting the issue, please add the R-awaiting answer label.

    Thank you!

  2. github-actions commented on Jul 25, 2024

    @github-actions
    Contributor

    This issue is looking for contributors.

    Please comment below or reach out to us through our IRC/Slack/Matrix channels if you are interested.

  3. mk868 commented on Jul 26, 2024

    @mk868
    ContributorAuthor

    I can contribute to add these annotations.
    Can I just create a Pull Request with changes?
    Or Is additional analysis/confirmation needed for this feature by the Selenium team?

  4. diemol commented on Jul 29, 2024

    @diemol
    Member

    @mk868, yes, please. Focus on small PRs so they can be quickly reviewed and merged. It does not matter if you send many PRs. A PR with 2-3 files changed will be merged rather quickly, but a PR with 20 files changed will take several days.

  5. github-actions commented on May 5, 2025

    @github-actions
    Contributor

    This issue is stale because it has been open 280 days with no activity. Remove stale label or comment or this will be closed in 14 days.

  6. added
    J-staleApplied to issues that become stale, and eventually closed.
    on May 5, 2025
  7. mk868 commented on May 5, 2025

    @mk868
    ContributorAuthor

    The task is still valid

  8. 66 remaining items

  9. added this to the 4.43.0 milestone on Apr 14, 2026
  10. asolntsev commented on Apr 14, 2026

    @asolntsev
    Contributor

    In the end, this request was gradually implemented by many people in many pull requests:

    https://github.com/SeleniumHQ/selenium/pulls?q=is%3Apr+is%3Aclosed+%2314291+

    Big thanks to

  11. github-actions commented on May 14, 2026

    @github-actions
    Contributor

    This issue has been automatically locked since there has not been any recent activity since it was closed. Please open a new issue for related bugs.

  12. locked and limited conversation to collaborators on May 14, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

Type

No type

Projects

No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions