IntelliJ IDEA 14.0.0 Web Help

Code Style. Groovy

File | Settings | Editor | Code Style | Groovy


Use this page to configure formatting options for Groovy files. View the result in the Preview pane on the right.

On this page:

Tabs and indents

Item Description
Use tab character
  • If this check box is selected, tab characters are used:
    • On pressing the Tab key
    • For indentation
    • For code reformatting
  • When the check box is cleared, IntelliJ IDEA uses spaces instead of tabs.
Smart tabs
  • If this check box is selected, IntelliJ IDEA inserts tabs for indentation and reformatting, but fine alignment to a necessary column is done only via spaces without replacing them with tabs. This is done in order to preserve visual representation of the source code, when the Tab Size is changed.
  • If this check box is cleared, only tabs are used. This means that a group of spaces that fits the specified tab size is automatically replaced with a tab, which may result in breaking fine alignment.

The Smart Tabs check box is available if the Use Tab Character check box is selected.

Tab size In this text box, specify the number of spaces included in a tab.
Indent In this text box, specify the number of spaces (or tabs if the Use Tab Character check box is selected) to be inserted for each indent level.
Keep indents on empty lines If this check box is selected, then IntelliJ IDEA will keep indents on the empty lines as if they have contained some code.
If this check box is not selected, IntelliJ IDEA will delete the tabulation characters.
Label indent In this text box, specify the number of spaces (or tabs if the Use Tab Character check box is selected) to be inserted at the next line before a label statement.
Absolute label indent If this check box is selected, label indentation is counted as an absolute number of spaces. Otherwise, label indentation is counted relative to previous indent levels.
Detect and use existing file indents for editing Use this check box to detect code style settings in the currently edited file on the fly. In this case, when you open a file in the editor, indentation that was used in that file is preserved automatically. For example, if tabs were used for the indentation then in copy, paste or enter actions, tabs are used. Also, note that if you use the Reformat Code command then IntelliJ IDEA applies default code style settings and uses them in the editor.

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 check box 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, etc.). The right-hand pane shows preview.

Alignment takes precedence over indentation options.

Keep When Reformatting

Use the check boxes to configure exceptions that IntelliJ IDEA will make when reformatting the source code. For example, by default, the Line brakes check box is selected. If your code contains lines that are shorter than a standard convention, you can convert them by disabling the Line brakes check box 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, or assignment statements).

Item Description
Wrapping style From this drop-down list, select the desired wrapping style:
  • Do not wrap - when this option is selected, no special wrapping style is applied.

    With this option selected, the nested alignment and braces settings are ignored.

  • Wrap if long - select this option to have lines going beyond the right margin wrapped with proper indentation.
  • Chop down if long - select this option to have elements in lists that go beyond the right margin wrapped so that there is one element per line with proper indentation.
  • Wrap always - select this option to have all elements in lists wrapped so that there is one element per line with proper indentation.

Alignment Options

Item Description
<character(s)> on next line Select this check box to have the specified character or characters moved to the next line when the lines are wrapped.
New line after <character> Select this check box to have the code after the specified character moved to a new line.
Place on new line Use this check box to have the corresponding statements or characters moved to the next line.
Align when multiline If this check box 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.
Special else if treatment If this check box is selected, else if statements are located in the same line.

Otherwise, else if statements are moved to the next line to the corresponding indent level.

Indent case branches If this check box is selected, the case statement is located at the corresponding indent level. Otherwise, case statement is placed at the same indent level with switch.

Braces placement options

Item Description
Braces placement style Use this drop-down list to specify the position of the opening brace in class declarations, method declarations, and other types of declarations. The available options are:
  • End of line - select this option to have the opening brace placed at the declaration line end.
  • Next line if wrapped - select this option to have the opening brace placed at the beginning of the line after the multiline declaration line.
  • Next line - select this option to have the opening brace placed at the beginning of the line after the declaration line.
  • Next line shifted - select this option to have the opening brace placed at the line after the declaration line being shifted to the corresponding indent level.
  • Next line each shifted - select this option to have the opening brace placed at the line after the declaration line being shifted to the corresponding indent level, and have the next line shifted to the next indent level as well.
Force braces From this drop-down list, choose the braces introduction method for if, for, while, and do () while statements. The available options are:
  • Do not force - select this option to suppress introducing braces automatically.
  • When multiline - select this option to have braces introduced automatically, if a statement occupies more than one line. Note that IntelliJ IDEA analyzes the number of lines in the entire statement but not only its condition. For example, if the code is
    <?php if (true) return false;
    %product will insert braces automatically:
    <?php if (true) { return false; }
  • Always - select this check box to have braces always introduced automatically.

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 be kept after reformatting in the specified locations.
Minimum Blank Lines In the text boxes in this area, specify the number of blank lines to be present in the specified locations.

Imports

Item Description
General In this area, configure general import options.

Options:

  • Use single class import: Select this check box to have IntelliJ IDEA import only a particular class from a package during code generation or import optimization. Otherwise, a statement importing an entire package is inserted.
  • Use fully qualified class names: Select this check box to have IntelliJ IDEA use the fully qualified name of the class to be imported during code generation or import optimization. Otherwise, a normal import statement is inserted.
  • Insert imports for inner classes: Select this check box to have IntelliJ IDEA create imports for the inner classes referenced in your code.
  • Use fully qualified names in Javadoc: Select this check box to have IntelliJ IDEA use a fully qualified class name in Javadoc. Otherwise, a class is imported.
  • Class count to use import with '*': In this text field, specify the number of classes to be imported from a single package until all statements importing a single class are substituted with a statement importing an entire package.
  • Names count to use static import with '*': In this text box, specify the number of members to be imported from a single class until all statements importing a single member are substituted with a statement importing an entire class.
JSP Imports Layout In this area, configure how JSP import statements should be organized in your code. The introduced changes are displayed in the Preview pane below.

Options:

  • Prefer comma separated import list: Select this option to import statements organized in a comma separated list.
  • Prefer one import statement per page directive: Select this option to have one import statement created per line.
Packages to Use Import with '*' In this area, configure a list of packages and classes to be always imported completely.

Options:

  • Static: Select this check box, if you want to declare static import for the selected class.
  • Package: In the text fields of this column, specify the packages and classes to be always imported completely.
  • With Subpackages: Select this check box to have all the subpackages of the selected package imported completely.
  • Add Package: Click this button to add a new entry to the list of packages and classes.
  • Add Blank: Click this button to add an empty separator to the list of packages and classes.
  • Remove: Click this button to delete the selected package or class from the list.
Import Layout In this area, configure how import statements should be organized in your code. You can set up certain classes to be positioned first, or last, or one after another. Imported classes will be grouped as per their packages and sorted alphabetically within a package.

Options:

  • Layout static imports separately: If this check box is selected, all static imports will be kept in a separate section. Otherwise, all import statements will be sorted according to the specified layout rules.
  • Static: Select this check box, if you want to declare static import for the selected package.
  • Package: In the text fields of this column, specify the packages to be imported.
  • With Subpackages: Select this check box to have IntelliJ IDEA apply the layout rules to all the subpackages of the selected package.
  • Add Package: Click this button to add a new entry to the list of packages.
  • Add Blank: Click this button to have a blank line inserted after the selected entry, which indicates that a blank line should be inserted between the corresponding import statements.
  • Move Up / Move Down: Click these buttons to move a package or a blank line up or down in the list thus defining the order of import statements.
  • Remove: Click this button to delete the selected package from the list.

Set From

Click this link to reveal the list of languages to be used as the base for the current language code style. So doing, 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.

See Also

Language and Framework-Specific Guidelines:

Web Resources:

Last modified: 12 November 2014
comments powered by Disqus