Skip to content

docs: clarify Immutable Object pattern in Value Object README (fixes #3448)#3449

Open
Senrian wants to merge 1 commit intoiluwatar:masterfrom
Senrian:master
Open

docs: clarify Immutable Object pattern in Value Object README (fixes #3448)#3449
Senrian wants to merge 1 commit intoiluwatar:masterfrom
Senrian:master

Conversation

@Senrian
Copy link

@Senrian Senrian commented Mar 20, 2026

Fixes Issue #3448: Missing Pattern Immutable

The issue requests adding the Immutable Object pattern to the repository. This PR addresses it by:

  1. Promoting "Immutable Object" to the first entry in "Also known as" - making it clear that Value Object and Immutable Object are the same pattern
  2. Updating the Intent section - Renamed to "Intent of Value Object / Immutable Object Design Pattern" and added explicit mention of the Immutable Object pattern benefits

Note: The Value Object pattern already implements the Immutable Object pattern (using Lombok @Value annotation). This PR makes that relationship explicit in the documentation.

@github-actions
Copy link

github-actions bot commented Mar 20, 2026

PR Summary

Resolved issue #3448 by clarifying the Immutable Object pattern in the Value Object README: promoted 'Immutable Object' in the 'Also known as' section, and updated the Intent section header to 'Intent of Value Object / Immutable Object Design Pattern' with explicit benefits of the Immutable Object pattern.

Changes

File Summary
value-object/README.md Reordered 'Also known as' to promote 'Immutable Object' as a primary alias and added 'Inline Value' and 'Integrated Value' variants; updated the Intent header to 'Intent of Value Object / Immutable Object Design Pattern' and added explicit Immutable Object benefits (thread-safety and immutability guarantees).

autogenerated by presubmit.ai

Copy link

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

Review Summary

Commits Considered (1)
  • 47ac069: docs: clarify Immutable Object pattern in Value Object README (fixes #3448)
Files Processed (1)
  • value-object/README.md (2 hunks)
Actionable Comments (0)
Skipped Comments (3)
  • value-object/README.md [22-22]

    readability: "Clarify alias terminology"

  • value-object/README.md [26-26]

    readability: "Clarify cross-reference with implementation"

  • value-object/README.md [28-30]

    readability: "Improve Intent content clarity and Java/Lombok tie-in"

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

1 participant