aboutsummaryrefslogtreecommitdiff
path: root/website
diff options
context:
space:
mode:
authorReinier Zwitserloot <reinier@zwitserloot.com>2014-02-10 20:22:33 +0100
committerReinier Zwitserloot <reinier@zwitserloot.com>2014-02-10 20:22:33 +0100
commit893585f526b852ff5059d279e69927fab0d41d42 (patch)
tree24b1591cd14adfe298542d0d0ac978d7a2abca1e /website
parent6b0acc9a19cce1c13496d132ce695415780ab52b (diff)
downloadlombok-893585f526b852ff5059d279e69927fab0d41d42.tar.gz
lombok-893585f526b852ff5059d279e69927fab0d41d42.tar.bz2
lombok-893585f526b852ff5059d279e69927fab0d41d42.zip
[i386] documentation update for Data/Value's behaviour in the face of existing constructors.
Diffstat (limited to 'website')
-rw-r--r--website/features/Data.html2
-rw-r--r--website/features/Value.html2
2 files changed, 2 insertions, 2 deletions
diff --git a/website/features/Data.html b/website/features/Data.html
index ad3aa892..4d6e5609 100644
--- a/website/features/Data.html
+++ b/website/features/Data.html
@@ -38,7 +38,7 @@
</p><p>
If the class already contains a method with the same name as any method that would normally be generated, that method is not generated, and no warning or
error is emitted. For example, if you already have a method with signature <code>void hashCode(int a, int b, int c)</code>, no <code>int hashCode()</code>
- method will be generated, even though technically <code>int hashCode()</code> is an entirely different method. The same rule applies to the constructor,
+ method will be generated, even though technically <code>int hashCode()</code> is an entirely different method. The same rule applies to the constructor (any explicit constructor will prevent <code>@Data</code> from generating one),
<code>toString</code>, <code>equals</code>, and all getters and setters.
</p><p>
<code>@Data</code> can handle generics parameters for fields just fine. In order to reduce the boilerplate when constructing objects for classes with
diff --git a/website/features/Value.html b/website/features/Value.html
index 6bbd6f2a..e5dc7d9e 100644
--- a/website/features/Value.html
+++ b/website/features/Value.html
@@ -27,7 +27,7 @@
<code>@Value</code> is the immutable variant of <a href="Data.html"><code>@Data</code></a>; all fields are made <code>private</code> and <code>final</code> by default, and setters are not generated. The class itself is also made <code>final</code> by default, because immutability is not something that can be forced onto a subclass. Like <code>@Data</code>, useful <code>toString()</code>, <code>equals()</code> and <code>hashCode()</code> methods are also generated, each field gets a getter method, and a constructor that covers every
argument (except <code>final</code> fields that are initialized in the field declaration) is also generated.
</p><p>
- In practice, <code>@Value</code> is shorthand for: <code>final @ToString @EqualsAndHashCode @AllArgsConstructor @FieldDefaults(makeFinal = true, level = AccessLevel.PRIVATE) @Getter</code>.
+ In practice, <code>@Value</code> is shorthand for: <code>final @ToString @EqualsAndHashCode @AllArgsConstructor @FieldDefaults(makeFinal = true, level = AccessLevel.PRIVATE) @Getter</code>, except that explicitly including an implementation of any of the relevant methods simply means that part won't be generated and no warning will be emitted. For example, if you write your own <code>toString</code>, no error occurs, and lombok will not generate a <code>toString</code>. Also, <em>any</em> explicit constructor, no matter the arguments list, implies lombok will not generate a constructor. If you do want lombok to generate the all-args constructor, add <code>@AllArgsConstructor</code> to the class.
</p><p>
It is possible to override the final-by-default and private-by-default behaviour using either an explicit access level on a field, or by using the <code>@NonFinal</code> or <code>@PackagePrivate</code> annotations.<br />
It is possible to override any default behaviour for any of the 'parts' that make up <code>@Value</code> by explicitly using that annotation.