formatting

Code Formatting Conventions

Parameter Alignment Rules

General Principle

When a method, constructor, or annotation has more than 2 parameters, place each parameter on its own line. For short parameter lists (1-2 params) that fit within the line width (120 chars), keep them on the same line.

Key Rules

1. Every closing bracket on its own line - When an annotation/method is wrapped, the closing ) goes on a new line
2. Each annotation on its own line - Multiple annotations on a parameter/field are each on separate lines
3. Field/variable on its own line - After annotations, the field declaration goes on a new line

Annotations with Multiple Parameters

When an annotation has more than 2 parameters, wrap with each on its own line:

// GOOD - Each param and closing bracket on own line
@Schema(
		description = "ISO 6346 container number (4 uppercase letters + 7 digits)",
		example = "MSCU1234567",
		pattern = "^[A-Z]{4}[0-9]{7}$",
		minLength = 11,
		maxLength = 11,
		requiredMode = Schema.RequiredMode.REQUIRED
)
@NotBlank(message = "Container number is required")
@Size(min = 11, max = 11, message = "Container number must be exactly 11 characters")
@Pattern(
		regexp = "^[A-Z]{4}[0-9]{7}$",
		message = "Container number must be in ISO 6346 format (4 letters + 7 digits)"
)
String containerNumber;  // Field on its own line

// GOOD - Short annotation (fits on one line)
@Size(min = 11, max = 11)
@NotBlank(message = "Required")
String value;

Multiple Annotations on Parameters

Each annotation must be on its own line:

// GOOD - Each annotation on separate line, field at the end
@Schema(description = "Container number", example = "MSCU1234567")
@NotBlank(message = "Required")
@Size(min = 11, max = 11)
String containerNumber;

// BAD - Annotations chained on same line
@Schema(...) @NotBlank(...) @Size(...) String containerNumber;

Method Invocations

When a method call has more than 2 arguments, wrap each on its own line with closing paren on its own line: