From ee82cda22901c029bec4b886c3658ce93cf0f2ef Mon Sep 17 00:00:00 2001 From: DongNyoung Lee <121621378+Dongnyoung@users.noreply.github.com> Date: Tue, 13 Jan 2026 22:56:36 +0900 Subject: [PATCH] refactor: improve description Added constraints for using @Getter(lazy=true) in documentation. --- website/templates/features/GetterLazy.html | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/website/templates/features/GetterLazy.html b/website/templates/features/GetterLazy.html index e921712c..aacb0627 100644 --- a/website/templates/features/GetterLazy.html +++ b/website/templates/features/GetterLazy.html @@ -7,7 +7,16 @@ <@f.overview>

- You can let lombok generate a getter which will calculate a value once, the first time this getter is called, and cache it from then on. This can be useful if calculating the value takes a lot of CPU, or the value takes a lot of memory. To use this feature, create a private final variable, initialize it with the expression that's expensive to run, and annotate your field with @Getter(lazy=true). The field will be hidden from the rest of your code, and the expression will be evaluated no more than once, when the getter is first called. There are no magic marker values (i.e. even if the result of your expensive calculation is null, the result is cached) and your expensive calculation need not be thread-safe, as lombok takes care of locking. + You can let lombok generate a getter which will calculate a value once, the first time this getter is called, and cache it from then on. This can be useful if calculating the value takes a lot of CPU, or the value takes a lot of memory. To use this feature, create a private final variable, initialize it with the expression that's expensive to run, and annotate your field with @Getter(lazy=true). +

+ The following constraints apply when using @Getter(lazy=true): +

+ + The field will be hidden from the rest of your code, and the expression will be evaluated no more than once, when the getter is first called. There are no magic marker values (i.e. even if the result of your expensive calculation is null, the result is cached) and your expensive calculation need not be thread-safe, as lombok takes care of locking.

If the initialization expression is complex, or contains generics, we recommend moving the code to a private (if possible static) method, and call that instead.