From b49472094901ce272de255dab9d9eac18ab5f91e Mon Sep 17 00:00:00 2001 From: Reinier Zwitserloot Date: Tue, 20 Jul 2010 12:32:19 +0200 Subject: Small updates to website docs after feedback from RJ and Roel. --- website/features/Constructor.html | 3 ++- website/features/GetterSetter.html | 4 ++-- 2 files changed, 4 insertions(+), 3 deletions(-) (limited to 'website') diff --git a/website/features/Constructor.html b/website/features/Constructor.html index f8a6a200..6a7cfd2f 100644 --- a/website/features/Constructor.html +++ b/website/features/Constructor.html @@ -66,7 +66,8 @@ signals you must know what you're doing.

The @java.beans.ConstructorProperties annotation is never generated for a constructor with no arguments. This also explains why @NoArgsConstructor - lacks the suppressConstructorProperties annotation method. The @ConstructorProperties annotation is also omitted for private constructors. + lacks the suppressConstructorProperties annotation method. The @ConstructorProperties annotation is also omitted for private constructors. The + generated static factory methods also do not get @ConstructorProperties, as this annotation can only be added to real constructors.

diff --git a/website/features/GetterSetter.html b/website/features/GetterSetter.html index 0e9481a4..ea1af150 100644 --- a/website/features/GetterSetter.html +++ b/website/features/GetterSetter.html @@ -20,7 +20,7 @@ if the field's type is boolean). A default setter is named setFoo if the field is called foo, returns void, and takes 1 parameter of the same type as the field. It simply sets the field to this value.

- The generated getter/setter method will be public unless you explicitly specify an AccessLevel, as shown in the example above. + The generated getter/setter method will be public unless you explicitly specify an AccessLevel, as shown in the example below. Legal access levels are PUBLIC, PROTECTED, PACKAGE, and PRIVATE.

You can also put a @Getter and/or @Setter annotation on a class. In that case, it's as if you annotate all the non-static fields in that @@ -60,7 +60,7 @@

Any annotations named @NonNull (case insensitive) on the field are interpreted as: This field must not ever hold null. Therefore, these annotations result in an explicit null check in the generated setter. Also, these - annotations (as well as any annotation named @Nullable) are copied to setter parameter and getter method + annotations (as well as any annotation named @Nullable or @CheckForNull) are copied to setter parameter and getter method

Using the AccessLevel.NONE access level simply generates nothing. It's useful only in combination with @Data. -- cgit