All Classes and Interfaces
Class
Description
Represents an AccessLevel.
A container for settings for the generation of getters, setters and "with"-ers.
Generates an all-args constructor.
Deprecated.
Don't use this annotation, ever - Read the documentation.
The builder annotation creates a so-called 'builder' aspect to the class that is annotated or the class
that contains a member which is annotated with
@Builder.The field annotated with
@Default must have an initializing expression; that expression is taken as the default to be used if not explicitly set during building.Put on a field (in case of
@Builder on a type) or a parameter (for @Builder on a constructor or static method) to
indicate how lombok should obtain a value for this field or parameter given an instance; this is only relevant if toBuilder is true.Ensures the variable declaration that you annotate will be cleaned up by calling its close method, regardless
of what happens.
Causes lombok to generate a logger field.
A container class containing all lombok configuration keys that do not belong to a specific annotation.
Causes lombok to generate a logger field based on a custom logger implementation.
Generates getters for all fields, a useful toString method, and hashCode and equals implementations that check
all non-transient fields.
Deprecated.
Use
Delegate instead.Put on any field to make lombok generate delegate methods that forward the call to this field.
Generates implementations for the
equals and hashCode methods inherited by all objects, based on relevant fields.Deprecated.
Don't use this annotation, ever - Read the documentation.
If present, do not include this field in the generated
equals and hashCode methods.Configure the behaviour of how this member is treated in the
equals and hashCode implementation; if on a method, include the method's return value as part of calculating hashCode/equality.Extension methods enable you to "add" methods to existing types without creating a new derived type, recompiling, or
otherwise modifying the original type.
Adds modifiers to each field in the type with this annotation.
Generates an inner type, containing String constants containing the field name for each field.
If present, do not include this field in the generated fieldnames inner type.
If present, include this field in the generated fieldnames inner type (default).
Causes lombok to generate a logger field.
Lombok automatically adds this annotation to all generated constructors, methods, fields, and types.
Put on any field to make lombok build a standard getter.
Deprecated.
Don't use this annotation, ever - Read the documentation.
Use on a method local class to indicate that all methods inside should be exposed to the rest of
the method as if they were helper methods.
Causes lombok to generate a logger field.
Guards all statements in an annotation method with a
Lock.Locks using a
ReadWriteLock.readLock().Locks using a
ReadWriteLock.writeLock().Causes lombok to generate a logger field.
Causes lombok to generate a logger field.
Causes lombok to generate a logger field.
Useful utility methods to manipulate lombok-generated code.
Generates a no-args constructor.
Deprecated.
Don't use this annotation, ever - Read the documentation.
Used to indicate the explicit intention for the annotated entity to not be
final.If put on a parameter, lombok will insert a null-check at the start of the method / constructor's body, throwing a
NullPointerException with the parameter's name as message.Used to indicate the explicit intention for the annotated entity to have the package private access level.
Generates a constructor with required arguments.
Deprecated.
Don't use this annotation, ever - Read the documentation.
Put on any field to make lombok build a standard setter.
Deprecated.
Don't use this annotation, ever - Read the documentation.
The singular annotation is used together with
@Builder to create single element 'add' methods in the builder for collections.Causes lombok to generate a logger field.
@SneakyThrows will avoid javac's insistence that you either catch or throw onward any checked exceptions that
statements in your method body declare they generate.
Put on any class that extends some
java.lang.Throwable type to add the 4 common exception constructors.The SuperBuilder annotation creates a so-called 'builder' aspect to the class that is annotated with
@SuperBuilder, but which works well when extending.Almost exactly like putting the 'synchronized' keyword on a method, except will synchronize on a private internal
Object, so that other code not under your control doesn't meddle with your thread management by locking on
your own instance.
Put on any method or constructor to make lombok pretend it doesn't exist,
i.e., to generate a method which would otherwise be skipped due to possible conflicts.
Generates an implementation for the
toString method inherited by all objects, consisting of printing the values of relevant fields.If present, do not include this field in the generated
toString.Configure the behaviour of how this member is rendered in the
toString; if on a method, include the method's return value in the output.An annotation to create utility classes.
Use
val as the type of any local variable declaration (even in a for-each statement), and the type will be inferred from the initializing expression.Generates a lot of code which fits with a class that is a representation of an immutable entity.
Deprecated.
var has been promoted to the main package; use var instead.Use
var as the type of any local variable declaration (even in a for statement), and the type will be inferred from the initializing expression
(any further assignments to the variable are not involved in this type inference).Put on any field to make lombok build a 'with' - a withX method which produces a clone of this object (except for 1 field which gets a new value).
Deprecated.
Don't use this annotation, ever - Read the documentation.
Put on any field to make lombok build a 'withBy' - a withFieldNameBy method which produces a clone of this object (except for 1 field which gets a new value).
Deprecated.
Don't use this annotation, ever - Read the documentation.
Deprecated.
With has been promoted to the main package, so use that one instead.Deprecated.
Don't use this annotation, ever - Read the documentation.
Causes lombok to generate a logger field.