Lombok annotation @Getter for boolean field

Question

I am using Java lombok annotation @Getter to generate getters for my POJO. I have a boolean field by the name isAbc.

The @Getter annotation in this case generates a method by the name isAbc(). Shouldn't it generate a method by the name isIsAbc()?

It's an old question, but see if this tutorial of any use: https://www.baeldung.com/lombok-getter-boolean — Nestor Milyaev, Jan 06 '22 at 16:03

score 116 · Accepted Answer · edited Mar 06 '17 at 08:55

116

Read the 'small print' section on the lombok page https://projectlombok.org/features/GetterSetter.html

For boolean fields that start with is immediately followed by a title-case letter, nothing is prefixed to generate the getter name.

So the behavior you experience is as specified.

Note that the behavior is different for boolean and Boolean:

@Getter
private boolean isGood; // => isGood()

@Getter
private boolean good; // => isGood()

@Getter
private Boolean isGood; // => getIsGood()

edited Mar 06 '17 at 08:55

Sergii Bishyr

8,331
6
40
69

answered Mar 06 '17 at 07:44

Harald Gliebe

7,236
3
33
38

@serghey-bishyr you should write your own answer and not extend existing one. – alex Mar 06 '17 at 09:49
6

@dit my answer won't be any different from existing one, just with some additional notes. – Sergii Bishyr Mar 06 '17 at 09:52
2

what about setters in these cases – whishky Jan 04 '18 at 10:39
1

@whishky For setters, "is" prefix is ignored. This means private boolean isGood; // => setGood() – comiventor Jan 11 '18 at 17:20
1

@SergiiBishyr Thanks for improving the answer. That was definitely the right approach. – Dominic Cronin Oct 09 '20 at 15:42
very confusing this difference between `boolean` and `Boolean`. Or is it because Boolean can be null. – ch1ll Mar 08 '23 at 07:30

Kent Munthe Caspersen · Answer 2 · 2022-02-22T12:38:05.853

Lombok does not prefix with is if the name already starts with is followed by an uppercase letter as in isGood.

You might encounter names like canDelete which will generate a getter with the name isCanDelete. To avoid this you can use the fluent parameter:

@Getter(fluent = true)
private boolean canDelete;

or (depending on version):

@Getter
@Accessors(fluent = true)
private boolean canDelete;

In which case it will leave the name as it is so the getter becomes canDelete().

score 12 · Answer 3 · edited Jul 17 '19 at 23:14

12

I do some tests against the lombok(1.16.8), and the conclusions are as below.

private Boolean good;

getter => getGood()              Boolean
setter => setGood(Boolean good)  void 


private boolean good;

getter => isGood()               boolean
setter => setGood(boolean good)  void 


private Boolean isGood;

getter => getIsGood()            Boolean
setter => setIsGood()            void 


private boolean isGood;

getter => isGood()               boolean
setter => setGood(boolean good)  void

edited Jul 17 '19 at 23:14

David Siegal

4,518
2
17
15

answered Sep 14 '18 at 10:05

Sunny

129
1
3

2

How to force Lombok to generate isGood for getter on non-primitive types like `Boolean isGood` ? – Andrew Feb 02 '23 at 10:27

Lombok annotation @Getter for boolean field

3 Answers3

Linked

Related