All Classes

Class Description
AccessLevel
Represents an AccessLevel.
Accessors
A container for settings for the generation of getters and setters.
AllArgsConstructor
Generates an all-args constructor.
AllArgsConstructor.AnyAnnotation Deprecated.
Don't use this annotation, ever - Read the documentation.
Builder
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.
Builder.Default
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.
Builder.ObtainVia
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.
Cleanup
Ensures the variable declaration that you annotate will be cleaned up by calling its close method, regardless of what happens.
CommonsLog
Causes lombok to generate a logger field.
ConfigurationKeys
A container class containing all lombok configuration keys that do not belong to a specific annotation.
CustomLog
Causes lombok to generate a logger field based on a custom logger implementation.
Data
Generates getters for all fields, a useful toString method, and hashCode and equals implementations that check all non-transient fields.
Delegate Deprecated.
Use Delegate instead.
Delegate
Put on any field to make lombok generate delegate methods that forward the call to this field.
EqualsAndHashCode
Generates implementations for the equals and hashCode methods inherited by all objects, based on relevant fields.
EqualsAndHashCode.AnyAnnotation Deprecated.
Don't use this annotation, ever - Read the documentation.
EqualsAndHashCode.Exclude
If present, do not include this field in the generated equals and hashCode methods.
EqualsAndHashCode.Include
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.
ExtensionMethod
Extension methods enable you to "add" methods to existing types without creating a new derived type, recompiling, or otherwise modifying the original type.
FieldDefaults
Adds modifiers to each field in the type with this annotation.
FieldNameConstants
Generates an inner type, containing String constants containing the field name for each field.
FieldNameConstants.Exclude
If present, do not include this field in the generated fieldnames inner type.
FieldNameConstants.Include
If present, include this field in the generated fieldnames inner type (default).
Flogger
Causes lombok to generate a logger field.
Generated
Lombok will eventually automatically add this annotation to all generated constructors, methods, fields, and types.
Getter
Put on any field to make lombok build a standard getter.
Getter.AnyAnnotation Deprecated.
Don't use this annotation, ever - Read the documentation.
Helper
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.
JBossLog
Causes lombok to generate a logger field.
Log
Causes lombok to generate a logger field.
Log4j
Causes lombok to generate a logger field.
Log4j2
Causes lombok to generate a logger field.
Lombok
Useful utility methods to manipulate lombok-generated code.
NoArgsConstructor
Generates a no-args constructor.
NoArgsConstructor.AnyAnnotation Deprecated.
Don't use this annotation, ever - Read the documentation.
NonFinal
Used to indicate the explicit intention for the annotated entity to not be final.
NonNull
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.
PackagePrivate
Used to indicate the explicit intention for the annotated entity to have the package private access level.
RequiredArgsConstructor
Generates a constructor with required arguments.
RequiredArgsConstructor.AnyAnnotation Deprecated.
Don't use this annotation, ever - Read the documentation.
Setter
Put on any field to make lombok build a standard setter.
Setter.AnyAnnotation Deprecated.
Don't use this annotation, ever - Read the documentation.
Singular
The singular annotation is used together with @Builder to create single element 'add' methods in the builder for collections.
Slf4j
Causes lombok to generate a logger field.
SneakyThrows
@SneakyThrow will avoid javac's insistence that you either catch or throw onward any checked exceptions that statements in your method body declare they generate.
SuperBuilder
The SuperBuilder annotation creates a so-called 'builder' aspect to the class that is annotated with @SuperBuilder, but which works well when extending.
Synchronized
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.
Tolerate
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.
ToString
Generates an implementation for the toString method inherited by all objects, consisting of printing the values of relevant fields.
ToString.Exclude
If present, do not include this field in the generated toString.
ToString.Include
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.
UtilityClass
An annotation to create utility classes.
val
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.
Value
Generates a lot of code which fits with a class that is a representation of an immutable entity.
var Deprecated.
var has been promoted to the main package; use var instead.
var
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).
With
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).
With.AnyAnnotation Deprecated.
Don't use this annotation, ever - Read the documentation.
Wither Deprecated.
With has been promoted to the main package, so use that one instead.
Wither.AnyAnnotation Deprecated.
Don't use this annotation, ever - Read the documentation.
XSlf4j
Causes lombok to generate a logger field.