A

AccessLevel - Enum in lombok

Represents an AccessLevel.

Accessors - Annotation Type in lombok.experimental

A container for settings for the generation of getters and setters.

ACCESSORS_CHAIN - Static variable in class lombok.ConfigurationKeys

lombok configuration: lombok.accessors.chain = true | false.

ACCESSORS_FLAG_USAGE - Static variable in class lombok.ConfigurationKeys

lombok configuration: lombok.accessors.flagUsage = WARNING | ERROR.

ACCESSORS_FLUENT - Static variable in class lombok.ConfigurationKeys

lombok configuration: lombok.accessors.fluent = true | false.

ACCESSORS_PREFIX - Static variable in class lombok.ConfigurationKeys

lombok configuration: lombok.accessors.prefix += <String: prefix>.

ADD_FINDBUGS_SUPPRESSWARNINGS_ANNOTATIONS - Static variable in class lombok.ConfigurationKeys

lombok configuration: lombok.extern.findbugs.addSuppressFBWarnings = true | false.

ADD_GENERATED_ANNOTATIONS - Static variable in class lombok.ConfigurationKeys

Deprecated.

Since version 1.16.14, use ConfigurationKeys.ADD_JAVAX_GENERATED_ANNOTATIONS instead.

ADD_JAVAX_GENERATED_ANNOTATIONS - Static variable in class lombok.ConfigurationKeys

lombok configuration: lombok.addJavaxGeneratedAnnotation = true | false.

ADD_LOMBOK_GENERATED_ANNOTATIONS - Static variable in class lombok.ConfigurationKeys

lombok configuration: lombok.addLombokGeneratedAnnotation = true | false.

ALL_ARGS_CONSTRUCTOR_FLAG_USAGE - Static variable in class lombok.ConfigurationKeys

lombok configuration: lombok.allArgsConstructor.flagUsage = WARNING | ERROR.

AllArgsConstructor - Annotation Type in lombok

Generates an all-args constructor.

AllArgsConstructor.AnyAnnotation - Annotation Type in lombok

Deprecated.

Don't use this annotation, ever - Read the documentation.

ANY_CONSTRUCTOR_ADD_CONSTRUCTOR_PROPERTIES - Static variable in class lombok.ConfigurationKeys

lombok configuration: lombok.anyConstructor.addConstructorProperties = true | false.

ANY_CONSTRUCTOR_FLAG_USAGE - Static variable in class lombok.ConfigurationKeys

lombok configuration: lombok.anyConstructor.flagUsage = WARNING | ERROR.

ANY_CONSTRUCTOR_SUPPRESS_CONSTRUCTOR_PROPERTIES - Static variable in class lombok.ConfigurationKeys

Deprecated.

Since version 2.0, use ConfigurationKeys.ANY_CONSTRUCTOR_ADD_CONSTRUCTOR_PROPERTIES instead.

B

Builder - Annotation Type in lombok

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_FLAG_USAGE - Static variable in class lombok.ConfigurationKeys

lombok configuration: lombok.builder.flagUsage = WARNING | ERROR.

Builder.Default - Annotation Type in lombok

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 - Annotation Type in lombok

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.

C

checkNotNull(T, String) - Static method in class lombok.Lombok

Ensures that the value is not null.

Cleanup - Annotation Type in lombok

Ensures the variable declaration that you annotate will be cleaned up by calling its close method, regardless of what happens.

CLEANUP_FLAG_USAGE - Static variable in class lombok.ConfigurationKeys

lombok configuration: lombok.cleanup.flagUsage = WARNING | ERROR.

CommonsLog - Annotation Type in lombok.extern.apachecommons

Causes lombok to generate a logger field.

ConfigurationKeys - Class in lombok

A container class containing all lombok configuration keys that do not belong to a specific annotation.

COPYABLE_ANNOTATIONS - Static variable in class lombok.ConfigurationKeys

lombok configuration: lombok.copyableAnnotations += <TypeName: fully-qualified annotation class name>.

D

Data - Annotation Type in lombok

Generates getters for all fields, a useful toString method, and hashCode and equals implementations that check all non-transient fields.

DATA_FLAG_USAGE - Static variable in class lombok.ConfigurationKeys

lombok configuration: lombok.data.flagUsage = WARNING | ERROR.

Delegate - Annotation Type in lombok

Deprecated.

Use Delegate instead.

Delegate - Annotation Type in lombok.experimental

Put on any field to make lombok generate delegate methods that forward the call to this field.

DELEGATE_FLAG_USAGE - Static variable in class lombok.ConfigurationKeys

lombok configuration: lombok.delegate.flagUsage = WARNING | ERROR.

E

EQUALS_AND_HASH_CODE_CALL_SUPER - Static variable in class lombok.ConfigurationKeys

lombok configuration: lombok.equalsAndHashCode.callSuper = call | ignore | warn.

EQUALS_AND_HASH_CODE_DO_NOT_USE_GETTERS - Static variable in class lombok.ConfigurationKeys

lombok configuration: lombok.equalsAndHashCode.doNotUseGetters = true | false.

EQUALS_AND_HASH_CODE_FLAG_USAGE - Static variable in class lombok.ConfigurationKeys

lombok configuration: lombok.equalsAndHashCode.flagUsage = WARNING | ERROR.

EqualsAndHashCode - Annotation Type in lombok

Generates implementations for the equals and hashCode methods inherited by all objects, based on relevant fields.

EqualsAndHashCode.AnyAnnotation - Annotation Type in lombok

Deprecated.

Don't use this annotation, ever - Read the documentation.

EqualsAndHashCode.Exclude - Annotation Type in lombok

If present, do not include this field in the generated equals and hashCode methods.

EqualsAndHashCode.Include - Annotation Type in lombok

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.

EXPERIMENTAL_FLAG_USAGE - Static variable in class lombok.ConfigurationKeys

lombok configuration: lombok.experimental.flagUsage = WARNING | ERROR.

EXTENSION_METHOD_FLAG_USAGE - Static variable in class lombok.ConfigurationKeys

lombok configuration: lombok.extensionMethod.flagUsage = WARNING | ERROR.

ExtensionMethod - Annotation Type in lombok.experimental

Extension methods enable you to "add" methods to existing types without creating a new derived type, recompiling, or otherwise modifying the original type.

F

FIELD_DEFAULTS_FINAL_EVERYWHERE - Static variable in class lombok.ConfigurationKeys

lombok configuration: lombok.fieldDefaults.defaultFinal = true | false.

FIELD_DEFAULTS_FLAG_USAGE - Static variable in class lombok.ConfigurationKeys

lombok configuration: lombok.fieldDefaults.flagUsage = WARNING | ERROR.

FIELD_DEFAULTS_PRIVATE_EVERYWHERE - Static variable in class lombok.ConfigurationKeys

lombok configuration: lombok.fieldDefaults.defaultPrivate = true | false.

FIELD_NAME_CONSTANTS_FLAG_USAGE - Static variable in class lombok.ConfigurationKeys

lombok configuration: lombok.fieldNameConstants.flagUsage = WARNING | ERROR.

FIELD_NAME_CONSTANTS_INNER_TYPE_NAME - Static variable in class lombok.ConfigurationKeys

lombok configuration: lombok.fieldNameConstants.innerTypeName = <String: AValidJavaTypeName> (Default: Fields).

FieldDefaults - Annotation Type in lombok.experimental

Adds modifiers to each field in the type with this annotation.

FieldNameConstants - Annotation Type in lombok.experimental

Generates an inner type, containing String constants containing the field name for each field.

FieldNameConstants.Exclude - Annotation Type in lombok.experimental

If present, do not include this field in the generated fieldnames inner type.

FieldNameConstants.Include - Annotation Type in lombok.experimental

If present, include this field in the generated fieldnames inner type (default).

Flogger - Annotation Type in lombok.extern.flogger

Causes lombok to generate a logger field.

G

Generated - Annotation Type in lombok

Lombok will eventually automatically add this annotation to all generated constructors, methods, fields, and types.

Getter - Annotation Type in lombok

Put on any field to make lombok build a standard getter.

GETTER_CONSEQUENT_BOOLEAN - Static variable in class lombok.ConfigurationKeys

lombok configuration: lombok.getter.noIsPrefix = true | false.

GETTER_FLAG_USAGE - Static variable in class lombok.ConfigurationKeys

lombok configuration: lombok.getter.flagUsage = WARNING | ERROR.

GETTER_LAZY_FLAG_USAGE - Static variable in class lombok.ConfigurationKeys

lombok configuration: lombok.getter.lazy.flagUsage = WARNING | ERROR.

Getter.AnyAnnotation - Annotation Type in lombok

Deprecated.

Don't use this annotation, ever - Read the documentation.

H

Helper - Annotation Type in lombok.experimental

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.

HELPER_FLAG_USAGE - Static variable in class lombok.ConfigurationKeys

lombok configuration: lombok.helper.flagUsage = WARNING | ERROR.

J

JBossLog - Annotation Type in lombok.extern.jbosslog

Causes lombok to generate a logger field.

L

Log - Annotation Type in lombok.extern.java

Causes lombok to generate a logger field.

LOG_ANY_FIELD_IS_STATIC - Static variable in class lombok.ConfigurationKeys

lombok configuration: lombok.log.fieldIsStatic = true | false.

LOG_ANY_FIELD_NAME - Static variable in class lombok.ConfigurationKeys

lombok configuration: lombok.log.fieldName = <String: aJavaIdentifier> (Default: log).

LOG_ANY_FLAG_USAGE - Static variable in class lombok.ConfigurationKeys

lombok configuration: lombok.log.flagUsage = WARNING | ERROR.

LOG_COMMONS_FLAG_USAGE - Static variable in class lombok.ConfigurationKeys

lombok configuration: lombok.log.apacheCommons.flagUsage = WARNING | ERROR.

LOG_FLOGGER_FLAG_USAGE - Static variable in class lombok.ConfigurationKeys

lombok configuration: lombok.log.flogger.flagUsage = WARNING | ERROR.

LOG_JBOSSLOG_FLAG_USAGE - Static variable in class lombok.ConfigurationKeys

lombok configuration: lombok.log.jbosslog.flagUsage = WARNING | ERROR.

LOG_JUL_FLAG_USAGE - Static variable in class lombok.ConfigurationKeys

lombok configuration: lombok.log.javaUtilLogging.flagUsage = WARNING | ERROR.

LOG_LOG4J_FLAG_USAGE - Static variable in class lombok.ConfigurationKeys

lombok configuration: lombok.log.log4j.flagUsage = WARNING | ERROR.

LOG_LOG4J2_FLAG_USAGE - Static variable in class lombok.ConfigurationKeys

lombok configuration: lombok.log.log4j2.flagUsage = WARNING | ERROR.

LOG_SLF4J_FLAG_USAGE - Static variable in class lombok.ConfigurationKeys

lombok configuration: lombok.log.slf4j.flagUsage = WARNING | ERROR.

LOG_XSLF4J_FLAG_USAGE - Static variable in class lombok.ConfigurationKeys

lombok configuration: lombok.log.xslf4j.flagUsage = WARNING | ERROR.

Log4j - Annotation Type in lombok.extern.log4j

Causes lombok to generate a logger field.

Log4j2 - Annotation Type in lombok.extern.log4j

Causes lombok to generate a logger field.

lombok - package lombok

This package contains all the annotations and support classes you need as a user of lombok.

Lombok - Class in lombok

Useful utility methods to manipulate lombok-generated code.

Lombok() - Constructor for class lombok.Lombok

 

LOMBOK_DISABLE - Static variable in class lombok.ConfigurationKeys

lombok configuration: dangerousconfig.lombok.disable = true | false.

lombok.experimental - package lombok.experimental

This package contains the annotations and support classes you need as a user of lombok, for all features which aren't (yet) supported as a first class feature.

lombok.extern.apachecommons - package lombok.extern.apachecommons

 

lombok.extern.flogger - package lombok.extern.flogger

 

lombok.extern.java - package lombok.extern.java

 

lombok.extern.jbosslog - package lombok.extern.jbosslog

 

lombok.extern.log4j - package lombok.extern.log4j

 

lombok.extern.slf4j - package lombok.extern.slf4j

 

M

MODULE - lombok.AccessLevel

 

N

NO_ARGS_CONSTRUCTOR_EXTRA_PRIVATE - Static variable in class lombok.ConfigurationKeys

lombok configuration: lombok.noArgsConstructor.extraPrivate = true | false.

NO_ARGS_CONSTRUCTOR_FLAG_USAGE - Static variable in class lombok.ConfigurationKeys

lombok configuration: lombok.noArgsConstructor.flagUsage = WARNING | ERROR.

NoArgsConstructor - Annotation Type in lombok

Generates a no-args constructor.

NoArgsConstructor.AnyAnnotation - Annotation Type in lombok

Deprecated.

Don't use this annotation, ever - Read the documentation.

NON_NULL_EXCEPTION_TYPE - Static variable in class lombok.ConfigurationKeys

lombok configuration: lombok.nonNull.exceptionType = <String: a java exception type; either [IllegalArgumentException or: NullPointerException].

NON_NULL_FLAG_USAGE - Static variable in class lombok.ConfigurationKeys

lombok configuration: lombok.nonNull.flagUsage = WARNING | ERROR.

NONE - lombok.AccessLevel

Represents not generating anything or the complete lack of a method.

NonFinal - Annotation Type in lombok.experimental

Used to indicate the explicit intention for the annotated entity to not be final.

NonNull - Annotation Type in lombok

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.

O

ON_X_FLAG_USAGE - Static variable in class lombok.ConfigurationKeys

lombok configuration: lombok.onX.flagUsage = WARNING | ERROR.

P

PACKAGE - lombok.AccessLevel

 

PackagePrivate - Annotation Type in lombok.experimental

Used to indicate the explicit intention for the annotated entity to have the package private access level.

preventNullAnalysis(T) - Static method in class lombok.Lombok

Returns the parameter directly.

PRIVATE - lombok.AccessLevel

 

PROTECTED - lombok.AccessLevel

 

PUBLIC - lombok.AccessLevel

 

R

REQUIRED_ARGS_CONSTRUCTOR_FLAG_USAGE - Static variable in class lombok.ConfigurationKeys

lombok configuration: lombok.requiredArgsConstructor.flagUsage = WARNING | ERROR.

RequiredArgsConstructor - Annotation Type in lombok

Generates a constructor with required arguments.

RequiredArgsConstructor.AnyAnnotation - Annotation Type in lombok

Deprecated.

Don't use this annotation, ever - Read the documentation.

S

Setter - Annotation Type in lombok

Put on any field to make lombok build a standard setter.

SETTER_FLAG_USAGE - Static variable in class lombok.ConfigurationKeys

lombok configuration: lombok.setter.flagUsage = WARNING | ERROR.

Setter.AnyAnnotation - Annotation Type in lombok

Deprecated.

Don't use this annotation, ever - Read the documentation.

Singular - Annotation Type in lombok

The singular annotation is used together with @Builder to create single element 'add' methods in the builder for collections.

SINGULAR_AUTO - Static variable in class lombok.ConfigurationKeys

lombok configuration: lombok.singular.auto = true | false.

SINGULAR_USE_GUAVA - Static variable in class lombok.ConfigurationKeys

lombok configuration: lombok.singular.useGuava = true | false.

Slf4j - Annotation Type in lombok.extern.slf4j

Causes lombok to generate a logger field.

SNEAKY_THROWS_FLAG_USAGE - Static variable in class lombok.ConfigurationKeys

lombok configuration: lombok.sneakyThrows.flagUsage = WARNING | ERROR.

sneakyThrow(Throwable) - Static method in class lombok.Lombok

Throws any throwable 'sneakily' - you don't need to catch it, nor declare that you throw it onwards.

SneakyThrows - Annotation Type in lombok

@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.

STOP_BUBBLING - Static variable in class lombok.ConfigurationKeys

lombok configuration: config.stopBubbling = true | false.

SuperBuilder - Annotation Type in lombok.experimental

The SuperBuilder annotation creates a so-called 'builder' aspect to the class that is annotated with @SuperBuilder, but which works well when extending.

SUPERBUILDER_FLAG_USAGE - Static variable in class lombok.ConfigurationKeys

lombok configuration: lombok.superBuilder.flagUsage = WARNING | ERROR.

Synchronized - Annotation Type in lombok

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.

SYNCHRONIZED_FLAG_USAGE - Static variable in class lombok.ConfigurationKeys

lombok configuration: lombok.synchronized.flagUsage = WARNING | ERROR.

T

TO_STRING_CALL_SUPER - Static variable in class lombok.ConfigurationKeys

lombok configuration: lombok.toString.callSuper = call | ignore | warn.

TO_STRING_DO_NOT_USE_GETTERS - Static variable in class lombok.ConfigurationKeys

lombok configuration: lombok.toString.doNotUseGetters = true | false.

TO_STRING_FLAG_USAGE - Static variable in class lombok.ConfigurationKeys

lombok configuration: lombok.toString.flagUsage = WARNING | ERROR.

TO_STRING_INCLUDE_FIELD_NAMES - Static variable in class lombok.ConfigurationKeys

lombok configuration: lombok.toString.includeFieldNames = true | false.

Tolerate - Annotation Type in lombok.experimental

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 - Annotation Type in lombok

Generates an implementation for the toString method inherited by all objects, consisting of printing the values of relevant fields.

ToString.Exclude - Annotation Type in lombok

If present, do not include this field in the generated toString.

ToString.Include - Annotation Type in lombok

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.

U

UTILITY_CLASS_FLAG_USAGE - Static variable in class lombok.ConfigurationKeys

lombok configuration: lombok.utilityClass.flagUsage = WARNING | ERROR.

UtilityClass - Annotation Type in lombok.experimental

An annotation to create utility classes.

V

val - Annotation Type in lombok

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.

VAL_FLAG_USAGE - Static variable in class lombok.ConfigurationKeys

lombok configuration: lombok.val.flagUsage = WARNING | ERROR.

Value - Annotation Type in lombok

Generates a lot of code which fits with a class that is a representation of an immutable entity.

VALUE_FLAG_USAGE - Static variable in class lombok.ConfigurationKeys

lombok configuration: lombok.value.flagUsage = WARNING | ERROR.

valueOf(String) - Static method in enum lombok.AccessLevel

Returns the enum constant of this type with the specified name.

values() - Static method in enum lombok.AccessLevel

Returns an array containing the constants of this enum type, in the order they are declared.

var - Annotation Type in lombok.experimental

Deprecated.

var has been promoted to the main package; use var instead.

var - Annotation Type in lombok

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).

VAR_FLAG_USAGE - Static variable in class lombok.ConfigurationKeys

 

W

Wither - Annotation Type in lombok.experimental

Put on any field to make lombok build a 'wither' - a withX method which produces a clone of this object (except for 1 field which gets a new value).

WITHER_FLAG_USAGE - Static variable in class lombok.ConfigurationKeys

lombok configuration: lombok.wither.flagUsage = WARNING | ERROR.

Wither.AnyAnnotation - Annotation Type in lombok.experimental

Deprecated.

Don't use this annotation, ever - Read the documentation.

X

XSlf4j - Annotation Type in lombok.extern.slf4j

Causes lombok to generate a logger field.