Class ConfigurationKeys
java.lang.Object
lombok.ConfigurationKeys
A container class containing all lombok configuration keys that do not belong to a specific annotation.
-
Field Summary
Modifier and TypeFieldDescriptionstatic final lombok.core.configuration.ConfigurationKey
<Boolean> lombok configuration:lombok.accessors.chain
=true
|false
.static final lombok.core.configuration.ConfigurationKey
<lombok.core.configuration.FlagUsageType> lombok configuration:lombok.accessors.flagUsage
=WARNING
|ERROR
.static final lombok.core.configuration.ConfigurationKey
<Boolean> lombok configuration:lombok.accessors.fluent
=true
|false
.static final lombok.core.configuration.ConfigurationKey
<lombok.core.configuration.CapitalizationStrategy> lombok configuration:lombok.accessors.capitalization
=basic
|beanspec
.static final lombok.core.configuration.ConfigurationKey
<Boolean> lombok configuration:lombok.accessors.makeFinal
=true
|false
.lombok configuration:lombok.accessors.prefix
+= <String: prefix>.static final lombok.core.configuration.ConfigurationKey
<Boolean> lombok configuration:lombok.extern.findbugs.addSuppressFBWarnings
=true
|false
.static final lombok.core.configuration.ConfigurationKey
<Boolean> Deprecated.static final lombok.core.configuration.ConfigurationKey
<Boolean> lombok configuration:lombok.addJakartaGeneratedAnnotation
=true
|false
.static final lombok.core.configuration.ConfigurationKey
<Boolean> lombok configuration:lombok.addJavaxGeneratedAnnotation
=true
|false
.static final lombok.core.configuration.ConfigurationKey
<Boolean> lombok configuration:lombok.addLombokGeneratedAnnotation
=true
|false
.static final lombok.core.configuration.ConfigurationKey
<lombok.core.configuration.NullAnnotationLibrary> lombok configuration:lombok.addNullAnnotations =
one of: [none
,javax
,eclipse
,jetbrains
,netbeans
,androidx
,android.support
,checkerframework
,findbugs
,spring
,JML
, or a custom set of fully qualified annotation types].static final lombok.core.configuration.ConfigurationKey
<Boolean> lombok configuration:lombok.addSuppressWarnings
=true
|false
.static final lombok.core.configuration.ConfigurationKey
<lombok.core.configuration.FlagUsageType> lombok configuration:lombok.allArgsConstructor.flagUsage
=WARNING
|ERROR
.static final lombok.core.configuration.ConfigurationKey
<Boolean> lombok configuration:lombok.anyConstructor.addConstructorProperties
=true
|false
.static final lombok.core.configuration.ConfigurationKey
<lombok.core.configuration.FlagUsageType> lombok configuration:lombok.anyConstructor.flagUsage
=WARNING
|ERROR
.static final lombok.core.configuration.ConfigurationKey
<Boolean> Deprecated.Since version 2.0, useANY_CONSTRUCTOR_ADD_CONSTRUCTOR_PROPERTIES
instead.static final lombok.core.configuration.ConfigurationKey
<String> lombok configuration:lombok.builder.classNames
= <String: aJavaIdentifier (optionally with a star as placeholder for the type name)> (Default:*Builder
).static final lombok.core.configuration.ConfigurationKey
<lombok.core.configuration.FlagUsageType> lombok configuration:lombok.builder.flagUsage
=WARNING
|ERROR
.static final lombok.core.configuration.ConfigurationKey
<lombok.core.configuration.CheckerFrameworkVersion> lombok configuration:checkerframework
=true
|false
| <String: MajorVer.MinorVer> (Default: false).static final lombok.core.configuration.ConfigurationKey
<lombok.core.configuration.FlagUsageType> lombok configuration:lombok.cleanup.flagUsage
=WARNING
|ERROR
.static final lombok.core.configuration.ConfigurationKey
<List<lombok.core.configuration.TypeName>> lombok configuration:lombok.copyableAnnotations
+= <TypeName: fully-qualified annotation class name>.static final lombok.core.configuration.ConfigurationKey
<lombok.core.configuration.FlagUsageType> lombok configuration:lombok.data.flagUsage
=WARNING
|ERROR
.static final lombok.core.configuration.ConfigurationKey
<lombok.core.configuration.FlagUsageType> lombok configuration:lombok.delegate.flagUsage
=WARNING
|ERROR
.static final lombok.core.configuration.ConfigurationKey
<lombok.core.configuration.CallSuperType> lombok configuration:lombok.equalsAndHashCode.callSuper
=call
|ignore
|warn
.static final lombok.core.configuration.ConfigurationKey
<Boolean> lombok configuration:lombok.equalsAndHashCode.doNotUseGetters
=true
|false
.static final lombok.core.configuration.ConfigurationKey
<lombok.core.configuration.FlagUsageType> lombok configuration:lombok.equalsAndHashCode.flagUsage
=WARNING
|ERROR
.static final lombok.core.configuration.ConfigurationKey
<lombok.core.configuration.FlagUsageType> lombok configuration:lombok.experimental.flagUsage
=WARNING
|ERROR
.static final lombok.core.configuration.ConfigurationKey
<lombok.core.configuration.FlagUsageType> lombok configuration:lombok.extensionMethod.flagUsage
=WARNING
|ERROR
.static final lombok.core.configuration.ConfigurationKey
<Boolean> lombok configuration:lombok.fieldDefaults.defaultFinal
=true
|false
.static final lombok.core.configuration.ConfigurationKey
<lombok.core.configuration.FlagUsageType> lombok configuration:lombok.fieldDefaults.flagUsage
=WARNING
|ERROR
.static final lombok.core.configuration.ConfigurationKey
<Boolean> lombok configuration:lombok.fieldDefaults.defaultPrivate
=true
|false
.static final lombok.core.configuration.ConfigurationKey
<lombok.core.configuration.FlagUsageType> lombok configuration:lombok.fieldNameConstants.flagUsage
=WARNING
|ERROR
.static final lombok.core.configuration.ConfigurationKey
<lombok.core.configuration.IdentifierName> lombok configuration:lombok.fieldNameConstants.innerTypeName
= <String: AValidJavaTypeName> (Default:Fields
).static final lombok.core.configuration.ConfigurationKey
<Boolean> lombok configuration:lombok.fieldNameConstants.uppercase
=true
|false
.static final lombok.core.configuration.ConfigurationKey
<Boolean> lombok configuration:lombok.getter.noIsPrefix
=true
|false
.static final lombok.core.configuration.ConfigurationKey
<lombok.core.configuration.FlagUsageType> lombok configuration:lombok.getter.flagUsage
=WARNING
|ERROR
.static final lombok.core.configuration.ConfigurationKey
<lombok.core.configuration.FlagUsageType> lombok configuration:lombok.getter.lazy.flagUsage
=WARNING
|ERROR
.static final lombok.core.configuration.ConfigurationKey
<lombok.core.configuration.FlagUsageType> lombok configuration:lombok.helper.flagUsage
=WARNING
|ERROR
.static final lombok.core.configuration.ConfigurationKey
<lombok.core.configuration.FlagUsageType> lombok configuration:lombok.jacksonized.flagUsage
=WARNING
|ERROR
.static final lombok.core.configuration.ConfigurationKey
<lombok.core.configuration.FlagUsageType> lombok configuration:lombok.locked.flagUsage
=WARNING
|ERROR
.static final lombok.core.configuration.ConfigurationKey
<Boolean> lombok configuration:lombok.log.fieldIsStatic
=true
|false
.static final lombok.core.configuration.ConfigurationKey
<lombok.core.configuration.IdentifierName> lombok configuration:lombok.log.fieldName
= <String: aJavaIdentifier> (Default:log
).static final lombok.core.configuration.ConfigurationKey
<lombok.core.configuration.FlagUsageType> lombok configuration:lombok.log.flagUsage
=WARNING
|ERROR
.static final lombok.core.configuration.ConfigurationKey
<lombok.core.configuration.FlagUsageType> lombok configuration:lombok.log.apacheCommons.flagUsage
=WARNING
|ERROR
.static final lombok.core.configuration.ConfigurationKey
<lombok.core.configuration.LogDeclaration> lombok configuration:lombok.log.custom.declaration
= <logDeclaration string>.static final lombok.core.configuration.ConfigurationKey
<lombok.core.configuration.FlagUsageType> lombok configuration:lombok.log.custom.flagUsage
=WARNING
|ERROR
.static final lombok.core.configuration.ConfigurationKey
<lombok.core.configuration.FlagUsageType> lombok configuration:lombok.log.flogger.flagUsage
=WARNING
|ERROR
.static final lombok.core.configuration.ConfigurationKey
<lombok.core.configuration.FlagUsageType> lombok configuration:lombok.log.jbosslog.flagUsage
=WARNING
|ERROR
.static final lombok.core.configuration.ConfigurationKey
<lombok.core.configuration.FlagUsageType> lombok configuration:lombok.log.javaUtilLogging.flagUsage
=WARNING
|ERROR
.static final lombok.core.configuration.ConfigurationKey
<lombok.core.configuration.FlagUsageType> lombok configuration:lombok.log.log4j.flagUsage
=WARNING
|ERROR
.static final lombok.core.configuration.ConfigurationKey
<lombok.core.configuration.FlagUsageType> lombok configuration:lombok.log.log4j2.flagUsage
=WARNING
|ERROR
.static final lombok.core.configuration.ConfigurationKey
<lombok.core.configuration.FlagUsageType> lombok configuration:lombok.log.slf4j.flagUsage
=WARNING
|ERROR
.static final lombok.core.configuration.ConfigurationKey
<lombok.core.configuration.FlagUsageType> lombok configuration:lombok.log.xslf4j.flagUsage
=WARNING
|ERROR
.static final lombok.core.configuration.ConfigurationKey
<Boolean> lombok configuration:dangerousconfig.lombok.disable
=true
|false
.static final lombok.core.configuration.ConfigurationKey
<Boolean> lombok configuration:lombok.noArgsConstructor.extraPrivate
=true
|false
.static final lombok.core.configuration.ConfigurationKey
<lombok.core.configuration.FlagUsageType> lombok configuration:lombok.noArgsConstructor.flagUsage
=WARNING
|ERROR
.static final lombok.core.configuration.ConfigurationKey
<lombok.core.configuration.NullCheckExceptionType> lombok configuration:lombok.nonNull.exceptionType
= one of: [IllegalArgumentException
,NullPointerException
,JDK
,Guava
, orAssertion
].static final lombok.core.configuration.ConfigurationKey
<lombok.core.configuration.FlagUsageType> lombok configuration:lombok.nonNull.flagUsage
=WARNING
|ERROR
.static final lombok.core.configuration.ConfigurationKey
<lombok.core.configuration.FlagUsageType> lombok configuration:lombok.onX.flagUsage
=WARNING
|ERROR
.static final lombok.core.configuration.ConfigurationKey
<lombok.core.configuration.FlagUsageType> lombok configuration:lombok.requiredArgsConstructor.flagUsage
=WARNING
|ERROR
.static final lombok.core.configuration.ConfigurationKey
<lombok.core.configuration.FlagUsageType> lombok configuration:lombok.setter.flagUsage
=WARNING
|ERROR
.static final lombok.core.configuration.ConfigurationKey
<Boolean> lombok configuration:lombok.singular.auto
=true
|false
.static final lombok.core.configuration.ConfigurationKey
<Boolean> lombok configuration:lombok.singular.useGuava
=true
|false
.static final lombok.core.configuration.ConfigurationKey
<lombok.core.configuration.FlagUsageType> lombok configuration:lombok.sneakyThrows.flagUsage
=WARNING
|ERROR
.static final lombok.core.configuration.ConfigurationKey
<lombok.core.configuration.FlagUsageType> lombok configuration:lombok.standardException.flagUsage
=WARNING
|ERROR
.static final lombok.core.configuration.ConfigurationKey
<Boolean> lombok configuration:config.stopBubbling
=true
|false
.static final lombok.core.configuration.ConfigurationKey
<lombok.core.configuration.FlagUsageType> lombok configuration:lombok.superBuilder.flagUsage
=WARNING
|ERROR
.static final lombok.core.configuration.ConfigurationKey
<lombok.core.configuration.FlagUsageType> lombok configuration:lombok.synchronized.flagUsage
=WARNING
|ERROR
.static final lombok.core.configuration.ConfigurationKey
<lombok.core.configuration.CallSuperType> lombok configuration:lombok.toString.callSuper
=call
|ignore
|warn
.static final lombok.core.configuration.ConfigurationKey
<Boolean> lombok configuration:lombok.toString.doNotUseGetters
=true
|false
.static final lombok.core.configuration.ConfigurationKey
<lombok.core.configuration.FlagUsageType> lombok configuration:lombok.toString.flagUsage
=WARNING
|ERROR
.static final lombok.core.configuration.ConfigurationKey
<Boolean> lombok configuration:lombok.toString.includeFieldNames
=true
|false
.static final lombok.core.configuration.ConfigurationKey
<Boolean> lombok configuration:lombok.toString.onlyExplicitlyIncluded
=true
|false
.static final lombok.core.configuration.ConfigurationKey
<lombok.core.configuration.FlagUsageType> lombok configuration:lombok.utilityClass.flagUsage
=WARNING
|ERROR
.static final lombok.core.configuration.ConfigurationKey
<lombok.core.configuration.FlagUsageType> lombok configuration:lombok.val.flagUsage
=WARNING
|ERROR
.static final lombok.core.configuration.ConfigurationKey
<lombok.core.configuration.FlagUsageType> lombok configuration:lombok.value.flagUsage
=WARNING
|ERROR
.static final lombok.core.configuration.ConfigurationKey
<lombok.core.configuration.FlagUsageType> static final lombok.core.configuration.ConfigurationKey
<lombok.core.configuration.FlagUsageType> lombok configuration:lombok.with.flagUsage
=WARNING
|ERROR
.static final lombok.core.configuration.ConfigurationKey
<lombok.core.configuration.FlagUsageType> lombok configuration:lombok.withBy.flagUsage
=WARNING
|ERROR
. -
Method Summary
-
Field Details
-
LOMBOK_DISABLE
lombok configuration:dangerousconfig.lombok.disable
=true
|false
. Iftrue
, lombok is disabled entirely. -
ADD_GENERATED_ANNOTATIONS
@Deprecated public static final lombok.core.configuration.ConfigurationKey<Boolean> ADD_GENERATED_ANNOTATIONSDeprecated.Since version 1.16.14, useADD_JAVAX_GENERATED_ANNOTATIONS
instead.lombok configuration:lombok.addGeneratedAnnotation
=true
|false
. Iftrue
, lombok generates@javax.annotation.Generated("lombok")
on all fields, methods, and types that are generated, unlesslombok.addJavaxGeneratedAnnotation
is set.
BREAKING CHANGE: Starting with lombok v1.16.20, defaults tofalse
instead oftrue
, as this annotation is broken in JDK9.- See Also:
-
ADD_JAVAX_GENERATED_ANNOTATIONS
public static final lombok.core.configuration.ConfigurationKey<Boolean> ADD_JAVAX_GENERATED_ANNOTATIONSlombok configuration:lombok.addJavaxGeneratedAnnotation
=true
|false
. Iftrue
, lombok generates@javax.annotation.Generated("lombok")
on all fields, methods, and types that are generated.
BREAKING CHANGE: Starting with lombok v1.16.20, defaults tofalse
instead oftrue
, as this annotation is broken in JDK9. -
ADD_JAKARTA_GENERATED_ANNOTATIONS
public static final lombok.core.configuration.ConfigurationKey<Boolean> ADD_JAKARTA_GENERATED_ANNOTATIONSlombok configuration:lombok.addJakartaGeneratedAnnotation
=true
|false
. Iftrue
, lombok generates@jakarta.annotation.Generated("lombok")
on all fields, methods, and types that are generated. -
ADD_LOMBOK_GENERATED_ANNOTATIONS
public static final lombok.core.configuration.ConfigurationKey<Boolean> ADD_LOMBOK_GENERATED_ANNOTATIONSlombok configuration:lombok.addLombokGeneratedAnnotation
=true
|false
. Iftrue
, lombok generates@lombok.Generated
on all fields, methods, and types that are generated. -
ADD_FINDBUGS_SUPPRESSWARNINGS_ANNOTATIONS
public static final lombok.core.configuration.ConfigurationKey<Boolean> ADD_FINDBUGS_SUPPRESSWARNINGS_ANNOTATIONSlombok configuration:lombok.extern.findbugs.addSuppressFBWarnings
=true
|false
. Iftrue
, lombok generatesedu.umd.cs.findbugs.annotations.SuppressFBWarnings
on all fields, methods, and types that are generated. NB: If you enable this option, findbugs must be on the source or classpath, or you'll get errors that the typeSuppressFBWarnings
cannot be found. -
ADD_SUPPRESSWARNINGS_ANNOTATIONS
public static final lombok.core.configuration.ConfigurationKey<Boolean> ADD_SUPPRESSWARNINGS_ANNOTATIONSlombok configuration:lombok.addSuppressWarnings
=true
|false
. Iftrue
, lombok generates@java.lang.SuppressWarnings("all")
on all fields, methods, and types that are generated. -
ADD_NULL_ANNOTATIONS
public static final lombok.core.configuration.ConfigurationKey<lombok.core.configuration.NullAnnotationLibrary> ADD_NULL_ANNOTATIONSlombok configuration:lombok.addNullAnnotations =
one of: [none
,javax
,eclipse
,jetbrains
,netbeans
,androidx
,android.support
,checkerframework
,findbugs
,spring
,JML
, or a custom set of fully qualified annotation types]. Lombok generally copies relevant nullity annotations from your source code to the right places. However, sometimes lombok generates code where the nullability of some node is not dependent on something in your source code. You can configure lombok to add an appropriate nullity annotation in this case.none
(the default) - no annotations are added.javax
- The annotationsjavax.annotation.NonNull
andjavax.annotation.Nullable
are used.jakarta
- The annotationsjakarta.annotation.NonNull
andjakarta.annotation.Nullable
are used.eclipse
- The annotationsorg.eclipse.jdt.annotation.NonNull
andorg.eclipse.jdt.annotation.Nullable
are used.jetbrains
- The annotationsorg.jetbrains.annotations.NotNull
andorg.jetbrains.annotations.Nullable
are used.netbeans
- The annotationsorg.netbeans.api.annotations.common.NonNull
andorg.netbeans.api.annotations.common.NullAllowed
are used.androidx
- The annotationsandroidx.annotation.NonNull
andandroidx.annotation.Nullable
are used.android.support
- The annotationsandroid.support.annotation.NonNull
andandroid.support.annotation.Nullable
are used.checkerframework
- The annotationsorg.checkerframework.checker.nullness.qual.NonNull
andorg.checkerframework.checker.nullness.qual.Nullable
are used.findbugs
- The annotationsedu.umd.cs.findbugs.annotations.NonNull
andedu.umd.cs.findbugs.annotations.Nullable
are used.spring
- The annotationsorg.springframework.lang.NonNull
andorg.springframework.lang.Nullable
are used.jml
- The annotationsorg.jmlspecs.annotation.NonNull
andorg.jmlspecs.annotation.Nullable
are used.CUSTOM:fully.qualified.nonnull.annotation:fully.qualified.nullable.annotation
to configure your own types; the nullable annotation (and the colon) are optional.
Lombok will not put these annotations on the classpath for you; your project must be set up such that these annotations are available.
Current features which use this configuration:
@Builder.Singular
makes methods that accept a collection, all of which must be added. The parameter to this 'plural form' method is annotated.
-
ANY_CONSTRUCTOR_FLAG_USAGE
public static final lombok.core.configuration.ConfigurationKey<lombok.core.configuration.FlagUsageType> ANY_CONSTRUCTOR_FLAG_USAGElombok configuration:lombok.anyConstructor.flagUsage
=WARNING
|ERROR
. If set, any usage of@AllArgsConstructor
,@RequiredArgsConstructor
, or@NoArgsConstructor
results in a warning / error. -
ANY_CONSTRUCTOR_SUPPRESS_CONSTRUCTOR_PROPERTIES
@Deprecated public static final lombok.core.configuration.ConfigurationKey<Boolean> ANY_CONSTRUCTOR_SUPPRESS_CONSTRUCTOR_PROPERTIESDeprecated.Since version 2.0, useANY_CONSTRUCTOR_ADD_CONSTRUCTOR_PROPERTIES
instead.lombok configuration:lombok.anyConstructor.suppressConstructorProperties
=true
|false
. Iffalse
or this configuration is omitted, all generated constructors with at least 1 argument get a@ConstructorProperties
. To suppress the generation of it, set this configuration totrue
. NB: GWT projects, and probably android projects, should explicitly set this key totrue
for the entire project.
BREAKING CHANGE: Starting with lombok v1.16.20, defaults totrue
instead offalse
, as@ConstructorProperties
requires extra modules in JDK9.- See Also:
-
ANY_CONSTRUCTOR_ADD_CONSTRUCTOR_PROPERTIES
public static final lombok.core.configuration.ConfigurationKey<Boolean> ANY_CONSTRUCTOR_ADD_CONSTRUCTOR_PROPERTIESlombok configuration:lombok.anyConstructor.addConstructorProperties
=true
|false
. Iftrue
, all generated constructors with at least 1 argument get a@ConstructorProperties
. -
ALL_ARGS_CONSTRUCTOR_FLAG_USAGE
public static final lombok.core.configuration.ConfigurationKey<lombok.core.configuration.FlagUsageType> ALL_ARGS_CONSTRUCTOR_FLAG_USAGElombok configuration:lombok.allArgsConstructor.flagUsage
=WARNING
|ERROR
. If set, any usage of@AllArgsConstructor
results in a warning / error. -
NO_ARGS_CONSTRUCTOR_FLAG_USAGE
public static final lombok.core.configuration.ConfigurationKey<lombok.core.configuration.FlagUsageType> NO_ARGS_CONSTRUCTOR_FLAG_USAGElombok configuration:lombok.noArgsConstructor.flagUsage
=WARNING
|ERROR
. If set, any usage of@NoArgsConstructor
results in a warning / error. -
NO_ARGS_CONSTRUCTOR_EXTRA_PRIVATE
public static final lombok.core.configuration.ConfigurationKey<Boolean> NO_ARGS_CONSTRUCTOR_EXTRA_PRIVATElombok configuration:lombok.noArgsConstructor.extraPrivate
=true
|false
. Iftrue
, @Data and @Value will also generate a private no-args constructor, if there isn't already one, setting all fields to their default values. -
REQUIRED_ARGS_CONSTRUCTOR_FLAG_USAGE
public static final lombok.core.configuration.ConfigurationKey<lombok.core.configuration.FlagUsageType> REQUIRED_ARGS_CONSTRUCTOR_FLAG_USAGElombok configuration:lombok.requiredArgsConstructor.flagUsage
=WARNING
|ERROR
. If set, any usage of@RequiredArgsConstructor
results in a warning / error. -
DATA_FLAG_USAGE
public static final lombok.core.configuration.ConfigurationKey<lombok.core.configuration.FlagUsageType> DATA_FLAG_USAGElombok configuration:lombok.data.flagUsage
=WARNING
|ERROR
. If set, any usage of@Data
results in a warning / error. -
VALUE_FLAG_USAGE
public static final lombok.core.configuration.ConfigurationKey<lombok.core.configuration.FlagUsageType> VALUE_FLAG_USAGElombok configuration:lombok.value.flagUsage
=WARNING
|ERROR
. If set, any usage of@Value
results in a warning / error. -
GETTER_FLAG_USAGE
public static final lombok.core.configuration.ConfigurationKey<lombok.core.configuration.FlagUsageType> GETTER_FLAG_USAGElombok configuration:lombok.getter.flagUsage
=WARNING
|ERROR
. If set, any usage of@Getter
results in a warning / error. -
GETTER_LAZY_FLAG_USAGE
public static final lombok.core.configuration.ConfigurationKey<lombok.core.configuration.FlagUsageType> GETTER_LAZY_FLAG_USAGElombok configuration:lombok.getter.lazy.flagUsage
=WARNING
|ERROR
. If set, any usage of@Getter(lazy=true)
results in a warning / error. -
GETTER_CONSEQUENT_BOOLEAN
lombok configuration:lombok.getter.noIsPrefix
=true
|false
. Iftrue
, booleans getters are both referred to, and generated asgetFieldName()
. Iffalse
(the default), the javabean-standardisFieldName()
is generated / used instead. -
SETTER_FLAG_USAGE
public static final lombok.core.configuration.ConfigurationKey<lombok.core.configuration.FlagUsageType> SETTER_FLAG_USAGElombok configuration:lombok.setter.flagUsage
=WARNING
|ERROR
. If set, any usage of@Setter
results in a warning / error. -
EQUALS_AND_HASH_CODE_DO_NOT_USE_GETTERS
public static final lombok.core.configuration.ConfigurationKey<Boolean> EQUALS_AND_HASH_CODE_DO_NOT_USE_GETTERSlombok configuration:lombok.equalsAndHashCode.doNotUseGetters
=true
|false
. For any class without an@EqualsAndHashCode
that explicitly defines thedoNotUseGetters
option, this value is used (default = false). -
EQUALS_AND_HASH_CODE_CALL_SUPER
public static final lombok.core.configuration.ConfigurationKey<lombok.core.configuration.CallSuperType> EQUALS_AND_HASH_CODE_CALL_SUPERlombok configuration:lombok.equalsAndHashCode.callSuper
=call
|ignore
|warn
. For any class with an@EqualsAndHashCode
annotation which extends a class other thanjava.lang.Object
, should a call to superclass's implementation ofequals
andhashCode
be included in the generated methods? (Default = warn) -
EQUALS_AND_HASH_CODE_FLAG_USAGE
public static final lombok.core.configuration.ConfigurationKey<lombok.core.configuration.FlagUsageType> EQUALS_AND_HASH_CODE_FLAG_USAGElombok configuration:lombok.equalsAndHashCode.flagUsage
=WARNING
|ERROR
. If set, any usage of@EqualsAndHashCode
results in a warning / error. -
TO_STRING_DO_NOT_USE_GETTERS
public static final lombok.core.configuration.ConfigurationKey<Boolean> TO_STRING_DO_NOT_USE_GETTERSlombok configuration:lombok.toString.doNotUseGetters
=true
|false
. For any class without an@ToString
that explicitly defines thedoNotUseGetters
option, this value is used (default = false). -
TO_STRING_CALL_SUPER
public static final lombok.core.configuration.ConfigurationKey<lombok.core.configuration.CallSuperType> TO_STRING_CALL_SUPERlombok configuration:lombok.toString.callSuper
=call
|ignore
|warn
. For any class with an@ToString
annotation which extends a class other thanjava.lang.Object
, should a call to superclass's implementation oftoString
be included in the generated method? (Default = skip) -
TO_STRING_FLAG_USAGE
public static final lombok.core.configuration.ConfigurationKey<lombok.core.configuration.FlagUsageType> TO_STRING_FLAG_USAGElombok configuration:lombok.toString.flagUsage
=WARNING
|ERROR
. If set, any usage of@ToString
results in a warning / error. -
TO_STRING_INCLUDE_FIELD_NAMES
public static final lombok.core.configuration.ConfigurationKey<Boolean> TO_STRING_INCLUDE_FIELD_NAMESlombok configuration:lombok.toString.includeFieldNames
=true
|false
. For any class without an@ToString
that explicitly defines theincludeFieldNames
option, this value is used (default = true). -
TO_STRING_ONLY_EXPLICITLY_INCLUDED
public static final lombok.core.configuration.ConfigurationKey<Boolean> TO_STRING_ONLY_EXPLICITLY_INCLUDEDlombok configuration:lombok.toString.onlyExplicitlyIncluded
=true
|false
. Iftrue
, require a@ToString.Include
annotation on any fields/no-args methods you want to include in lombok's generated `@ToString` method. Otherwise, every (non-static, non-dollar-named) field is included by default (default = false). -
BUILDER_CLASS_NAME
lombok configuration:lombok.builder.classNames
= <String: aJavaIdentifier (optionally with a star as placeholder for the type name)> (Default:*Builder
). For any usage of the@Builder
annotation without an explicitbuilderClassName
parameter, this value is used to determine the name of the builder class to generate (or to adapt if such an inner class already exists). -
BUILDER_FLAG_USAGE
public static final lombok.core.configuration.ConfigurationKey<lombok.core.configuration.FlagUsageType> BUILDER_FLAG_USAGElombok configuration:lombok.builder.flagUsage
=WARNING
|ERROR
. If set, any usage of@Builder
results in a warning / error. -
SINGULAR_USE_GUAVA
lombok configuration:lombok.singular.useGuava
=true
|false
. If explicitly set totrue
, guava'sImmutableList
etc are used to implement the immutable collection datatypes generated by @Singular @Builder for fields/parameters of typejava.util.List
and such. By default, unmodifiable-wrapped versions ofjava.util
types are used. -
SINGULAR_AUTO
lombok configuration:lombok.singular.auto
=true
|false
. By default or if explicitly set totrue
, lombok will attempt to automatically singularize the name of your variable/parameter when using@Singular
; the name is assumed to be written in english, and a plural. If explicitly tofalse
, you must always specify the singular form; this is especially useful if your identifiers are in a foreign language. -
CLEANUP_FLAG_USAGE
public static final lombok.core.configuration.ConfigurationKey<lombok.core.configuration.FlagUsageType> CLEANUP_FLAG_USAGElombok configuration:lombok.cleanup.flagUsage
=WARNING
|ERROR
. If set, any usage of@Cleanup
results in a warning / error. -
DELEGATE_FLAG_USAGE
public static final lombok.core.configuration.ConfigurationKey<lombok.core.configuration.FlagUsageType> DELEGATE_FLAG_USAGElombok configuration:lombok.delegate.flagUsage
=WARNING
|ERROR
. If set, any usage of@Delegate
results in a warning / error. -
NON_NULL_EXCEPTION_TYPE
public static final lombok.core.configuration.ConfigurationKey<lombok.core.configuration.NullCheckExceptionType> NON_NULL_EXCEPTION_TYPElombok configuration:lombok.nonNull.exceptionType
= one of: [IllegalArgumentException
,NullPointerException
,JDK
,Guava
, orAssertion
]. Sets the behavior of the generated nullcheck if@NonNull
is applied to a method parameter, and a caller passes innull
.- If the chosen configuration is
NullPointerException
(the default), orIllegalArgumentException
, that exception type is a thrown, with as messagefield-name is marked non-null but is null
. - If the chosen configuration is
Assert
, then anassert
statement is generated. This means anAssertionError
will be thrown if assertions are on (VM started with-ea
parameter), and nothing happens if not. - If the chosen configuration is
JDK
, a call tojava.util.Objects.requireNonNull
is generated with the fieldname passed along (which throwsNullPointerException
). - If the chosen configuration is
Guava
, a call tocom.google.common.base.Preconditions.checkNotNull
is generated with the fieldname passed along (which throwsNullPointerException
).
@Builder
's@Singular
annotation to check any collections passed to a plural-form method. - If the chosen configuration is
-
NON_NULL_FLAG_USAGE
public static final lombok.core.configuration.ConfigurationKey<lombok.core.configuration.FlagUsageType> NON_NULL_FLAG_USAGElombok configuration:lombok.nonNull.flagUsage
=WARNING
|ERROR
. If set, any usage of@NonNull
results in a warning / error. -
SNEAKY_THROWS_FLAG_USAGE
public static final lombok.core.configuration.ConfigurationKey<lombok.core.configuration.FlagUsageType> SNEAKY_THROWS_FLAG_USAGElombok configuration:lombok.sneakyThrows.flagUsage
=WARNING
|ERROR
. If set, any usage of@SneakyThrows
results in a warning / error. -
SYNCHRONIZED_FLAG_USAGE
public static final lombok.core.configuration.ConfigurationKey<lombok.core.configuration.FlagUsageType> SYNCHRONIZED_FLAG_USAGElombok configuration:lombok.synchronized.flagUsage
=WARNING
|ERROR
. If set, any usage of@Synchronized
results in a warning / error. -
VAL_FLAG_USAGE
public static final lombok.core.configuration.ConfigurationKey<lombok.core.configuration.FlagUsageType> VAL_FLAG_USAGElombok configuration:lombok.val.flagUsage
=WARNING
|ERROR
. If set, any usage ofval
results in a warning / error. -
VAR_FLAG_USAGE
public static final lombok.core.configuration.ConfigurationKey<lombok.core.configuration.FlagUsageType> VAR_FLAG_USAGE -
WITH_FLAG_USAGE
public static final lombok.core.configuration.ConfigurationKey<lombok.core.configuration.FlagUsageType> WITH_FLAG_USAGElombok configuration:lombok.with.flagUsage
=WARNING
|ERROR
. If set, any usage of@With
results in a warning / error. -
LOG_ANY_FLAG_USAGE
public static final lombok.core.configuration.ConfigurationKey<lombok.core.configuration.FlagUsageType> LOG_ANY_FLAG_USAGElombok configuration:lombok.log.flagUsage
=WARNING
|ERROR
. If set, any usage of any of the log annotations inlombok.extern
@Slf4j
results in a warning / error. -
LOG_COMMONS_FLAG_USAGE
public static final lombok.core.configuration.ConfigurationKey<lombok.core.configuration.FlagUsageType> LOG_COMMONS_FLAG_USAGElombok configuration:lombok.log.apacheCommons.flagUsage
=WARNING
|ERROR
. If set, any usage of@CommonsLog
results in a warning / error. -
LOG_JUL_FLAG_USAGE
public static final lombok.core.configuration.ConfigurationKey<lombok.core.configuration.FlagUsageType> LOG_JUL_FLAG_USAGElombok configuration:lombok.log.javaUtilLogging.flagUsage
=WARNING
|ERROR
. If set, any usage of@Log
results in a warning / error. -
LOG_LOG4J_FLAG_USAGE
public static final lombok.core.configuration.ConfigurationKey<lombok.core.configuration.FlagUsageType> LOG_LOG4J_FLAG_USAGElombok configuration:lombok.log.log4j.flagUsage
=WARNING
|ERROR
. If set, any usage of@Log4j
results in a warning / error. -
LOG_LOG4J2_FLAG_USAGE
public static final lombok.core.configuration.ConfigurationKey<lombok.core.configuration.FlagUsageType> LOG_LOG4J2_FLAG_USAGElombok configuration:lombok.log.log4j2.flagUsage
=WARNING
|ERROR
. If set, any usage of@Log4j2
results in a warning / error. -
LOG_SLF4J_FLAG_USAGE
public static final lombok.core.configuration.ConfigurationKey<lombok.core.configuration.FlagUsageType> LOG_SLF4J_FLAG_USAGElombok configuration:lombok.log.slf4j.flagUsage
=WARNING
|ERROR
. If set, any usage of@Slf4j
results in a warning / error. -
LOG_XSLF4J_FLAG_USAGE
public static final lombok.core.configuration.ConfigurationKey<lombok.core.configuration.FlagUsageType> LOG_XSLF4J_FLAG_USAGElombok configuration:lombok.log.xslf4j.flagUsage
=WARNING
|ERROR
. If set, any usage of@XSlf4j
results in a warning / error. -
LOG_JBOSSLOG_FLAG_USAGE
public static final lombok.core.configuration.ConfigurationKey<lombok.core.configuration.FlagUsageType> LOG_JBOSSLOG_FLAG_USAGElombok configuration:lombok.log.jbosslog.flagUsage
=WARNING
|ERROR
. If set, any usage of@JBossLog
results in a warning / error. -
LOG_FLOGGER_FLAG_USAGE
public static final lombok.core.configuration.ConfigurationKey<lombok.core.configuration.FlagUsageType> LOG_FLOGGER_FLAG_USAGElombok configuration:lombok.log.flogger.flagUsage
=WARNING
|ERROR
. If set, any usage of@Flogger
results in a warning / error. -
LOG_ANY_FIELD_NAME
public static final lombok.core.configuration.ConfigurationKey<lombok.core.configuration.IdentifierName> LOG_ANY_FIELD_NAMElombok configuration:lombok.log.fieldName
= <String: aJavaIdentifier> (Default:log
). If set the various log annotations (which make a log field) will use the stated identifier instead oflog
as a name. -
LOG_ANY_FIELD_IS_STATIC
lombok configuration:lombok.log.fieldIsStatic
=true
|false
. If not set, or set totrue
, the log field generated by the various log annotations will bestatic
. If set tofalse
, these will be generated as instance fields instead. -
LOG_CUSTOM_FLAG_USAGE
public static final lombok.core.configuration.ConfigurationKey<lombok.core.configuration.FlagUsageType> LOG_CUSTOM_FLAG_USAGElombok configuration:lombok.log.custom.flagUsage
=WARNING
|ERROR
. If set, any usage of@CustomLog
results in a warning / error. -
LOG_CUSTOM_DECLARATION
public static final lombok.core.configuration.ConfigurationKey<lombok.core.configuration.LogDeclaration> LOG_CUSTOM_DECLARATIONlombok configuration:lombok.log.custom.declaration
= <logDeclaration string>. The log declaration must follow the pattern:
[LoggerType ]LoggerFactoryType.loggerFactoryMethod(loggerFactoryMethodParams)[(loggerFactoryMethodParams)]
It consists of:- Optional fully qualified logger type, e.g.
my.cool.Logger
, followed by space. If not specified, it defaults to the LoggerFactoryType. - Fully qualified logger factory type, e.g.
my.cool.LoggerFactory
, followed by dot. - Factory method, e.g.
createLogger
. This must be apublic static
method in the LoggerFactoryType. - At least one definition of factory method parameters, e.g.
()
or(TOPIC,TYPE)
. The format inside the parentheses is a comma-separated list of parameter kinds.
The allowed parameters are:TYPE
|NAME
|TOPIC
|NULL
.
There can be at most one parameter definition withTOPIC
and at most one withoutTOPIC
. You can specify both.
my.cool.Logger my.cool.LoggerFactory.createLogger(TYPE)(TYPE,TOPIC)
If no topic is provided in the usage of@CustomLog
, the above will invokeLoggerFactory
'screateLogger
method, passing in the type as ajava.lang.Class
variable.
If a topic is provided, the overload of that method is invoked with 2 parameters: First the type (asClass
), then the topic (asString
).If this configuration key is not set, any usage of
@CustomLog
will result in an error. - Optional fully qualified logger type, e.g.
-
EXPERIMENTAL_FLAG_USAGE
public static final lombok.core.configuration.ConfigurationKey<lombok.core.configuration.FlagUsageType> EXPERIMENTAL_FLAG_USAGElombok configuration:lombok.experimental.flagUsage
=WARNING
|ERROR
. If set, any usage of any experimental features (from packagelombok.experimental
) that haven't been promoted to a main feature results in a warning / error. -
ACCESSORS_FLAG_USAGE
public static final lombok.core.configuration.ConfigurationKey<lombok.core.configuration.FlagUsageType> ACCESSORS_FLAG_USAGElombok configuration:lombok.accessors.flagUsage
=WARNING
|ERROR
. If set, any usage of@Accessors
results in a warning / error. -
ACCESSORS_PREFIX
-
ACCESSORS_CHAIN
lombok configuration:lombok.accessors.chain
=true
|false
. For any class without an@Accessors
that explicitly defines thechain
option, this value is used (default = false). -
ACCESSORS_FLUENT
lombok configuration:lombok.accessors.fluent
=true
|false
. For any class without an@Accessors
that explicitly defines thefluent
option, this value is used (default = false). -
ACCESSORS_MAKE_FINAL
lombok configuration:lombok.accessors.makeFinal
=true
|false
. Unless an explicit@Accessors
that explicitly defines themakeFinal
option, this value is used (default = false). -
ACCESSORS_JAVA_BEANS_SPEC_CAPITALIZATION
public static final lombok.core.configuration.ConfigurationKey<lombok.core.configuration.CapitalizationStrategy> ACCESSORS_JAVA_BEANS_SPEC_CAPITALIZATIONlombok configuration:lombok.accessors.capitalization
=basic
|beanspec
. Which capitalization rule is used to turn field names into getter/setter/with names and vice versa for field names that start with 1 lowercase letter, then 1 uppercase letter. basic =uShape
becomesgetUShape
, beanspec =uShape
becomesgetuShape
(default = basic). -
EXTENSION_METHOD_FLAG_USAGE
public static final lombok.core.configuration.ConfigurationKey<lombok.core.configuration.FlagUsageType> EXTENSION_METHOD_FLAG_USAGElombok configuration:lombok.extensionMethod.flagUsage
=WARNING
|ERROR
. If set, any usage of@ExtensionMethod
results in a warning / error. -
FIELD_DEFAULTS_PRIVATE_EVERYWHERE
public static final lombok.core.configuration.ConfigurationKey<Boolean> FIELD_DEFAULTS_PRIVATE_EVERYWHERElombok configuration:lombok.fieldDefaults.defaultPrivate
=true
|false
. If set totrue
any field without an access modifier or@PackagePrivate
is marked asprivate
by lombok, in all source files compiled. -
FIELD_DEFAULTS_FINAL_EVERYWHERE
public static final lombok.core.configuration.ConfigurationKey<Boolean> FIELD_DEFAULTS_FINAL_EVERYWHERElombok configuration:lombok.fieldDefaults.defaultFinal
=true
|false
. If set totrue
any field without@NonFinal
is marked asfinal
by lombok, in all source files compiled. -
FIELD_DEFAULTS_FLAG_USAGE
public static final lombok.core.configuration.ConfigurationKey<lombok.core.configuration.FlagUsageType> FIELD_DEFAULTS_FLAG_USAGElombok configuration:lombok.fieldDefaults.flagUsage
=WARNING
|ERROR
. If set, any usage of@FieldDefaults
results in a warning / error. -
HELPER_FLAG_USAGE
public static final lombok.core.configuration.ConfigurationKey<lombok.core.configuration.FlagUsageType> HELPER_FLAG_USAGElombok configuration:lombok.helper.flagUsage
=WARNING
|ERROR
. If set, any usage of@Helper
results in a warning / error. -
LOCKED_FLAG_USAGE
public static final lombok.core.configuration.ConfigurationKey<lombok.core.configuration.FlagUsageType> LOCKED_FLAG_USAGElombok configuration:lombok.locked.flagUsage
=WARNING
|ERROR
. If set, any usage of@Locked
results in a warning / error. -
ON_X_FLAG_USAGE
public static final lombok.core.configuration.ConfigurationKey<lombok.core.configuration.FlagUsageType> ON_X_FLAG_USAGElombok configuration:lombok.onX.flagUsage
=WARNING
|ERROR
. If set, any usage ofonX
results in a warning / error.
Specifically, this flags usage of@Getter(onMethod=...)
,@Setter(onParam=...)
,@Setter(onMethod=...)
,@XArgsConstructor(onConstructor=...)
. -
UTILITY_CLASS_FLAG_USAGE
public static final lombok.core.configuration.ConfigurationKey<lombok.core.configuration.FlagUsageType> UTILITY_CLASS_FLAG_USAGElombok configuration:lombok.utilityClass.flagUsage
=WARNING
|ERROR
. If set, any usage of@UtilityClass
results in a warning / error. -
FIELD_NAME_CONSTANTS_FLAG_USAGE
public static final lombok.core.configuration.ConfigurationKey<lombok.core.configuration.FlagUsageType> FIELD_NAME_CONSTANTS_FLAG_USAGElombok configuration:lombok.fieldNameConstants.flagUsage
=WARNING
|ERROR
. If set, any usage of@FieldNameConstants
results in a warning / error. -
FIELD_NAME_CONSTANTS_INNER_TYPE_NAME
public static final lombok.core.configuration.ConfigurationKey<lombok.core.configuration.IdentifierName> FIELD_NAME_CONSTANTS_INNER_TYPE_NAMElombok configuration:lombok.fieldNameConstants.innerTypeName
= <String: AValidJavaTypeName> (Default:Fields
). The names of the constants generated by@FieldNameConstants
will be prefixed with this value. -
FIELD_NAME_CONSTANTS_UPPERCASE
public static final lombok.core.configuration.ConfigurationKey<Boolean> FIELD_NAME_CONSTANTS_UPPERCASElombok configuration:lombok.fieldNameConstants.uppercase
=true
|false
. If true, names of constants generated by@FieldNameConstants
will be UPPER_CASED_LIKE_A_CONSTANT. (Default:false
). -
SUPERBUILDER_FLAG_USAGE
public static final lombok.core.configuration.ConfigurationKey<lombok.core.configuration.FlagUsageType> SUPERBUILDER_FLAG_USAGElombok configuration:lombok.superBuilder.flagUsage
=WARNING
|ERROR
. If set, any usage of@SuperBuilder
results in a warning / error. -
WITHBY_FLAG_USAGE
public static final lombok.core.configuration.ConfigurationKey<lombok.core.configuration.FlagUsageType> WITHBY_FLAG_USAGElombok configuration:lombok.withBy.flagUsage
=WARNING
|ERROR
. If set, any usage of@WithBy
results in a warning / error. -
JACKSONIZED_FLAG_USAGE
public static final lombok.core.configuration.ConfigurationKey<lombok.core.configuration.FlagUsageType> JACKSONIZED_FLAG_USAGElombok configuration:lombok.jacksonized.flagUsage
=WARNING
|ERROR
. If set, any usage of@Jacksonized
results in a warning / error. -
STOP_BUBBLING
lombok configuration:config.stopBubbling
=true
|false
. If not set, or set tofalse
, the configuration system will look forlombok.config
files in the parent directory. If set totrue
, no furtherlombok.config
files will be checked. -
COPYABLE_ANNOTATIONS
public static final lombok.core.configuration.ConfigurationKey<List<lombok.core.configuration.TypeName>> COPYABLE_ANNOTATIONSlombok configuration:lombok.copyableAnnotations
+= <TypeName: fully-qualified annotation class name>. Copy these annotations to getters, setters, with methods, builder-setters, etc. -
CHECKER_FRAMEWORK
public static final lombok.core.configuration.ConfigurationKey<lombok.core.configuration.CheckerFrameworkVersion> CHECKER_FRAMEWORKlombok configuration:checkerframework
=true
|false
| <String: MajorVer.MinorVer> (Default: false). If set, lombok will generate appropriate annotations from checkerframework.org on generated code. If set totrue
, all relevant annotations from the most recent version of checkerframework.org that lombok supports will be generated. If set to a specific major/minor version number, only checkerframework annotations introduced on or before the stated checkerframework.org version will be generated. -
STANDARD_EXCEPTION_FLAG_USAGE
public static final lombok.core.configuration.ConfigurationKey<lombok.core.configuration.FlagUsageType> STANDARD_EXCEPTION_FLAG_USAGElombok configuration:lombok.standardException.flagUsage
=WARNING
|ERROR
. If set, any usage of@StandardException
results in a warning / error.
-
ADD_JAVAX_GENERATED_ANNOTATIONS
instead.