IntelliJ IDEA 2020.1 Help

Compile and build applications with IntelliJ IDEA

The IntelliJ IDEA compilation and building process compiles source files and brings together external libraries, properties files, and configurations to produce a living application. IntelliJ IDEA uses a compiler that works according to the Java specification.

You can compile a single file, use the incremental build for a module or a project, and rebuild a project from scratch.

If you have a pure Java or a Kotlin project we recommend that you use IntelliJ IDEA to build your project since IntelliJ IDEA supports the incremental build which significantly speeds up the building process.

However, IntelliJ IDEA native builder might not correctly build the Gradle or Maven project if its build script file uses custom plugins or tasks. In this case, the build delegation to Gradle or Maven can help you build your project correctly.

Compile a single file or class

  • Open the needed file in the editor and from the main menu, select Build | Recompile 'class name' (Ctrl+Shift+F9).

    Alternatively, in the Project tool window, right-click the class you need and from the context menu, select Recompile 'class name'.

    If errors occure during the compilation process, IntelliJ IDEA will display them in the Review compilation and build output along with warning messages.

Change the compilation output locations

When you compile your source code, IntelliJ IDEA automatically creates an output directory that contains compiled .class files.

Compile output directory

Inside the output directory, IntelliJ IDEA also creates subdirectories for each of your modules.

The default paths for subdirectories are as follows:

  • Sources: <ProjectFolder>/out/production/<ModuleName>
  • Tests: <ProjectFolder>/out/test/<ModuleName>

At the project level, you can change the <ProjectFolder>/out part of the output path. If you do so (say, specify some <OutputFolder> instead of <ProjectFolder>/out) but don't redefine the paths at the module level, the compilation results will go to <OutputFolder>/production/<ModuleName> and <OutputFolder>/test/<ModuleName>.

At the module level, you can specify any desirable compilation output location for the module sources and tests individually.

Specify compilation output folders

  1. Open the Project Structure dialog (File | Project Structure Ctrl+Shift+Alt+S).

  2. In Project Settings, select Project and in the Project compiler output field, specify the corresponding path.
    Project Structure dialog / Projects page

    For modules, select Modules, the module you need and the Paths tab. Change the location of the output folder under the Compiler output section.

    Project Structure dialog / Module page

Build

When you execute the Build the Build Project icon command, IntelliJ IDEA compiles all the classes inside your build target and places them inside the output directory.

When you change any class inside the build target and then execute the build action, IntelliJ IDEA performs the incremental build that compiles only the changed classes. IntelliJ IDEA also recursively builds the classes' dependecies.

Build a module, or a project

  • Select a module or a project you want to compile and from the main menu, select Build | Build Project (Ctrl+F9).

    IntelliJ IDEA displays the compilation results in the Review compilation and build output.

If you add a module dependency to your primary module and build the module, IntelliJ IDEA builds the dependent module as well and displays it in the output directory alongside the primary one. If the dependent module has its own module dependencies, then IntelliJ IDEA compiles all of them recursively starting with the least dependent module.

Project Structure dialog / Module page

The way the module dependencies are ordered may be very important for the compilation to succeed. If any two JAR files contain classes with the same name, the IntelliJ IDEA compiler will use the classes from the first JAR file it locates in the classpath.

For more information, see Module dependencies.

Rebuild

When you execute a rebuild command, IntelliJ IDEA cleans out the entire output directory, delets the build caches and builds a project, or a module from scratch. It might be helpful, when the classpath entries have changed. For example, SDKs or libraries that the project uses are added, removed or altered.

Rebuild a module, or a project

  • From the main menu, select Build | Rebuild Project for the entire project or Build | Rebuild 'module name' for the module rebuild.

    IntelliJ IDEA displays the build results in the Review compilation and build output.

Background compilation (auto-build)

You can configure IntelliJ IDEA to build your project automatically, every time you make changes to it. The results of the background compilation are dislplayed in the Problems tool window.

Configure the background compilation

  1. In the Settings/Preferences dialog Ctrl+Alt+S, go to Build, Execution, Deployment | Compiler.

  2. On the Compiler page, select Build project automatically.

    Now when you make changes in the class files, IntelliJ IDEA automatically performs the incremental build of the project.

    The automatic build also gets triggered when you save the file (Ctrl+S) or when you have the Save files automatically if application is idle for N sec. option selected in the System settings dialog.

Compile before running

By default, when you run an application, IntelliJ IDEA compiles the module where the classes you are trying to run are located.

If you want to change that behavior, you can do so in the Run/Debug Configurations dialog.

Configure a run/debug configuration

  1. From the main menu, select Run | Edit Configurations.

  2. In the dialog that opens, create a new or open an existing run configuration.

  3. In the Before Launch section, select the Build option and click the Remove icon to disable it.
    Run/Debug Configuration dialog: Before launch

    If you need to add a new configuration action, click the Add button and from the list that opens, select the desired option.

    For example, if you select Build Project then IntelliJ IDEA will build the whole project before the run. In this case, the dependencies that for some reason were not included in the build with the Build action, will be accounted for. If you select the Build, no error check option, IntelliJ IDEA will run the application even if there are errors in the compilation results.

    Run/Debug Configuration: Add new configuration.

Review compilation and build output

IntelliJ IDEA reports compilation and building results in the Messages tool window tool window, which displays messages about errors and warnings.

Messages tool window

If you configured an auto-build, then IntelliJ IDEA uses the Problems tool widow for messages. The window is availble even if the build was executed successfully.

Problems tool window

Double-click a message to jump to the problem in the source code. To automatically navigate to the problem every time you click a message, right-click anywhere in the tool window and select Navigate with Single Click from the context menu.

the Messages tool window: context menu

Save compilation messages to a text file

  1. In the Messages or Problems tool window, select a message that you want to export or press Ctrl+A to select everything displayed in the tool window.

  2. Right-click the selection and click Export to Text File.

  3. In the Export Preview dialog, specify the path and target filename, and click Save.

    Export Preview

Messages tool window reference

Icon

Tooltip

Description

Refresh

Refresh Ctrl+F5

Rerun compilation.

the Stop button

Stop

Terminate compilation. This button is enabled when compilation is in progress.

Show warnings

Show warnings

Show or hide warning messages.

Show information messages

Show information messages

Show or hide information messages.

Compiler Properties

Compiler Properties

Configure the compiler settings.

Context menu

Item

Shortcut

Description

Jump to Source

F4

Open the corresponding location in the editor.

Copy

Ctrl+C

Copy the selected message to the clipboard.

Navigate with Single Click

Enable to automatically scroll to the appropriate line of the relevant file in the editor.

Exclude from Compile

Exclude the relevant file from compilation.

Exclude from Validation

Exclude the relevant file from validation.

Export to Text File

Alt+O

Save compilation messages to a file.

Package an application into a JAR

When the code is compiled and ready, you can package your application in a Java archive (JAR) to share it with other developers. A built Java archive is called an artifact.

Create an artifact configuration for the JAR

  1. From the main menu, select File | Project Structure Ctrl+Shift+Alt+S and click Artifacts.

  2. Click the Add button, point to JAR, and select From modules with dependencies.

  3. To the right of the Main Class field, click the Browse button and select the main class in the dialog that opens (for example, HelloWorld (com.example.helloworld)).

    IntelliJ IDEA creates the artifact configuration and shows its settings in the right-hand part of the Project Structure dialog.

  4. Apply the changes and close the dialog.

Build the JAR artifact

  1. From the main menu, select Build | Build Artifacts.

  2. Point to the created .jar (HelloWorld:jar) and select Build.

    If you now look at the out/artifacts folder, you'll find your .jar file there.

The JAR artifact is built
Last modified: 25 May 2020