Code Style. Groovy
Use this page to configure formatting options for Groovy files. When you change these settings, the Preview pane shows how this will affect your code.
Tabs and Indents
Item | Description |
|---|---|
Use tab character | Use the Tab key for indentation. When the checkbox is cleared, IntelliJ IDEA uses spaces instead of tabs. |
Smart tabs |
The Smart tabs checkbox is available if the Use tab character option is enabled. |
Tab size | In this field, specify the number of spaces included in a tab. |
Indent | In this field, specify the number of spaces to be inserted for each indent level. |
Keep indents on empty lines | If this checkbox is selected, IntelliJ IDEA will keep indents on the empty lines as if they contained some code. If this checkbox is cleared, IntelliJ IDEA will delete the tab characters and spaces. |
Label indent | In this field, specify the number of spaces to be inserted at the next line before a label statement. |
Absolute label indent | If this checkbox is selected, label indentation is counted as an absolute number of spaces. Otherwise, label indentation is counted relative to previous indent levels. |
Spaces
Use this tab to specify where you want spaces in your code. To have IntelliJ IDEA automatically insert a space at a location, select the checkbox next to this location in the list. The results are displayed in the preview pane.
Wrapping and Braces
In this tab, customize the code style options, which IntelliJ IDEA will apply on reformatting the source code. The left-hand pane contains the list of exceptions (Keep when reformatting), and placement and alignment options for the various code constructs (lists, statements, operations, annotations, and so on). The right-hand pane shows the preview.
Hard wrap at
Use the Hard wrap at field to specify a margin space required on the right side of an element. If you select the Default option, then a value of the right margin from the global settings is used.
Wrap on typing
Use the Wrap on typing settings to specify how the edited text is fitted in the specified Hard wrap at:
Default: in this case IntelliJ IDEA uses the Wrap on typing option that is specified in the global settings.
Yes: in this case IntelliJ IDEA uses the value specified in the Right Margin field.
No: in this case this option is switched off and a line can exceed the value specified in the right margin.
Visual guides
Use the Visual guides field to specify multiple right margins. You can leave a default value or enter the number of spaces for your margin. If you want to specify several margins, enter numbers separated by comma.
Keep when reformatting
Use the checkboxes to configure exceptions that IntelliJ IDEA will make when reformatting the source code. For example, by default, the Line breaks checkbox is selected. If your code contains lines that are shorter than a standard convention, you can convert them by disabling the Line breaks checkbox before you reformat the source code.
Wrapping options
The wrapping style applies to the various code constructs, specified in the left-hand pane (for example, method call arguments, method declaration parameters, or assignment statements).
Item | Description |
|---|---|
Wrapping style | From this list, select the desired wrapping style:
|
Alignment options
Item | Description |
|---|---|
Align when multiline | If this checkbox is selected, a code construct starts at the same column on each next line. Otherwise, the position of a code construct is determined by the current indentation level. |
| Select this checkbox to have the specified character or characters moved to the next line when the lines are wrapped. |
'else' on new line | Use this checkbox to have the corresponding statements or characters moved to the next line. |
New line after | Select this checkbox to have the code after the specified character moved to a new line. |
Special 'else if' treatment | If this checkbox is selected, Otherwise, |
Indent 'case' branches | If this checkbox is selected, the |
Braces placement options
Item | Description |
|---|---|
Braces placement style | Use this list to specify the position of the opening brace in class declarations, method declarations, and other types of declarations. The available options are:
|
Force braces | From this list, choose the braces introduction method for
|
Blank lines
Use this tab to define where and how many blank lines you want IntelliJ IDEA to retain and insert in your code after reformatting. For each type of location, specify the number of blank lines to be inserted. The results are displayed in the preview pane.
Item | Description |
|---|---|
Keep maximum blank lines | In this area, specify the number of blank lines to keep after reformatting in the specified locations. |
Minimum blank lines | In this area, specify the minimum number of blank lines to be present in the specified locations. |
Imports
Use this tab to configure how IntelliJ IDEA should add and organize import statements in your files. IntelliJ IDEA uses these settings when it adds an import statement automatically, when you optimize imports, and when you reformat code.
General
Use these settings to configure how IntelliJ IDEA should handle imports from other packages.
Item | Description |
|---|---|
Use single class import | When you use a class from another package, import only the class instead of its whole package.
import java.time.*;
import java.time.Duration;
import java.time.LocalDate;
import java.time.LocalTime;
|
Use fully qualified class names | When you use a class from another package, insert the fully qualified class name inline instead of adding an import statement.
import java.time.LocalDate;
LocalDate date = LocalDate.now();
java.time.LocalDate date = java.time.LocalDate.now();
|
Insert imports for inner classes | When you use an inner class, import the inner class instead of its outer class and refer to it by its simple name.
import com.shop.Order;
Order.Item item;
import com.shop.Order.Item;
Item item;
|
Use fully qualified class names in javadoc | When you refer to a class from another package in a GroovyDoc comment, use its fully qualified name instead of adding an import statement and using its simple name.
import java.time.LocalDate;
/**
* Returns the {@link LocalDate} of the order.
*/
/**
* Returns the {@link java.time.LocalDate} of the order.
*/
|
Class count to use import with '*' | Specify the limit for single-type imports from the same package. When a file reaches this limit, the IDE replaces these imports with a wildcard package import.
import java.time.Duration;
import java.time.Instant;
import java.time.LocalDate;
import java.time.LocalTime;
import java.time.*;
|
Names count to use static import with '*' | Specify the limit for static imports from the same class. When a file reaches this limit, the IDE replaces these imports with a wildcard import of all static members.
import static java.lang.Math.abs;
import static java.lang.Math.max;
import static java.lang.Math.*;
|
Packages to Use Import with '*'
Use this table to specify packages and classes for which the IDE should always use a wildcard import (ending with *). You can use it in two ways:
To import a whole package whenever you use one of its classes (instead of only that class), add the package name. To apply this rule to its subpackages too, select With Subpackages. Here is an example where
java.timeis added to the table:import java.time.*; import java.time.format.DateTimeFormatter;import java.time.*; import java.time.format.*;To import all static members of a class whenever you use one of its static members (instead of only that member), add the class name and select Static. Here is an example where
java.util.Collectionsis added to the table:import static java.util.Collections.emptyList;import static java.util.Collections.*;
To add and remove rows, use the icons in the table toolbar.
Import layout
Use these settings to configure the order, grouping, and line spacing of import statements.
Item | Description |
|---|---|
Layout static imports separately | When you optimize imports, place static imports in their own groups instead of sorting them with other imports from the same package.
import java.time.Duration;
import static java.time.Duration.ofSeconds;
import java.time.LocalDate;
import java.time.Duration;
import java.time.LocalDate;
import static java.time.Duration.ofSeconds;
|
Import layout | Configure the order of import statements in your files and organize them into groups. The layout is defined at the package level. By default, the position of a package applies to both its wildcard imports and single-type imports. You can change this scope with the following options:
To add packages and blank lines, remove them, or change their order, use the icons in the table toolbar. |
Code generation
Item | Description |
|---|---|
Order of Members | Use this area to configure a sorting hierarchy of your code members. You can move the list items up or down using |
Comment Code | Use this area to configure code style for generated comments (line Ctrl+/ and block Ctrl+Shift+/):
|
Set from...
Click this link to reveal the list of languages to be used as the base for the current language code style. Only the settings that are applicable to the current language are taken. All the other settings are not affected.
This link appears in the upper-right corner of the language-specific code style page, when applicable.
Click Reset to discard changes and return to the initial set of code style settings.