The Lombok javadoc is available, but we advise these pages.
val
Finally! Hassle-free final local variables.
var
Mutably! Hassle-free local variables.
@NonNull
or: How I learned to stop worrying and love the NullPointerException.
@Cleanup
Automatic resource management: Call your
close() methods safely with no hassle.@Getter/@Setter
Never write
public int getFoo() {return foo;} again.@ToString
No need to start a debugger to see your fields: Just let lombok generate a
toString for you!@EqualsAndHashCode
Equality made easy: Generates
hashCode and equals implementations from the fields of your object..@NoArgsConstructor, @RequiredArgsConstructor and @AllArgsConstructor
Constructors made to order: Generates constructors that take no arguments, one argument per final / non-nullfield, or one argument for every field.
@Data
All together now: A shortcut for
@ToString, @EqualsAndHashCode, @Getter on all fields, and @Setter on all non-final fields, and @RequiredArgsConstructor!@Value
Immutable classes made very easy.
@Builder
... and Bob's your uncle: No-hassle fancy-pants APIs for object creation!
@SneakyThrows
To boldly throw checked exceptions where no one has thrown them before!
@Synchronized
synchronized done right: Don't expose your locks.@With
Immutable 'setters' - methods that create a clone but with one changed field.
@Getter(lazy=true)
Laziness is a virtue!
@Log
Captain's Log, stardate 24435.7: "What was that line again?"
experimental
Head to the lab: The new stuff we're working on.
Configuration system
Lombok, made to order: Configure lombok features in one place for your entire project or even your workspace.
Running delombok
Delombok copies your source files to another directory, replacing all lombok annotations with their desugared form. So, it'll turn
@Getter back into the actual getter. It then removes the annotation. This is useful for all sorts of reasons; you can check out what's happening under the hood, if the unthinkable happens and you want to stop using lombok, you can easily remove all traces of it in your source, and you can use delombok to preprocess your source files for source-level tools such as javadoc and GWT. More information about how to run delombok, including instructions for build tools can be found at the delombok page.Reference: