:lang java
Description unfold
This module adds Java support to Doom Emacs, including android-mode and
groovy-mode.
Maintainers
This module has no dedicated maintainers. Become a maintainer?
Module flags
- +lsp
-
Enable LSP support for
java-mode. Requires doom-module::tools lsp and a langserver (supports eclipse.jdt.ls). - +tree-sitter
- Leverages tree-sitter for better syntax highlighting and structural text editing. Requires doom-module::tools tree-sitter.
Packages
- doom-package:android-mode
- doom-package:groovy-mode
-
if doom-module:+lsp and not doom-module::tools lsp +eglot
Hacks
No hacks documented for this module.
TODO Changelog
This module does not have a changelog yet.
Installation
Enable this module in your doom! block.
This module requires:
- Java SDK
- The LSP test runner requires doom-module::tools debugger +lsp (requires doom-package:dap-mode)
OpenJDK 11
Ubuntu
#+begin-src sh apt-get install openjdk-11-jdk-headless
#+end_src
Fedora
dnf install java-11-openjdkOracle JDK 11
Ubuntu
add-apt-repository ppa:linuxuprising/java
apt update
apt install oracle-java11-installer
apt install oracle-java11-set-defaultFedora
curl -O https://download.java.net/java/GA/jdk11/9/GPL/openjdk-11.0.2_linux-x64_bin.tar.gz
tar zxvf openjdk-11.0.2_linux-x64_bin.tar.gz
sudo mv jdk-11.0.2/ /usr/local/
Open /etc/profile.d/jdk11.sh as root and add:
export JAVA_HOME=/usr/local/jdk-11.0.2
export PATH=$PATH:$JAVA_HOME/binSave the file and source it:
source /etc/profile.d/jdk11.sh
java -versionMultiple Java Versions
It is common to need support for multiple Java versions. You can use a generic tool like jabba to install and manage multiple Java versions on any OS.
To have a different version of Java per-project, it is recommended you use
direnv and doom-module::tools direnv; create a .envrc in the root of the project pointing
to the Java installation:
PATH_add ~/.jabba/jdk/adopt@1.11.0-3
JAVA_HOME=~/.jabba/jdk/adopt@1.11.0-3
And then run $ direnv allow . in the project directory. The doom-module::tools direnv
module will automatically source this environment before activating LSP servers.
Formatter
doom-module::editor format uses google-java-format to handle formatting.
To install, grab the latest all-deps.jar release from the above, put it
somewhere and create a script similar to the below:
/usr/local/bin/google-java-format
java -jar /path/to/google-java-format-all-deps.jarTODO Usage
This module's usage documentation is incomplete. Complete it?
doom-module:+lsp features
According to https://github.com/emacs-lsp/lsp-java, you get:
- As you type reporting of parsing and compilation errors (via doom-package:flycheck or doom-package:lsp-ui)
- Code completion (doom-package:company-lsp or complete-at-point)
- Javadoc hovers (doom-package:lsp-ui)
- Code actions (doom-package:lsp-ui)
- Code outline (doom-package:imenu)
- Code navigation (doom-package:xref)
- Code lens for references/implementations (doom-package:xref)
- Highlights
- Code formatting
- Maven pom.xml project support
- Limited Gradle support
- Visual debugger (doom-package:dap-mode)
- Test runner (doom-package:dap-mode)
- Project explorer integration (doom-package:treemacs)
- Integration with Spring Initializr
TODO Configuration
This module's configuration documentation is incomplete. Complete it?
doom-module:+lsp
Install the eclipse server by executing M-x lsp-install-server and selecting
jdtls. After that any newly opened java files should start the LSP server
automatically.
To update the server, perform SPC u M-x lsp-install-server.
Note that if you change Java version you may need to remove the LSP server and
install it again. You can do this with M-x +lsp/uninstall-server followed by
M-x lsp-install-server.
Enable the doom-module::tools debugger +lsp module to get test runner support.
Troubleshooting
There are no known problems with this module. Report one?
Frequently asked questions
This module has no FAQs yet. Ask one?
TODO Appendix
This module has no appendix yet. Write one?