Eclipse formatter settings for the Builder pattern

Question

I'm extremely frustrated with the Eclipse formatting rules for a series of qualified invocations (i.e., the Builder pattern style). For example, here is my preferred formatting for some code that creates a new Apache Commons CLI Options object:

  Options options = new Options()
      .addOption(OPTION_HELP_SHORT, OPTION_HELP, false, "print usage information")
      .addOption(OPTION_VERSION_SHORT, OPTION_VERSION, false,
          "print version and exit")
      .addOption(OptionBuilder.withLongOpt(OPTION_PROPERTIES)
                     .hasArg()
                     .withArgName("FILE")
                     .withType(File.class)
                     .withDescription("specify a user properties file")
                     .create());

I.e., parameters are wrapped and indented if necessary and all qualified invocations except the first, unless necessary, are wrapped and indented if there is more than one. If a parameter list wraps inside a qualified invocation, the invocation should wrap first.

The default formatting in Eclipse ("Wrap only when necessary" for arguments and invocations) yields the following mess:

  Options options = new Options().addOption(
      OPTION_HELP_SHORT, OPTION_HELP, false, "print usage information")
      .addOption(OPTION_VERSION_SHORT, OPTION_VERSION, false,
          "print version and exit").addOption(
          OptionBuilder.withLongOpt(OPTION_PROPERTIES).hasArg().withArgName(
              "FILE").withType(File.class).withDescription(
              "specify a user properties file").create());

Going into "Java Code Style -> Formatter -> Line Wrapping" and the line wrapping setting to "Wrap all elements, except first element if not necessary" for invocations yields:

  Options options = new Options().addOption(
      OPTION_HELP_SHORT, OPTION_HELP, false, "print usage information")
      .addOption(OPTION_VERSION_SHORT, OPTION_VERSION, false,
          "print version and exit")
      .addOption(
          OptionBuilder.withLongOpt(OPTION_PROPERTIES).hasArg().withArgName(
              "FILE").withType(File.class).withDescription(
              "specify a user properties file").create());

I don't like that the OptionBuilder expression isn't being wrapped, or that "FILE" gets wrapped without also wrapping withArgName.

Changing the indentation to "Indent on column" yields:

  Options options = new Options().addOption(OPTION_HELP_SHORT, OPTION_HELP,
                                     false, "print usage information")
                                 .addOption(OPTION_VERSION_SHORT,
                                     OPTION_VERSION, false,
                                     "print version and exit")
                                 .addOption(
                                     OptionBuilder.withLongOpt(
                                                      OPTION_PROPERTIES)
                                                  .hasArg()
                                                  .withArgName("FILE")
                                                  .withType(File.class)
                                                  .withDescription(
                                                      "specify a user properties file")
                                                  .create());

The is breaking the lines where I'd prefer, but pushing things over much too far to the right.

Is there any way to convince Eclipse to apply my preferred formatting style or something closer to it than any of the above?

+1 Good question. I'd like this as well, working a lot with Google Protobufs. — JesperE
– JesperE, Commented Jan 20, 2010 at 22:14
Please consider changing the accepted answer to this: stackoverflow.com/a/68246533/567162 — D-Klotz
– D-Klotz, Commented Mar 9, 2022 at 15:54

Jakub Bochenski · Accepted Answer · 2016-12-15 17:55:56Z

44

Turning off formatting with comments, or inserting line comments is too tedious.

The best way is described here:

... or you can select "Line Wrapping > Never join already wrapped lines" globally. Then, you can break it manually and the formatter will only format inside lines (or add additional line breaks if necessary).

With this setting Eclipse formatter will stop ruining your builder statements.

edited Dec 15, 2016 at 17:55

answered Sep 19, 2013 at 11:09

Jakub Bochenski

3,3134 gold badges39 silver badges69 bronze badges

Sign up to request clarification or add additional context in comments.

1 Comment

Steven Francolla Over a year ago

Jakub's solution here does the trick. Been working around this issue for years with comments. With this fix, the challenge is reduced to enforcing team-wide import of formatter standards file instead of training each dev to use some syntax of comments. Thanks man.

Thorbjørn Ravn Andersen · Accepted Answer · 2010-01-20 22:00:13Z

33

Use comments:

   Object o = foo() //
      .bar() //
      .toString();

answered Jan 20, 2010 at 22:00

Thorbjørn Ravn Andersen

75.4k35 gold badges203 silver badges359 bronze badges

7 Comments

Chris Conway Over a year ago

And has the advantage of being perfectly generalizable to any question of the form "how can I get my IDE to break lines in place X under circumstances Y?"

Raphael Jolivet Over a year ago

It made my day ! Thanks. That was the only reason I would not activate auto format upon save like the rest of the team.

kadam Over a year ago

We have been to the moon and back, but to tame a code formatter we still use comments in 2020 :(

Thorbjørn Ravn Andersen Over a year ago

@kadam Which formatter do you think should be the standard formatter for Java and how should it be invoked?

kadam Over a year ago

Good questions that I don't know the answers for. But if I had to pick, it would be the one that can handle a method chain without extra scaffolding.

|

Maksim Kovalev · Accepted Answer · 2021-07-04 15:59:42Z

14

Update for 2021. It is possible to change, navigate to: Code Style -> Formatter -> Line Wrapping -> Wrapping settings -> Function Calls -> Qualified invocations and change value to "Wrap all elements, except first element if not necessary"

answered Jul 4, 2021 at 15:59

Maksim Kovalev

3983 silver badges6 bronze badges

1 Comment

D-Klotz Over a year ago

This should be upvoted and changed to the accepted answer as this works. Thank you so very much for this!

Community · Accepted Answer · 2017-05-23 12:09:54Z

4

In Eclipse 3.6 It's possible to turn off formatting for a region of code. See my answer to

How to turn off the Eclipse code formatter for certain sections of Java code?

edited May 23, 2017 at 12:09

CommunityBot

11 silver badge

answered Jul 28, 2010 at 14:20

xpmatteo

11.5k3 gold badges28 silver badges29 bronze badges

Comments

nanda · Accepted Answer · 2010-01-21 09:17:41Z

3

AFAIK, this is known problem with Eclipse Formatter: https://bugs.eclipse.org/bugs/show_bug.cgi?id=59891

answered Jan 21, 2010 at 9:17

nanda

24.9k13 gold badges73 silver badges91 bronze badges

2 Comments

nanda Over a year ago

Well, you can try to extend ICodeFormatter and create your own formatter: help.eclipse.org/galileo/topic/org.eclipse.jdt.doc.isv/…

nanda Over a year ago

Hei... it's fixed on Eclipse 3.6M7!

ChadNC · Accepted Answer · 2010-01-20 21:23:18Z

-4

On the menu select Window -> Preferences when the window opens select Java -> Code Style -> Formatter and from there you can create your own format style to use by selecting the new or edit option. When editing a formatting profile a new window opens that gives you a lot of different options to use.

answered Jan 20, 2010 at 21:23

ChadNC

2,5034 gold badges25 silver badges40 bronze badges

4 Comments

Chris Conway Over a year ago

@ChadNC: I'm describing different settings in the Formatter preferences. The problem is the settings aren't flexible enough AFAICT.

ChadNC Over a year ago

please add a comment with a reason when down voting. Especially when you down vote something that is a valid response. I created a format profile before I posted the answer and it does work just fine.

ChadNC Over a year ago

@Chris, didn't see your comment when I posted my response to your down vote. You did not mention that fact that you were already using the formatter profiles and that is the reason I suggested using it. BTW you have the same name as my brother.

rsp Over a year ago

Chris is aware of the format options, but he cannot make them work dor him. If the profile you created formats according to Chris' preference, can you edit your answer with the settings in that profile?

Collectives™ on Stack Overflow

Eclipse formatter settings for the Builder pattern

6 Answers 6

1 Comment

7 Comments

1 Comment

Comments

2 Comments

4 Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

6 Answers 6

1 Comment

7 Comments

1 Comment

Comments

2 Comments

4 Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related