Package lombok

Class ConfigurationKeys

java.lang.Object
lombok.ConfigurationKeys

public class ConfigurationKeys
extends java.lang.Object
A container class containing all lombok configuration keys that do not belong to a specific annotation.
  • Field Summary

    Fields 
    Modifier and Type Field Description
    static lombok.core.configuration.ConfigurationKey<java.lang.Boolean> ACCESSORS_CHAIN
    lombok configuration: lombok.accessors.chain = true | false.
    static lombok.core.configuration.ConfigurationKey<lombok.core.configuration.FlagUsageType> ACCESSORS_FLAG_USAGE
    lombok configuration: lombok.accessors.flagUsage = WARNING | ERROR.
    static lombok.core.configuration.ConfigurationKey<java.lang.Boolean> ACCESSORS_FLUENT
    lombok configuration: lombok.accessors.fluent = true | false.
    static lombok.core.configuration.ConfigurationKey<java.util.List<java.lang.String>> ACCESSORS_PREFIX
    lombok configuration: lombok.accessors.prefix += <String: prefix>.
    static lombok.core.configuration.ConfigurationKey<java.lang.Boolean> ADD_FINDBUGS_SUPPRESSWARNINGS_ANNOTATIONS
    lombok configuration: lombok.extern.findbugs.addSuppressFBWarnings = true | false.
    static lombok.core.configuration.ConfigurationKey<java.lang.Boolean> ADD_GENERATED_ANNOTATIONS
    Deprecated.
    Since version 1.16.14, use ADD_JAVAX_GENERATED_ANNOTATIONS instead.
    static lombok.core.configuration.ConfigurationKey<java.lang.Boolean> ADD_JAVAX_GENERATED_ANNOTATIONS
    lombok configuration: lombok.addJavaxGeneratedAnnotation = true | false.
    static lombok.core.configuration.ConfigurationKey<java.lang.Boolean> ADD_LOMBOK_GENERATED_ANNOTATIONS
    lombok configuration: lombok.addLombokGeneratedAnnotation = true | false.
    static lombok.core.configuration.ConfigurationKey<lombok.core.configuration.NullAnnotationLibrary> ADD_NULL_ANNOTATIONS
    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 lombok.core.configuration.ConfigurationKey<lombok.core.configuration.FlagUsageType> ALL_ARGS_CONSTRUCTOR_FLAG_USAGE
    lombok configuration: lombok.allArgsConstructor.flagUsage = WARNING | ERROR.
    static lombok.core.configuration.ConfigurationKey<java.lang.Boolean> ANY_CONSTRUCTOR_ADD_CONSTRUCTOR_PROPERTIES
    lombok configuration: lombok.anyConstructor.addConstructorProperties = true | false.
    static lombok.core.configuration.ConfigurationKey<lombok.core.configuration.FlagUsageType> ANY_CONSTRUCTOR_FLAG_USAGE
    lombok configuration: lombok.anyConstructor.flagUsage = WARNING | ERROR.
    static lombok.core.configuration.ConfigurationKey<java.lang.Boolean> ANY_CONSTRUCTOR_SUPPRESS_CONSTRUCTOR_PROPERTIES
    Deprecated.
    Since version 2.0, use ANY_CONSTRUCTOR_ADD_CONSTRUCTOR_PROPERTIES instead.
    static lombok.core.configuration.ConfigurationKey<java.lang.String> BUILDER_CLASS_NAME
    lombok configuration: lombok.builder.classNames = <String: aJavaIdentifier (optionally with a star as placeholder for the type name)> (Default: *Builder).
    static lombok.core.configuration.ConfigurationKey<lombok.core.configuration.FlagUsageType> BUILDER_FLAG_USAGE
    lombok configuration: lombok.builder.flagUsage = WARNING | ERROR.
    static lombok.core.configuration.ConfigurationKey<lombok.core.configuration.CheckerFrameworkVersion> CHECKER_FRAMEWORK
    lombok configuration: checkerframework = true | false | <String: MajorVer.MinorVer> (Default: false).
    static lombok.core.configuration.ConfigurationKey<lombok.core.configuration.FlagUsageType> CLEANUP_FLAG_USAGE
    lombok configuration: lombok.cleanup.flagUsage = WARNING | ERROR.
    static lombok.core.configuration.ConfigurationKey<java.util.List<lombok.core.configuration.TypeName>> COPYABLE_ANNOTATIONS
    lombok configuration: lombok.copyableAnnotations += <TypeName: fully-qualified annotation class name>.
    static lombok.core.configuration.ConfigurationKey<lombok.core.configuration.FlagUsageType> DATA_FLAG_USAGE
    lombok configuration: lombok.data.flagUsage = WARNING | ERROR.
    static lombok.core.configuration.ConfigurationKey<lombok.core.configuration.FlagUsageType> DELEGATE_FLAG_USAGE
    lombok configuration: lombok.delegate.flagUsage = WARNING | ERROR.
    static lombok.core.configuration.ConfigurationKey<lombok.core.configuration.CallSuperType> EQUALS_AND_HASH_CODE_CALL_SUPER
    lombok configuration: lombok.equalsAndHashCode.callSuper = call | ignore | warn.
    static lombok.core.configuration.ConfigurationKey<java.lang.Boolean> EQUALS_AND_HASH_CODE_DO_NOT_USE_GETTERS
    lombok configuration: lombok.equalsAndHashCode.doNotUseGetters = true | false.
    static lombok.core.configuration.ConfigurationKey<lombok.core.configuration.FlagUsageType> EQUALS_AND_HASH_CODE_FLAG_USAGE
    lombok configuration: lombok.equalsAndHashCode.flagUsage = WARNING | ERROR.
    static lombok.core.configuration.ConfigurationKey<lombok.core.configuration.FlagUsageType> EXPERIMENTAL_FLAG_USAGE
    lombok configuration: lombok.experimental.flagUsage = WARNING | ERROR.
    static lombok.core.configuration.ConfigurationKey<lombok.core.configuration.FlagUsageType> EXTENSION_METHOD_FLAG_USAGE
    lombok configuration: lombok.extensionMethod.flagUsage = WARNING | ERROR.
    static lombok.core.configuration.ConfigurationKey<java.lang.Boolean> FIELD_DEFAULTS_FINAL_EVERYWHERE
    lombok configuration: lombok.fieldDefaults.defaultFinal = true | false.
    static lombok.core.configuration.ConfigurationKey<lombok.core.configuration.FlagUsageType> FIELD_DEFAULTS_FLAG_USAGE
    lombok configuration: lombok.fieldDefaults.flagUsage = WARNING | ERROR.
    static lombok.core.configuration.ConfigurationKey<java.lang.Boolean> FIELD_DEFAULTS_PRIVATE_EVERYWHERE
    lombok configuration: lombok.fieldDefaults.defaultPrivate = true | false.
    static lombok.core.configuration.ConfigurationKey<lombok.core.configuration.FlagUsageType> FIELD_NAME_CONSTANTS_FLAG_USAGE
    lombok configuration: lombok.fieldNameConstants.flagUsage = WARNING | ERROR.
    static lombok.core.configuration.ConfigurationKey<lombok.core.configuration.IdentifierName> FIELD_NAME_CONSTANTS_INNER_TYPE_NAME
    lombok configuration: lombok.fieldNameConstants.innerTypeName = <String: AValidJavaTypeName> (Default: Fields).
    static lombok.core.configuration.ConfigurationKey<java.lang.Boolean> FIELD_NAME_CONSTANTS_UPPERCASE
    lombok configuration: lombok.fieldNameConstants.uppercase = true | false.
    static lombok.core.configuration.ConfigurationKey<java.lang.Boolean> GETTER_CONSEQUENT_BOOLEAN
    lombok configuration: lombok.getter.noIsPrefix = true | false.
    static lombok.core.configuration.ConfigurationKey<lombok.core.configuration.FlagUsageType> GETTER_FLAG_USAGE
    lombok configuration: lombok.getter.flagUsage = WARNING | ERROR.
    static lombok.core.configuration.ConfigurationKey<lombok.core.configuration.FlagUsageType> GETTER_LAZY_FLAG_USAGE
    lombok configuration: lombok.getter.lazy.flagUsage = WARNING | ERROR.
    static lombok.core.configuration.ConfigurationKey<lombok.core.configuration.FlagUsageType> HELPER_FLAG_USAGE
    lombok configuration: lombok.helper.flagUsage = WARNING | ERROR.
    static lombok.core.configuration.ConfigurationKey<java.lang.Boolean> LOG_ANY_FIELD_IS_STATIC
    lombok configuration: lombok.log.fieldIsStatic = true | false.
    static lombok.core.configuration.ConfigurationKey<lombok.core.configuration.IdentifierName> LOG_ANY_FIELD_NAME
    lombok configuration: lombok.log.fieldName = <String: aJavaIdentifier> (Default: log).
    static lombok.core.configuration.ConfigurationKey<lombok.core.configuration.FlagUsageType> LOG_ANY_FLAG_USAGE
    lombok configuration: lombok.log.flagUsage = WARNING | ERROR.
    static lombok.core.configuration.ConfigurationKey<lombok.core.configuration.FlagUsageType> LOG_COMMONS_FLAG_USAGE
    lombok configuration: lombok.log.apacheCommons.flagUsage = WARNING | ERROR.
    static lombok.core.configuration.ConfigurationKey<lombok.core.configuration.LogDeclaration> LOG_CUSTOM_DECLARATION
    lombok configuration: lombok.log.custom.declaration = <logDeclaration string>.
    static lombok.core.configuration.ConfigurationKey<lombok.core.configuration.FlagUsageType> LOG_CUSTOM_FLAG_USAGE
    lombok configuration: lombok.log.custom.flagUsage = WARNING | ERROR.
    static lombok.core.configuration.ConfigurationKey<lombok.core.configuration.FlagUsageType> LOG_FLOGGER_FLAG_USAGE
    lombok configuration: lombok.log.flogger.flagUsage = WARNING | ERROR.
    static lombok.core.configuration.ConfigurationKey<lombok.core.configuration.FlagUsageType> LOG_JBOSSLOG_FLAG_USAGE
    lombok configuration: lombok.log.jbosslog.flagUsage = WARNING | ERROR.
    static lombok.core.configuration.ConfigurationKey<lombok.core.configuration.FlagUsageType> LOG_JUL_FLAG_USAGE
    lombok configuration: lombok.log.javaUtilLogging.flagUsage = WARNING | ERROR.
    static lombok.core.configuration.ConfigurationKey<lombok.core.configuration.FlagUsageType> LOG_LOG4J_FLAG_USAGE
    lombok configuration: lombok.log.log4j.flagUsage = WARNING | ERROR.
    static lombok.core.configuration.ConfigurationKey<lombok.core.configuration.FlagUsageType> LOG_LOG4J2_FLAG_USAGE
    lombok configuration: lombok.log.log4j2.flagUsage = WARNING | ERROR.
    static lombok.core.configuration.ConfigurationKey<lombok.core.configuration.FlagUsageType> LOG_SLF4J_FLAG_USAGE
    lombok configuration: lombok.log.slf4j.flagUsage = WARNING | ERROR.
    static lombok.core.configuration.ConfigurationKey<lombok.core.configuration.FlagUsageType> LOG_XSLF4J_FLAG_USAGE
    lombok configuration: lombok.log.xslf4j.flagUsage = WARNING | ERROR.
    static lombok.core.configuration.ConfigurationKey<java.lang.Boolean> LOMBOK_DISABLE
    lombok configuration: dangerousconfig.lombok.disable = true | false.
    static lombok.core.configuration.ConfigurationKey<java.lang.Boolean> NO_ARGS_CONSTRUCTOR_EXTRA_PRIVATE
    lombok configuration: lombok.noArgsConstructor.extraPrivate = true | false.
    static lombok.core.configuration.ConfigurationKey<lombok.core.configuration.FlagUsageType> NO_ARGS_CONSTRUCTOR_FLAG_USAGE
    lombok configuration: lombok.noArgsConstructor.flagUsage = WARNING | ERROR.
    static lombok.core.configuration.ConfigurationKey<lombok.core.configuration.NullCheckExceptionType> NON_NULL_EXCEPTION_TYPE
    lombok configuration: lombok.nonNull.exceptionType = one of: [IllegalArgumentException, NullPointerException, JDK, Guava, or Assertion].
    static lombok.core.configuration.ConfigurationKey<lombok.core.configuration.FlagUsageType> NON_NULL_FLAG_USAGE
    lombok configuration: lombok.nonNull.flagUsage = WARNING | ERROR.
    static lombok.core.configuration.ConfigurationKey<lombok.core.configuration.FlagUsageType> ON_X_FLAG_USAGE
    lombok configuration: lombok.onX.flagUsage = WARNING | ERROR.
    static lombok.core.configuration.ConfigurationKey<lombok.core.configuration.FlagUsageType> REQUIRED_ARGS_CONSTRUCTOR_FLAG_USAGE
    lombok configuration: lombok.requiredArgsConstructor.flagUsage = WARNING | ERROR.
    static lombok.core.configuration.ConfigurationKey<lombok.core.configuration.FlagUsageType> SETTER_FLAG_USAGE
    lombok configuration: lombok.setter.flagUsage = WARNING | ERROR.
    static lombok.core.configuration.ConfigurationKey<java.lang.Boolean> SINGULAR_AUTO
    lombok configuration: lombok.singular.auto = true | false.
    static lombok.core.configuration.ConfigurationKey<java.lang.Boolean> SINGULAR_USE_GUAVA
    lombok configuration: lombok.singular.useGuava = true | false.
    static lombok.core.configuration.ConfigurationKey<lombok.core.configuration.FlagUsageType> SNEAKY_THROWS_FLAG_USAGE
    lombok configuration: lombok.sneakyThrows.flagUsage = WARNING | ERROR.
    static lombok.core.configuration.ConfigurationKey<java.lang.Boolean> STOP_BUBBLING
    lombok configuration: config.stopBubbling = true | false.
    static lombok.core.configuration.ConfigurationKey<lombok.core.configuration.FlagUsageType> SUPERBUILDER_FLAG_USAGE
    lombok configuration: lombok.superBuilder.flagUsage = WARNING | ERROR.
    static lombok.core.configuration.ConfigurationKey<lombok.core.configuration.FlagUsageType> SYNCHRONIZED_FLAG_USAGE
    lombok configuration: lombok.synchronized.flagUsage = WARNING | ERROR.
    static lombok.core.configuration.ConfigurationKey<lombok.core.configuration.CallSuperType> TO_STRING_CALL_SUPER
    lombok configuration: lombok.toString.callSuper = call | ignore | warn.
    static lombok.core.configuration.ConfigurationKey<java.lang.Boolean> TO_STRING_DO_NOT_USE_GETTERS
    lombok configuration: lombok.toString.doNotUseGetters = true | false.
    static lombok.core.configuration.ConfigurationKey<lombok.core.configuration.FlagUsageType> TO_STRING_FLAG_USAGE
    lombok configuration: lombok.toString.flagUsage = WARNING | ERROR.
    static lombok.core.configuration.ConfigurationKey<java.lang.Boolean> TO_STRING_INCLUDE_FIELD_NAMES
    lombok configuration: lombok.toString.includeFieldNames = true | false.
    static lombok.core.configuration.ConfigurationKey<lombok.core.configuration.FlagUsageType> UTILITY_CLASS_FLAG_USAGE
    lombok configuration: lombok.utilityClass.flagUsage = WARNING | ERROR.
    static lombok.core.configuration.ConfigurationKey<lombok.core.configuration.FlagUsageType> VAL_FLAG_USAGE
    lombok configuration: lombok.val.flagUsage = WARNING | ERROR.
    static lombok.core.configuration.ConfigurationKey<lombok.core.configuration.FlagUsageType> VALUE_FLAG_USAGE
    lombok configuration: lombok.value.flagUsage = WARNING | ERROR.
    static lombok.core.configuration.ConfigurationKey<lombok.core.configuration.FlagUsageType> VAR_FLAG_USAGE  
    static lombok.core.configuration.ConfigurationKey<lombok.core.configuration.FlagUsageType> WITH_FLAG_USAGE
    lombok configuration: lombok.with.flagUsage = WARNING | ERROR.
  • Method Summary

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
  • Field Details

    • LOMBOK_DISABLE

      public static final lombok.core.configuration.ConfigurationKey<java.lang.Boolean> LOMBOK_DISABLE
      lombok configuration: dangerousconfig.lombok.disable = true | false. If true, lombok is disabled entirely.
    • ADD_GENERATED_ANNOTATIONS

      @Deprecated public static final lombok.core.configuration.ConfigurationKey<java.lang.Boolean> ADD_GENERATED_ANNOTATIONS
      Deprecated.
      Since version 1.16.14, use ADD_JAVAX_GENERATED_ANNOTATIONS instead.
      lombok configuration: lombok.addGeneratedAnnotation = true | false. If true, lombok generates @javax.annotation.Generated("lombok") on all fields, methods, and types that are generated, unless lombok.addJavaxGeneratedAnnotation is set.
      BREAKING CHANGE: Starting with lombok v1.16.20, defaults to false instead of true, as this annotation is broken in JDK9.
      See Also:
      ADD_JAVAX_GENERATED_ANNOTATIONS, ADD_LOMBOK_GENERATED_ANNOTATIONS
    • ADD_JAVAX_GENERATED_ANNOTATIONS

      public static final lombok.core.configuration.ConfigurationKey<java.lang.Boolean> ADD_JAVAX_GENERATED_ANNOTATIONS
      lombok configuration: lombok.addJavaxGeneratedAnnotation = true | false. If true, lombok generates @javax.annotation.Generated("lombok") on all fields, methods, and types that are generated.
      BREAKING CHANGE: Starting with lombok v1.16.20, defaults to false instead of true, as this annotation is broken in JDK9.
    • ADD_LOMBOK_GENERATED_ANNOTATIONS

      public static final lombok.core.configuration.ConfigurationKey<java.lang.Boolean> ADD_LOMBOK_GENERATED_ANNOTATIONS
      lombok configuration: lombok.addLombokGeneratedAnnotation = true | false. If true, lombok generates @lombok.Generated on all fields, methods, and types that are generated.
    • ADD_FINDBUGS_SUPPRESSWARNINGS_ANNOTATIONS

      public static final lombok.core.configuration.ConfigurationKey<java.lang.Boolean> ADD_FINDBUGS_SUPPRESSWARNINGS_ANNOTATIONS
      lombok configuration: lombok.extern.findbugs.addSuppressFBWarnings = true | false. If true, lombok generates edu.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 type SuppressFBWarnings cannot be found.
    • ADD_NULL_ANNOTATIONS

      public static final lombok.core.configuration.ConfigurationKey<lombok.core.configuration.NullAnnotationLibrary> ADD_NULL_ANNOTATIONS
      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]. 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 annotations javax.annotation.NonNull and javax.annotation.Nullable are used.
      • eclipse - The annotations org.eclipse.jdt.annotation.NonNull and org.eclipse.jdt.annotation.Nullable are used.
      • jetbrains - The annotations org.jetbrains.annotations.NotNull and org.jetbrains.annotations.Nullable are used.
      • netbeans - The annotations org.netbeans.api.annotations.common.NonNull and org.netbeans.api.annotations.common.NullAllowed are used.
      • androidx - The annotations androidx.annotation.NonNull and androidx.annotation.Nullable are used.
      • android.support - The annotations android.support.annotation.NonNull and android.support.annotation.Nullable are used.
      • checkerframework - The annotations org.checkerframework.checker.nullness.qual.NonNull and org.checkerframework.checker.nullness.qual.Nullable are used.
      • findbugs - The annotations edu.umd.cs.findbugs.annotations.NonNull and edu.umd.cs.findbugs.annotations.Nullable are used.
      • spring - The annotations org.springframework.lang.NonNull and org.springframework.lang.Nullable are used.
      • jml - The annotations org.jmlspecs.annotation.NonNull and org.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_USAGE
      lombok 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<java.lang.Boolean> ANY_CONSTRUCTOR_SUPPRESS_CONSTRUCTOR_PROPERTIES
      Deprecated.
      Since version 2.0, use ANY_CONSTRUCTOR_ADD_CONSTRUCTOR_PROPERTIES instead.
      lombok configuration: lombok.anyConstructor.suppressConstructorProperties = true | false. If false 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 to true. NB: GWT projects, and probably android projects, should explicitly set this key to true for the entire project.
      BREAKING CHANGE: Starting with lombok v1.16.20, defaults to false instead of true, as @ConstructorProperties requires extra modules in JDK9.
      See Also:
      ANY_CONSTRUCTOR_ADD_CONSTRUCTOR_PROPERTIES
    • ANY_CONSTRUCTOR_ADD_CONSTRUCTOR_PROPERTIES

      public static final lombok.core.configuration.ConfigurationKey<java.lang.Boolean> ANY_CONSTRUCTOR_ADD_CONSTRUCTOR_PROPERTIES
      lombok configuration: lombok.anyConstructor.addConstructorProperties = true | false. If true, 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_USAGE
      lombok 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_USAGE
      lombok 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<java.lang.Boolean> NO_ARGS_CONSTRUCTOR_EXTRA_PRIVATE
      lombok configuration: lombok.noArgsConstructor.extraPrivate = true | false. If true (default), @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_USAGE
      lombok 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_USAGE
      lombok 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_USAGE
      lombok 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_USAGE
      lombok 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_USAGE
      lombok configuration: lombok.getter.lazy.flagUsage = WARNING | ERROR. If set, any usage of @Getter(lazy=true) results in a warning / error.
    • GETTER_CONSEQUENT_BOOLEAN

      public static final lombok.core.configuration.ConfigurationKey<java.lang.Boolean> GETTER_CONSEQUENT_BOOLEAN
      lombok configuration: lombok.getter.noIsPrefix = true | false. If true, booleans getters are both referred to, and generated as getFieldName(). If false (the default), the javabean-standard isFieldName() is generated / used instead.
    • SETTER_FLAG_USAGE

      public static final lombok.core.configuration.ConfigurationKey<lombok.core.configuration.FlagUsageType> SETTER_FLAG_USAGE
      lombok 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<java.lang.Boolean> EQUALS_AND_HASH_CODE_DO_NOT_USE_GETTERS
      lombok configuration: lombok.equalsAndHashCode.doNotUseGetters = true | false. For any class without an @EqualsAndHashCode that explicitly defines the doNotUseGetters 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_SUPER
      lombok configuration: lombok.equalsAndHashCode.callSuper = call | ignore | warn. For any class with an @EqualsAndHashCode annotation which extends a class other than java.lang.Object, should a call to superclass's implementation of equals and hashCode 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_USAGE
      lombok 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<java.lang.Boolean> TO_STRING_DO_NOT_USE_GETTERS
      lombok configuration: lombok.toString.doNotUseGetters = true | false. For any class without an @ToString that explicitly defines the doNotUseGetters 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_SUPER
      lombok configuration: lombok.toString.callSuper = call | ignore | warn. For any class with an @ToString annotation which extends a class other than java.lang.Object, should a call to superclass's implementation of toString 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_USAGE
      lombok 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<java.lang.Boolean> TO_STRING_INCLUDE_FIELD_NAMES
      lombok configuration: lombok.toString.includeFieldNames = true | false. For any class without an @ToString that explicitly defines the includeFieldNames option, this value is used (default = true).
    • BUILDER_CLASS_NAME

      public static final lombok.core.configuration.ConfigurationKey<java.lang.String> 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 explicit builderClassName 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_USAGE
      lombok configuration: lombok.builder.flagUsage = WARNING | ERROR. If set, any usage of @Builder results in a warning / error.
    • SINGULAR_USE_GUAVA

      public static final lombok.core.configuration.ConfigurationKey<java.lang.Boolean> SINGULAR_USE_GUAVA
      lombok configuration: lombok.singular.useGuava = true | false. If explicitly set to true, guava's ImmutableList etc are used to implement the immutable collection datatypes generated by @Singular @Builder for fields/parameters of type java.util.List and such. By default, unmodifiable-wrapped versions of java.util types are used.
    • SINGULAR_AUTO

      public static final lombok.core.configuration.ConfigurationKey<java.lang.Boolean> SINGULAR_AUTO
      lombok configuration: lombok.singular.auto = true | false. By default or if explicitly set to true, 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 to false, 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_USAGE
      lombok 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_USAGE
      lombok 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_TYPE
      lombok configuration: lombok.nonNull.exceptionType = one of: [IllegalArgumentException, NullPointerException, JDK, Guava, or Assertion]. Sets the behavior of the generated nullcheck if @NonNull is applied to a method parameter, and a caller passes in null.
      • If the chosen configuration is NullPointerException (the default), or IllegalArgumentException, that exception type is a thrown, with as message field-name is marked non-null but is null.
      • If the chosen configuration is Assert, then an assert statement is generated. This means an AssertionError 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 to java.util.Objects.requireNonNull is generated with the fieldname passed along (which throws NullPointerException).
      • If the chosen configuration is Guava, a call to com.google.common.base.Preconditions.checkNotNull is generated with the fieldname passed along (which throws NullPointerException).
      NB: The chosen nullcheck style is also used by @Builder's @Singular annotation to check any collections passed to a plural-form method.
    • NON_NULL_FLAG_USAGE

      public static final lombok.core.configuration.ConfigurationKey<lombok.core.configuration.FlagUsageType> NON_NULL_FLAG_USAGE
      lombok 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_USAGE
      lombok 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_USAGE
      lombok 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_USAGE
      lombok configuration: lombok.val.flagUsage = WARNING | ERROR. If set, any usage of val 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_USAGE
      lombok 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_USAGE
      lombok configuration: lombok.log.flagUsage = WARNING | ERROR. If set, any usage of any of the log annotations in lombok.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_USAGE
      lombok 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_USAGE
      lombok 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_USAGE
      lombok 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_USAGE
      lombok 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_USAGE
      lombok 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_USAGE
      lombok 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_USAGE
      lombok 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_USAGE
      lombok 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_NAME
      lombok 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 of log as a name.
    • LOG_ANY_FIELD_IS_STATIC

      public static final lombok.core.configuration.ConfigurationKey<java.lang.Boolean> LOG_ANY_FIELD_IS_STATIC
      lombok configuration: lombok.log.fieldIsStatic = true | false. If not set, or set to true, the log field generated by the various log annotations will be static. If set to false, 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_USAGE
      lombok 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_DECLARATION
      lombok 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 a public 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 with TOPIC and at most one without TOPIC. You can specify both.
      An example: my.cool.Logger my.cool.LoggerFactory.createLogger(TYPE)(TYPE,TOPIC)
      If no topic is provided in the usage of @CustomLog, the above will invoke LoggerFactory's createLogger method, passing in the type as a java.lang.Class variable.
      If a topic is provided, the overload of that method is invoked with 2 parameters: First the type (as Class), then the topic (as String).

      If this configuration key is not set, any usage of @CustomLog will result in an error.

    • EXPERIMENTAL_FLAG_USAGE

      public static final lombok.core.configuration.ConfigurationKey<lombok.core.configuration.FlagUsageType> EXPERIMENTAL_FLAG_USAGE
      lombok configuration: lombok.experimental.flagUsage = WARNING | ERROR. If set, any usage of any experimental features (from package lombok.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_USAGE
      lombok configuration: lombok.accessors.flagUsage = WARNING | ERROR. If set, any usage of @Accessors results in a warning / error.
    • ACCESSORS_PREFIX

      public static final lombok.core.configuration.ConfigurationKey<java.util.List<java.lang.String>> ACCESSORS_PREFIX
      lombok configuration: lombok.accessors.prefix += <String: prefix>. For any class without an @Accessors that explicitly defines the prefix option, this list of prefixes is used.
    • ACCESSORS_CHAIN

      public static final lombok.core.configuration.ConfigurationKey<java.lang.Boolean> ACCESSORS_CHAIN
      lombok configuration: lombok.accessors.chain = true | false. For any class without an @Accessors that explicitly defines the chain option, this value is used (default = false).
    • ACCESSORS_FLUENT

      public static final lombok.core.configuration.ConfigurationKey<java.lang.Boolean> ACCESSORS_FLUENT
      lombok configuration: lombok.accessors.fluent = true | false. For any class without an @Accessors that explicitly defines the fluent option, this value is used (default = false).
    • EXTENSION_METHOD_FLAG_USAGE

      public static final lombok.core.configuration.ConfigurationKey<lombok.core.configuration.FlagUsageType> EXTENSION_METHOD_FLAG_USAGE
      lombok 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<java.lang.Boolean> FIELD_DEFAULTS_PRIVATE_EVERYWHERE
      lombok configuration: lombok.fieldDefaults.defaultPrivate = true | false. If set to true any field without an access modifier or @PackagePrivate is marked as private by lombok, in all source files compiled.
    • FIELD_DEFAULTS_FINAL_EVERYWHERE

      public static final lombok.core.configuration.ConfigurationKey<java.lang.Boolean> FIELD_DEFAULTS_FINAL_EVERYWHERE
      lombok configuration: lombok.fieldDefaults.defaultFinal = true | false. If set to true any field without @NonFinal is marked as final 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_USAGE
      lombok 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_USAGE
      lombok configuration: lombok.helper.flagUsage = WARNING | ERROR. If set, any usage of @Helper results in a warning / error.
    • ON_X_FLAG_USAGE

      public static final lombok.core.configuration.ConfigurationKey<lombok.core.configuration.FlagUsageType> ON_X_FLAG_USAGE
      lombok configuration: lombok.onX.flagUsage = WARNING | ERROR. If set, any usage of onX 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_USAGE
      lombok 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_USAGE
      lombok 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_NAME
      lombok 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<java.lang.Boolean> FIELD_NAME_CONSTANTS_UPPERCASE
      lombok 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_USAGE
      lombok configuration: lombok.superBuilder.flagUsage = WARNING | ERROR. If set, any usage of @SuperBuilder results in a warning / error.
    • STOP_BUBBLING

      public static final lombok.core.configuration.ConfigurationKey<java.lang.Boolean> STOP_BUBBLING
      lombok configuration: config.stopBubbling = true | false. If not set, or set to false, the configuration system will look for lombok.config files in the parent directory. If set to true, no further lombok.config files will be checked.
    • COPYABLE_ANNOTATIONS

      public static final lombok.core.configuration.ConfigurationKey<java.util.List<lombok.core.configuration.TypeName>> COPYABLE_ANNOTATIONS
      lombok 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_FRAMEWORK
      lombok configuration: checkerframework = true | false | <String: MajorVer.MinorVer> (Default: false). If set, lombok will generate appropriate annotations from checkerframework.org on generated code. If set to true, 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.