Fix nullness Javadoc on some private methods.

[cpovirk]

Summary by CodeRabbit

• Documentation
  • Clarified API documentation around converter lookup and reflection helper return values, explicitly stating nullability and return semantics for related lookup and reflection methods.

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: d49036ed-082d-4984-929b-371a7e3e6f9c

📥 Commits

Reviewing files that changed from the base of the PR and between 4fa5de6 and b9d7c80.

📒 Files selected for processing (1)

• src/main/java/org/joda/convert/StringConvert.java

✅ Files skipped from review due to trivial changes (1)

• src/main/java/org/joda/convert/StringConvert.java

---

📝 Walkthrough

Walkthrough

Documentation updates to clarify nullability semantics and return value expectations across converter lookup and reflection helper methods in AnnotationStringConverterFactory and StringConvert, with no changes to method signatures or implementation logic.

Changes

Javadoc nullability clarifications

Layer / File(s)	Summary
Javadoc nullability and return value clarifications src/main/java/org/joda/convert/AnnotationStringConverterFactory.java, src/main/java/org/joda/convert/StringConvert.java	Javadoc @return descriptions clarified in findAnnotatedConverter, findToStringMethod, findFromStringMethod, and findFromStringConstructorByType to document null return possibilities and non-null expectations; @param cls description in lookupConverter adjusted to reflect revised documented parameter nullability.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Title check	⚠️ Warning	The title claims to fix nullness Javadoc on 'private methods', but the actual changes include Javadoc updates to public methods in AnnotationStringConverterFactory and StringConvert classes, making the title inaccurate.	Revise the title to reflect that the changes address nullness documentation in public methods, such as 'Fix nullness Javadoc in StringConvert and AnnotationStringConverterFactory'.

✅ Passed checks (4 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage	✅ Passed	Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@src/main/java/org/joda/convert/StringConvert.java`:
- Line 578: Update the Javadoc `@param` for parameter cls in StringConvert (the
method documented on the shown line) to state that cls is "not null" (instead of
"null if not found"); also ensure the documentation clarifies that it is the
method's return value that may be null when no converter is found, so adjust the
surrounding sentence(s) accordingly to reflect that cls is validated non-null
before calling.

🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

• Push a commit to this branch (recommended)
• Create a new PR with the fixes

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 3a7585f6-3b7f-43e1-8904-e6d69df142ce

📥 Commits

Reviewing files that changed from the base of the PR and between 87c3e24 and 4fa5de6.

📒 Files selected for processing (2)

• src/main/java/org/joda/convert/AnnotationStringConverterFactory.java
• src/main/java/org/joda/convert/StringConvert.java