Annotation Type RequiredArgsConstructor

@Target(TYPE) @Retention(SOURCE) public @interface RequiredArgsConstructor
Generates a constructor with required arguments. Required arguments are final fields and fields with constraints such as @NonNull.

Complete documentation is found at the project lombok features page for @Constructor.

Even though it is not listed, this annotation also has the onConstructor parameter. See the full documentation for more details.

See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static @interface 
    RequiredArgsConstructor.AnyAnnotation
    Deprecated.
    Don't use this annotation, ever - Read the documentation.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    AccessLevel
    access
    Sets the access level of the constructor.
    RequiredArgsConstructor.AnyAnnotation[]
    onConstructor
    Any annotations listed here are put on the generated constructor.
    String
    staticName
    If set, the generated constructor will be private, and an additional static 'constructor' is generated with the same argument list that wraps the real constructor.

  • Element Details

    • staticName

      String staticName
      If set, the generated constructor will be private, and an additional static 'constructor' is generated with the same argument list that wraps the real constructor. Such a static 'constructor' is primarily useful as it infers type arguments.
      Returns:
      Name of static 'constructor' method to generate (blank = generate a normal constructor).
      Default:
      ""

    • onConstructor

      RequiredArgsConstructor.AnyAnnotation[] onConstructor
      Any annotations listed here are put on the generated constructor. The syntax for this feature depends on JDK version (nothing we can do about that; it's to work around javac bugs).
      up to JDK7:
      @RequiredArgsConstructor(onConstructor=@__({@AnnotationsGoHere}))
      from JDK8:
      @RequiredArgsConstructor(onConstructor_={@AnnotationsGohere}) // note the underscore after onConstructor.
      Returns:
      List of annotations to apply to the generated constructor.
      Default:
      {}

    • access

      AccessLevel access
      Sets the access level of the constructor. By default, generated constructors are public.
      Returns:
      The constructor will be generated with this access modifier.
      Default:
      PUBLIC