GoLand 2017.3 Help

Code Style. Java

File | Settings | Editor | Code Style | Java for Windows and Linux
GoLand | Preferences | Editor | Code Style | Java for macOS
Ctrl+Alt+S settings


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

Tabs and Indents

ItemDescription
Use tab character
  • If this checkbox is selected, tab characters are used:
    • On pressing the Tab key
    • For indentation
    • For code reformatting
  • When the checkbox is cleared, GoLand uses spaces instead of tabs.
Smart tabs
  • If this checkbox is selected, the part of indentation defined by the nesting of code blocks, is made of the tabs and (if necessary) spaces, while the part of indentation defined by the alignment is made only of spaces.
  • If this checkbox 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 checkbox is available if the Use Tab Character checkbox is selected.

Tab sizeIn this text box, specify the number of spaces included in a tab.
IndentIn this text box, specify the number of spaces (or tabs if the Use Tab Character checkbox is selected) to be inserted for each indent level.
Keep indents on empty linesIf this checkbox is selected, then GoLand will keep indents on the empty lines as if they contained some code.
If this checkbox is not selected, GoLand will delete the tab characters and spaces.
Label indentIn this text box, specify the number of spaces (or tabs if the Use Tab Character checkbox is selected) to be inserted at the next line before a label statement.
Absolute label indentIf this checkbox is selected, label indentation is counted as an absolute number of spaces. Otherwise, label indentation is counted relative to previous indent levels.
Do not indent top level class membersSelect this checkbox to have top level class members located at the class declaration indentation level.
Use indents relative to expression startUse this checkbox to switch between the two possible indentation behaviors:
  • If this checkbox is not selected, the blocks of code will be formatted against the closest ancestor block that starts on a new line.
  • If this checkbox is selected, the blocks of code will be formatted in columns.

Spaces

Use this tab to specify where you want spaces in your code. To have GoLand 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 GoLand 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.

Right Margin (columns)

Use the Hard wrap at field to specify a margin space required on the right side of an element. If you select 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. You can select one the following options:

  • Default - in this case GoLand uses the Wrap on typing option that is specified in the global settings.
  • Yes - in this case GoLand 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 GoLand 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 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).

ItemDescription
Wrapping styleFrom 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.
  • Wrap always - select this option to have all elements in lists wrapped so that there is one element per line 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.

Alignment options

ItemDescription
Align when multilineIf 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.
<character(s)> on next lineSelect this checkbox to have the specified character or characters moved to the next line when the lines are wrapped.
'else' on new lineUse this checkbox to have the corresponding statements or characters moved to the next line.
New line after <character> Select this checkbox to have the code after the specified character moved to a new line.
Special else if treatmentIf this checkbox 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 checkbox 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

ItemDescription
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 bracesFrom this drop-down list, choose the braces introduction method for if, for, while, and do () while statements. The available options are:

    Blank lines

    Use this tab to define where and how many blank lines you want GoLand 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.

    ItemDescription
    Keep Maximum Blank LinesIn this area, specify the number of blank lines to be kept after reformatting in the specified locations.
    Minimum Blank LinesIn the text boxes in this area, specify the number of blank lines to be present in the specified locations.

    These settings do not influence the number of blank lines before the first and after the last item.

    JavaDoc

    ItemDescription
    AlignmentIn this area, define how JavaDoc comments should be aligned.
    • Align parameter description: select this checkbox to have parameter descriptions aligned against the longest parameter name. Otherwise, the description is separated from the corresponding parameter name by a single space.
    • Align thrown exception description: select this checkbox to have thrown exception descriptions aligned against the longest exception name. Otherwise, the description is separated from the exception name by a single space.
    Blank Lines In this area, define where blank lines should be inserted in JavaDoc comments.
    • After description: select this checkbox to have a blank line automatically inserted after the description section of a JavaDoc comment.
    • After parameter descriptions: select this checkbox to have a blank line inserted after the group of @param tags.
    • After return tag: select this checkbox to have a blank line inserted after the @return tag.
    Invalid TagsIn this area, define whether invalid tags should be preserved or not.
    • Keep invalid tags: select this checkbox to have the @invalidTag preserved.
    • Keep empty @param tags: select this checkbox to have @param tags without description preserved.
    • Keep empty @return tags: select this checkbox to have @return tags without description preserved.
    • Keep empty @throws tags: select this checkbox to have @throws tags without description preserved.
    OtherIn this area, specify additional formatting options for JavaDoc comments.
    • Enable leading asterisks: select this checkbox to have each line of a JavaDoc comment start with an asterisk.
    • Use @throws rather than @exception: select this checkbox to have the @throws tag used.
    • Wrap at right margin: select this checkbox to have the text that exceeds the right margin wrapped to the next line.
    • Generate </p> on empty lines: select this checkbox to have a </p> tag automatically inserted in an empty line.
    • Keep empty lines: select this checkbox to have manually added empty lines preserved.
    • Do not wrap one-line comment: select this checkbox to have short comments kept in one line with the opening and closing tags.
    • Preserve line feed: If this checkbox is not selected (by default), line feeds are not preserved on reformatting. This is convenient when comments should be formatted within the boundaries of a paragraph, to occupy minimum space.

      If this checkbox is selected, line feeds will be preserved.

    • Parameter description on new line: select this checkbox to instruct the GoLand formatter to place the description of a JavaDoc parameter (if any) to a new line. It uses indent based on the continuation indent value.

    Arrangement

    This tab lets you define a set of rules that rearranges your code according to your preferences.

    ItemDescription
    Grouping RulesUse this area to set the grouping rules.
    • Keep getters and setters together

      Select this checkbox to keep getter and setter methods together. By default, this checkbox is selected.

    • Keep overridden methods together

      Select this checkbox to group the overridden methods together by class and interface. In order: list, select keep or by name options.

    • Keep dependent methods together

      Select this checkbox to group the dependent methods together. In order: list, select depth-first or breadth-first options.

    Matching rulesUse this area to define elements order as a list of rules, where every rule has a set of matches such as modifier or type.
    • new - use this button to add a rule. The empty rule area opens.
    • section rule - use this button to add a section rule. The section rule lets you move methods or variables into sections that you have defined.
      For example, you can create the following section rule:
      matching rule

      After the arrangement, methods in the class will be rearranged as specified in the created section rule and will be surrounded by comments:
      //methods start public void test() {} private int a() { return 1; } static void r() {} //methods end
    • delete - use this button to remove the rule from the list.
    • edit1 - use this button to edit an existing rule. To see this button, navigate to the rule that you want to edit and click on the button. In pop-up window that opens, modify the rule fields.
    • arrowUp arrowDown - use these buttons to move the selected rule up or down.
    • cogwheel blue no arrow - use this button to configure an alias for the matching rule. In this case, when you create an arrangement rule you can define a custom rule (alias) that would include a sequence of different rules and apply the alias to your current rule.
    Empty ruleUse this area to create a new matching rule or edit an existing one. You can select from the following filters:
    • Type - use this filter to choose classes or methods for your rule.
      Note that clicking a type keyword twice negates the condition.
    • Modifier - use this filter to select the types of modifiers for the rule.
      Note that clicking a modifier keyword twice negates the condition.
    • Name - use this field to specify entry names in the rule. This filter matches only entry names, such as field names, method names, class names, etc. The filter supports regular expressions and uses a standard syntax. The match is performed against the entire name.
    • Order - use this drop-down list to select the sorting order for the rule. This option is useful when more than one element uses the same matching rule. In this case, selecting Keep order will keep the same order as was set before the rearrangement and selecting Order by Name will sort the elements with the same matching rule by their names.
    • Aliases - this option displays aliases that were defined in the Rules Alias Definition dialog. You can remove the ones you do not need.
    icon sort This icon appears when you select Order by Name from the Order list. The icon indicates that the items in this rule are sorted alphabetically.

    Imports

    This table lists actions to be performed when imports are optimized.

    ItemDescription

    Code Generation

    ItemDescription
    NamingOptions:
    • Prefer longer names: select this checkbox to have the longest name highlighted in a lookup list for code completion. Otherwise, the shortest name is highlighted.
    • Name prefix / suffix: in these text boxes, type the prefixes and suffixes to be used when generating suggestions for naming new symbols through the GoLand code-generation features.

      If the fields are left blank, then the default name suggestions without prefixes or suffixes will be used. When you add a prefix value, GoLand automatically converts the first letter of the suggested base name to upper case.

      For example, if the prefix for a static field is defined as s, and the type of the field is Counter, then the suggested static field name will be sCounter.

      Note that this prefix will not take part in the generation of the getter and setter method names. So, in our example, the accessor names will be getCounter and setCounter respectively.

      Specify the name prefixes and suffixes for fields, static fields, parameters, and local variables.

    Final Modifier Options:
    • Make generated local variables final - select this checkbox to have local variables in the GoLand-generated code supplied with final modifiers.
    • Make generated parameters final - select this checkbox to have parameters in the GoLand-generated code supplied with final modifiers.
    Comment Code Options:
    • Line comment at first column - select this checkbox to have generated line comments placed in the first column.
    • Block comment at first column - select this checkbox to have generated block comments placed in the first column.
    Order of Members Specify the necessary order:
    • Order of Members - the list defines the order in which code elements appear when GoLand inserts them by itself (for instance, in case of ).
    • Move Up/Move Down - Use these buttons to change the order of members on the list and thus re-define the order in which corresponding elements appear in the generated code.
    Other Controls Select the necessary options:
    • Use External Annotations - if this checkbox is selected, GoLand will prompt to specify whether you want an annotation to be stored in the source code or externally. Otherwise, if the checkbox is cleared, annotations are added to the source code by default.
    • Insert @Override Annotation - Select this checkbox to have GoLand insert @Override annotations automatically.

    Java EE Names

    Use this tab to specify prefixes and suffixes for the names of bean classes, bean interfaces, <ejb-name> tags, servlets, filters, and listeners. These prefixes and suffixes will by default appear in the corresponding fields of the New Bean, New Servlet, New Filter, and New Listener dialog boxes. For entity beans, you can also specify the default primary key class that appears in the dialog box.

    ItemDescription
    Entity BeanUse the text boxes in this area to specify prefixes and/or suffixes to be used in the names of Entity Bean components:
    • EJB Class: default suffix Bean.
    • Home Interface: default suffix Home.
    • Remote Interface
    • Local Home Interface: default prefix Local, default suffix Home.
    • Local Interface: default prefix Local.
    • <ejb-name> tag: default suffix EJB.
    • Transfer Object: default suffix VO.
    • Default PK Class: java.lang.String.
    Session Bean Use the text boxes in this area to specify prefixes and/or suffixes to be used in the names of Session Bean components:
    • EJB Class: default suffix Bean.
    • Home Interface: default suffix Home.
    • Remote Interface
    • Local Home Interface: default prefix Local, default suffix Home.
    • Local Interface: default prefix Local.
    • Service Endpoint Interface: default suffix Service.
    • <ejb-name> tag: default suffix EJB.
    Message Driven Bean Use the text boxes in this area to specify prefixes and/or suffixes to be used in the names of Message Driven Bean components:
    • EJB Class: default suffix Bean.
    • <ejb-name> tag: default suffix EJB.
    ServletUse the text boxes in this area to specify prefixes and/or suffixes to be used in the names of Servlets:
    • Servlet Class
    • <servlet-name> tag
    FilterUse the text boxes in this area to specify prefixes and/or suffixes to be used in the names of Filters:
    • Filter Class
    • <filter-name> tag
    ListenerIn this area, specify the prefix and suffix to be used in the names of listener classes.
    Last modified: 12 December 2017

    See Also

    Procedures: