This package contains all the annotations and support classes you need as a user of lombok. All other packages are only relevant to those who are extending lombok for their own uses, except:
lombok.extern.*– These packages contains lombok annotations that solve boilerplate issues for libraries not part of the JRE itself.
lombok.experimental– This package contains lombok features that are new or likely to change before committing to long-term support.
- See Also:
- Lombok features
Class Summary Class Description ConfigurationKeysA container class containing all lombok configuration keys that do not belong to a specific annotation. LombokUseful utility methods to manipulate lombok-generated code.
Enum Summary Enum Description AccessLevelRepresents an AccessLevel.
Annotation Types Summary Annotation Type Description AllArgsConstructorGenerates an all-args constructor. AllArgsConstructor.AnyAnnotation Deprecated.Don't use this annotation, ever - Read the documentation. BuilderThe 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.DefaultThe field annotated with
@Defaultmust have an initializing expression; that expression is taken as the default to be used if not explicitly set during building.
Builder.ObtainViaPut on a field (in case of
@Builderon a type) or a parameter (for
@Builderon 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
CleanupEnsures the variable declaration that you annotate will be cleaned up by calling its close method, regardless of what happens. DataGenerates getters for all fields, a useful toString method, and hashCode and equals implementations that check all non-transient fields. Delegate Deprecated.Use
EqualsAndHashCodeGenerates implementations for the
hashCodemethods inherited by all objects, based on relevant fields.
EqualsAndHashCode.AnyAnnotation Deprecated.Don't use this annotation, ever - Read the documentation. EqualsAndHashCode.ExcludeIf present, do not include this field in the generated
EqualsAndHashCode.IncludeConfigure the behaviour of how this member is treated in the
hashCodeimplementation; if on a method, include the method's return value as part of calculating hashCode/equality.
GeneratedLombok will eventually automatically add this annotation to all generated constructors, methods, fields, and types. GetterPut on any field to make lombok build a standard getter. Getter.AnyAnnotation Deprecated.Don't use this annotation, ever - Read the documentation. NoArgsConstructorGenerates a no-args constructor. NoArgsConstructor.AnyAnnotation Deprecated.Don't use this annotation, ever - Read the documentation. NonNullIf put on a parameter, lombok will insert a null-check at the start of the method / constructor's body, throwing a
NullPointerExceptionwith the parameter's name as message.
RequiredArgsConstructorGenerates a constructor with required arguments. RequiredArgsConstructor.AnyAnnotation Deprecated.Don't use this annotation, ever - Read the documentation. SetterPut on any field to make lombok build a standard setter. Setter.AnyAnnotation Deprecated.Don't use this annotation, ever - Read the documentation. SingularThe singular annotation is used together with
@Builderto create single element 'add' methods in the builder for collections.
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. SynchronizedAlmost 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. ToStringGenerates an implementation for the
toStringmethod inherited by all objects, consisting of printing the values of relevant fields.
ToString.ExcludeIf present, do not include this field in the generated
ToString.IncludeConfigure the behaviour of how this member is rendered in the
toString; if on a method, include the method's return value in the output.
valas the type of any local variable declaration (even in a for-each statement), and the type will be inferred from the initializing expression.
ValueGenerates a lot of code which fits with a class that is a representation of an immutable entity. varUse
varas the type of any local variable declaration (even in a
forstatement), and the type will be inferred from the initializing expression (any further assignments to the variable are not involved in this type inference).