How to stop Eclipse formatter from placing all enums on one line

JavaEclipseFormatter

Java Problem Overview


I have enums like:

public static enum Command
{
login,
register,
logout,
newMessage
}

When formatting the file, the output becomes:

public static enum Command 
{
login, register, logout, newMessage
}

Java Solutions


Solution 1 - Java

The answer by @wjans worked fine for normal enums, but not for enums with arguments. To expand on his answer a bit, here's the settings that provided the most sensible formatting for me in Eclipse Juno:

  1. Window > Preferences > Java > Code Style > Formatter
  2. Click Edit
  3. Select the Line Wrapping tab
  4. Select the enum declaration treenode
  5. Set Line wrapping policy to Wrap all elements, every element on a new line (...) so it now says 3 of 3 in the parenthesis.
  6. Uncheck Force split, even if line shorter than maximum line width (...) so it now says 3 of 3 in the parenthesis.
  7. Select the Constants treenode
  8. Check Force split, even if line shorter than maximum line width

This sets the 3 subnodes for the enum treenode to the same wrapping policy, and the same force split policy except for the Constants treenode, so your enums with arguments will be formatted each on their own line. The arguments will only wrap if they exceed maximum line width.

Examples:

@wjans

enum Example {
	CANCELLED,
	RUNNING,
	WAITING,
	FINISHED
}

enum Example {
	GREEN(
		0,
		255,
		0),
	RED(
		255,
		0,
		0)
}

Solution described above:

enum Example {
	CANCELLED,
	RUNNING,
	WAITING,
	FINISHED
}

enum Example {
	GREEN(0, 255, 0),
	RED(255, 0, 0)
}

Solution 2 - Java

You can specify this in your formatter preferences:

  • Preferences: Java -- Code Style -- Formatter
  • Click Edit
  • Select the 'Line Wrapping' tab
  • Select 'enum' declaration -> Constants in the box on the left
  • Set Line wrapping policy to 'Wrap all elements, every element on a new line'
  • Check 'Force split...'

Solution 3 - Java

It's slightly ugly too, but if your company policy prevents you from changing the formatter, you can just put comments at the end of lines you don't want to be wrapped.

public static enum Command 
{
    login,//
    register,//
    logout,//
    newMessage//
};

Solution 4 - Java

It's not nice but you can turn the Eclipse formatter off for some sections of code...

// @formatter:off
public static enum Command {
    login,
    register,
    logout,
    newMessage
};
// @formatter:on

the option is in the Windows->Preferences->Java->Code Style->Formatter->Edit->Off/On Tags panel

Solution 5 - Java

You need to set the line wrapping policy under enum declaration for "Constants."

Set the wrapping policy to

  • Wrap all elements, every element on a new line

AND

  • Check the box that says "Force Split, even if line shorter than,,,,,

Solution 6 - Java

Just adding latest Eclipse 2018.9

  1. Window > Preferences > Java > Code Style > Formatter - Edit
  2. Expand Line Wrapping tree node.
  3. Expand Wrapping settings
  4. Expand 'enum' declaration
  5. Edit Constants and Constant arguments.

Constants need to be Wrap all elements, every element on a new line. Constant arguments need to be Wrap where necessary.

Attributions

All content for this solution is sourced from the original question on Stackoverflow.

The content on this page is licensed under the Attribution-ShareAlike 4.0 International (CC BY-SA 4.0) license.

Content TypeOriginal AuthorOriginal Content on Stackoverflow
QuestionMetaChromeView Question on Stackoverflow
Solution 1 - JavaPolyTekPatrickView Answer on Stackoverflow
Solution 2 - JavawjansView Answer on Stackoverflow
Solution 3 - JavaRakuView Answer on Stackoverflow
Solution 4 - JavapillingworthView Answer on Stackoverflow
Solution 5 - JavaRay ToalView Answer on Stackoverflow
Solution 6 - JavaOndrej BurkertView Answer on Stackoverflow