Course contentsShow
← Java
Lesson 1894 of 2,87038. Date and Time API (java.time)Free lesson

DateTimeFormatterBuilder for Advanced Formatting

Constructing complex formatters programmatically with optional sections, padding, and custom parsing rules.

DateTimeFormatterBuilder for Advanced Formatting

What you'll learn: How to construct sophisticated date-time formatters programmatically with optional sections, custom padding, and flexible parsing rules that go beyond simple pattern strings.

Why Use DateTimeFormatterBuilder?

While DateTimeFormatter.ofPattern() works well for straightforward formats, real-world scenarios often demand more flexibility. What if a field is optional? What if you need custom padding or multiple parsing strategies? DateTimeFormatterBuilder lets you build formatters piece by piece with fine-grained control—think of it as assembling a formatter with Lego blocks rather than writing a single pattern string.

Building Formatters Programmatically

The DateTimeFormatterBuilder provides methods to append specific components:

DateTimeFormatter formatter = new DateTimeFormatterBuilder()
    .appendValue(ChronoField.YEAR, 4)
    .appendLiteral('-')
    .appendValue(ChronoField.MONTH_OF_YEAR, 2)
    .appendLiteral('-')
    .appendValue(ChronoField.DAY_OF_MONTH, 2)
    .toFormatter();

LocalDate date = LocalDate.of(2024, 3, 5);
System.out.println(date.format(formatter)); // "2024-03-05"

Optional Sections

Use appendOptional() to handle fields that may or may not be present:

DateTimeFormatter formatter = new DateTimeFormatterBuilder()
    .appendValue(ChronoField.YEAR, 4)
    .appendLiteral('-')
    .appendValue(ChronoField.MONTH_OF_YEAR, 2)
    .appendOptional(new DateTimeFormatterBuilder()
        .appendLiteral('T')
        .appendValue(ChronoField.HOUR_OF_DAY, 2)
        .toFormatter())
    .toFormatter();

// Parses both "2024-03" and "2024-03T14"

Padding and Custom Rules

Control padding with appendValue(field, minWidth, maxWidth, signStyle) and use methods like padNext() for custom spacing. You can even combine multiple parsing strategies using appendPattern() within the builder for fallback logic.

Key Takeaway: DateTimeFormatterBuilder gives you programmatic control over complex formatting requirements—use it when pattern strings become unwieldy or when you need optional sections, custom padding, or sophisticated parsing strategies.