Skip to content
Java autocompletion for Atom editor
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
keymaps
lib
menus
.eslintrc
.gitignore
CHANGELOG.md
LICENSE.md
README.md
package.json
screenshot.gif

README.md

autocomplete-java Number of downloads

Java autocomplete-plus provider for Atom editor. Current features:

  • Complete package and class names
  • Import classes automatically
  • Organize imports alphabetically
  • Fold imports
  • Examine constructors, methods and properties of a class or instance and use them as snippets
  • Crude class resolution for variables and method return values (still a quick hack)
  • Predictive suggestions

Some planned future features:

Official page for package at atom.io: autocomplete-java

Preview

Screenshot

Usage

Configure classpath via a .classpath file. A simple project would typically contain a single .classpath file that is placed at the root directory of the project. A large project would contain a separate .classpath file for each module. An example of .classpath file contents:

./classes:./lib/*:../api/classes

There is an example of multimodule classpath setup on linter-javac Wiki.

You can alter the default .classpath filename and other autocomplete behavior with package settings.

NOTE:

  • The package requires that either JAVA_HOME environment variable is set or JDK tools (javap, jar) are found in path. Alternatively you can set JAVA_HOME in package settings.
  • The package requires compiled classes to function, but it does not compile classes from source. Use other tools for compiling.
  • If you want autocomplete to show method argument names, compile your classes with the -parameters switch of Javac.
  • If you compile classes manually, disable the 'refresh class on save' setting and run 'refresh project' manually after compilation (ctrl-alt-shift-R). Also try to avoid running refresh command and your build scripts at the same time.
  • Scanning all classes in classpath is still unoptimized. It might take a few minutes until autocomplete fully kicks in after opening a project, so please be patient.
  • Class resolution for variables and method return values is still a quick hack and it will be improved in the future. If the package fails to resolve class automatically, you can still examine methods with a class name if you know the class yourself (e.g. ArrayList.con...).

Tips

At first, compile all your classes using your favorite build tool, and start your app. While editing java source files, lint and compile changed classes automatically with linter-javac, and the autocomplete-java package will refresh changed classes automatically on save. You can also reload changed classes automatically in JVM with spring-loaded or some other JVM agent. This way you can develop your app while the app is running.

NOTE: Current version of linter-javac performs bad in case of slow hard drive and large amount of classes to be linted. If you experience freezing during file save, consider disabling linter-javac, at least for now.

NOTE: Error in one class may prevent compilation of multiple classes. Therefore once you fix an error, multiple classes might be recompiled at once. So sometimes you might have to run 'project refresh' manually after you fix an error (ctrl-alt-shift-R). See issue #19.

Contribute

Contributions are welcome. Please comment on issues you would like to contribute to, or add feature requests of your own.

You can’t perform that action at this time.