Skip to content

ARROW-16292: [Java][Doc] Upgrade java documentation for JSE17/JSE18 #12990

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
davisusanibar wants to merge 2 commits into from
Closed

ARROW-16292: [Java][Doc] Upgrade java documentation for JSE17/JSE18 #12990

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5118c5e
Upgrade java documentation for JSE17/JSE18
davisusanibar Apr 25, 2022
cdac91f
Apply suggestions from code review
davisusanibar Apr 25, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 29 additions & 1 deletion docs/source/java/install.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Java modules are regularly built and tested on macOS and Linux distributions.
Java Compatibility
------------------

Java modules are currently compatible with JDK 8, 9, 10, or 11, but only JDK 11 is tested in CI.
Java modules are currently compatible with JDK 8, 9, 10, 11, 17, and 18, but only JDK 11 is tested in CI.

Installing from Maven
---------------------
Expand Down Expand Up @@ -101,6 +101,34 @@ transitive dependencies of Flight.
</build>
</project>

When using Java 17 or later, some JDK internals must be exposed by
adding ``--add-opens=java.base/java.nio=ALL-UNNAMED``. Otherwise,
you may see errors like ``module java.base does not "opens
java.nio" to unnamed module``.

For example, when running unit tests through Maven:

.. code-block::

<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-surefire-plugin</artifactId>
<version>3.0.0-M6</version>
<configuration>
<argLine>--add-opens=java.base/java.nio=ALL-UNNAMED</argLine>
</configuration>
</plugin>
</plugins>
</build>

Environment variables: To execute your Arrow Java main code.

.. code-block::

_JAVA_OPTIONS="--add-opens=java.base/java.nio=ALL-UNNAMED" mvn exec:java -Dexec.mainClass="YourMainCode"
Comment on lines +126 to +130
Copy link
Member

@lidavidm lidavidm Apr 25, 2022

Choose a reason for hiding this comment

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

Can this be configured in pom.xml somehow?

Copy link
Contributor Author

@davisusanibar davisusanibar Apr 25, 2022

Choose a reason for hiding this comment

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

Uhmm, let me figure out if there are some plugins available, but, initially I could say no way to do that.

Copy link
Contributor Author

@davisusanibar davisusanibar Apr 25, 2022

Choose a reason for hiding this comment

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

Hi @lidavidm, I didn't find a plugin to configure environment variable as needed on the pom.xml directly.

Copy link
Contributor Author

@davisusanibar davisusanibar Apr 25, 2022

Choose a reason for hiding this comment

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

There is a exec-maven-plugin but not able to pass argLine needed

Copy link
Member

@lidavidm lidavidm Apr 25, 2022

Choose a reason for hiding this comment

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

Ok, sounds good


Installing from Source
----------------------

Expand Down