Skip to content

[CSV-307] Document Android compatibility#597

Closed
makarandhinge wants to merge 3 commits intoapache:masterfrom
makarandhinge:CSV-307-document-android-compatibility
Closed

[CSV-307] Document Android compatibility#597
makarandhinge wants to merge 3 commits intoapache:masterfrom
makarandhinge:CSV-307-document-android-compatibility

Conversation

@makarandhinge
Copy link

Description

This PR updates the site documentation to clarify Android compatibility considerations.

While Commons CSV requires Java 8+, Android compatibility depends on the
Android API level's support for required Java classes. For example,
java.io.UncheckedIOException (used since 1.10.0) is officially available
starting from Android API level 24.

This documentation update clarifies potential compatibility concerns
for users targeting lower Android API levels.

Checklist

  • Read the contribution guidelines for this project.
  • Read the ASF Generative Tooling Guidance.
  • I used AI to create any part of, or all of, this pull request. Which AI tool was used to create this pull request, and to what extent did it contribute?
  • Run a successful build using mvn.
  • Write unit tests that match behavioral changes, where applicable (not applicable – documentation-only change).
  • Write a pull request description that explains what and why.
  • Each commit has a meaningful subject line and body.

Clarifies that while Commons CSV requires Java 8+,
Android compatibility depends on the API level's
support for required Java classes such as
java.io.UncheckedIOException (introduced in 1.10.0).
Copy link
Member

@garydgregory garydgregory left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hello @makarandhinge

Do you have a canonical reference for this specific information or this type of information in general, perhaps on android.com?

@makarandhinge
Copy link
Author

Hi @garydgregory

The information comes from the official Android API reference. The documentation for java.io.UncheckedIOException states that it was added in API level 24: source

That is the source for the Android compatibility note in the documentation.

@garydgregory
Copy link
Member

Hello @makarandhinge

Thank you for the update.

Ah, I see then link to that page please. Also state this is comment applies to which specific version of Commons CSV. I imagine we'll have to update this in the future.

@makarandhinge
Copy link
Author

Hi @garydgregory ,

I have updated the documentation to include a link to the official Android API reference for java.io.UncheckedIOException and clarified that this note applies starting with Commons CSV 1.10.0.

Please let me know if any further adjustments are needed.

Thank you.

@garydgregory garydgregory changed the title CSV-307: Document Android compatibility considerations CSV-307: Document Android compatibilit Feb 26, 2026
@garydgregory garydgregory changed the title CSV-307: Document Android compatibilit [CSV-307] Document Android compatibility Feb 26, 2026
@garydgregory
Copy link
Member

garydgregory commented Feb 26, 2026

Hello @makarandhinge

Thank you for your update. Upon reflection, I decided to use a table. See git master:

image

If you feel, there's more to say, please rebase this PR on git master and update it.

You are credited in changes.xml.

Thank you!

@garydgregory
Copy link
Member

The Jira ticket is https://issues.apache.org/jira/browse/CSV-307

@makarandhinge
Copy link
Author

makarandhinge commented Feb 26, 2026

Thank you for the feedback, @garydgregory . I’ve resolved the merge conflicts and updated the PR to keep the Android compatibility information in the table format as suggested.

@garydgregory
Copy link
Member

garydgregory commented Feb 26, 2026

Hello @makarandhinge

Updates to do what?

@makarandhinge
Copy link
Author

Hi @garydgregory,

you can close this pull request right?

@garydgregory
Copy link
Member

I can, but I don't know if you have more to do here. If you are done, then you can close it ;)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants