For generating the method names, the first character of the field, if it is a lowercase character, is title-cased, otherwise, it is left unmodified. Then, get/set/is is prefixed.
No method is generated if any method already exists with the same name (case insensitive) and same parameter count. For example,
getFoo() will not be generated if there's already a method
getFoo(String... x) even though it is technically possible to make the method. This caveat exists to prevent confusion. If the generation of a method is skipped for this reason, a warning is emitted instead. Varargs count as 0 to N parameters. You can mark any method with
@lombok.experimental.Tolerate to hide them from lombok.
boolean fields that start with
is immediately followed by a title-case letter, nothing is prefixed to generate the getter name.
Any variation on
boolean will not result in using the
is prefix instead of the
get prefix; for example,
java.lang.Boolean results in a
get prefix, not an
Any annotations named
@NonNull (case insensitive) on the field are interpreted as: This field must not ever hold
null. Therefore, these annotations result in an explicit null check in the generated setter. Also, these
annotations (as well as any annotation named
@CheckForNull) are copied to setter parameter and getter method.
You can annotate a class with a
@Setter annotation. Doing so is equivalent to annotating all non-static fields
in that class with that annotation.
@Setter annotations on fields take precedence over the ones on classes.
AccessLevel.NONE access level simply generates nothing. It's useful only in combination with
@Data or a class-wide
@Getter can also be used on enums.
@Setter can't, not for a technical reason, but
for a pragmatic one: Setters on enums are an extremely bad idea.