From 8b7a7cbc813653a3248d6cf3a7779e220957bc85 Mon Sep 17 00:00:00 2001 From: Reinier Zwitserloot Date: Mon, 8 May 2017 21:28:02 +0200 Subject: The great rename: the old ‘website’ is now ‘website-old’, and ‘website2’ is now ‘website’. MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- website2/templates/_scaffold.html | 118 --------------- website2/templates/all-versions.html | 144 ------------------ website2/templates/changelog.html | 11 -- website2/templates/credits.html | 50 ------- website2/templates/disable-checked-exceptions.html | 24 --- website2/templates/download.html | 102 ------------- website2/templates/features/Builder.html | 163 --------------------- website2/templates/features/BuilderSingular.html | 5 - website2/templates/features/Cleanup.html | 35 ----- website2/templates/features/Data.html | 41 ------ website2/templates/features/EqualsAndHashCode.html | 56 ------- website2/templates/features/GetterLazy.html | 31 ---- website2/templates/features/GetterSetter.html | 70 --------- website2/templates/features/NonNull.html | 45 ------ website2/templates/features/SneakyThrows.html | 44 ------ website2/templates/features/Synchronized.html | 34 ----- website2/templates/features/ToString.html | 54 ------- website2/templates/features/Value.html | 50 ------- website2/templates/features/_features.html | 79 ---------- website2/templates/features/configuration.html | 106 -------------- website2/templates/features/constructor.html | 57 ------- website2/templates/features/delombok.html | 61 -------- .../templates/features/experimental/Accessors.html | 75 ---------- .../templates/features/experimental/Delegate.html | 59 -------- .../features/experimental/ExtensionMethod.html | 67 --------- .../features/experimental/FieldDefaults.html | 56 ------- .../templates/features/experimental/Helper.html | 52 ------- .../features/experimental/UtilityClass.html | 44 ------ .../templates/features/experimental/Wither.html | 66 --------- .../templates/features/experimental/index.html | 85 ----------- website2/templates/features/experimental/onX.html | 62 -------- website2/templates/features/experimental/var.html | 37 ----- website2/templates/features/index.html | 87 ----------- website2/templates/features/log.html | 106 -------------- website2/templates/features/val.html | 36 ----- website2/templates/main.html | 47 ------ website2/templates/setup/_setup.html | 28 ---- website2/templates/setup/android.html | 80 ---------- website2/templates/setup/ecj.html | 31 ---- website2/templates/setup/eclipse.html | 26 ---- website2/templates/setup/gwt.html | 16 -- website2/templates/setup/intellij.html | 22 --- website2/templates/setup/javac.html | 15 -- website2/templates/setup/netbeans.html | 16 -- 44 files changed, 2493 deletions(-) delete mode 100644 website2/templates/_scaffold.html delete mode 100644 website2/templates/all-versions.html delete mode 100644 website2/templates/changelog.html delete mode 100644 website2/templates/credits.html delete mode 100644 website2/templates/disable-checked-exceptions.html delete mode 100644 website2/templates/download.html delete mode 100644 website2/templates/features/Builder.html delete mode 100644 website2/templates/features/BuilderSingular.html delete mode 100644 website2/templates/features/Cleanup.html delete mode 100644 website2/templates/features/Data.html delete mode 100644 website2/templates/features/EqualsAndHashCode.html delete mode 100644 website2/templates/features/GetterLazy.html delete mode 100644 website2/templates/features/GetterSetter.html delete mode 100644 website2/templates/features/NonNull.html delete mode 100644 website2/templates/features/SneakyThrows.html delete mode 100644 website2/templates/features/Synchronized.html delete mode 100644 website2/templates/features/ToString.html delete mode 100644 website2/templates/features/Value.html delete mode 100644 website2/templates/features/_features.html delete mode 100644 website2/templates/features/configuration.html delete mode 100644 website2/templates/features/constructor.html delete mode 100644 website2/templates/features/delombok.html delete mode 100644 website2/templates/features/experimental/Accessors.html delete mode 100644 website2/templates/features/experimental/Delegate.html delete mode 100644 website2/templates/features/experimental/ExtensionMethod.html delete mode 100644 website2/templates/features/experimental/FieldDefaults.html delete mode 100644 website2/templates/features/experimental/Helper.html delete mode 100644 website2/templates/features/experimental/UtilityClass.html delete mode 100644 website2/templates/features/experimental/Wither.html delete mode 100644 website2/templates/features/experimental/index.html delete mode 100644 website2/templates/features/experimental/onX.html delete mode 100644 website2/templates/features/experimental/var.html delete mode 100644 website2/templates/features/index.html delete mode 100644 website2/templates/features/log.html delete mode 100644 website2/templates/features/val.html delete mode 100644 website2/templates/main.html delete mode 100644 website2/templates/setup/_setup.html delete mode 100644 website2/templates/setup/android.html delete mode 100644 website2/templates/setup/ecj.html delete mode 100644 website2/templates/setup/eclipse.html delete mode 100644 website2/templates/setup/gwt.html delete mode 100644 website2/templates/setup/intellij.html delete mode 100644 website2/templates/setup/javac.html delete mode 100644 website2/templates/setup/netbeans.html (limited to 'website2/templates') diff --git a/website2/templates/_scaffold.html b/website2/templates/_scaffold.html deleted file mode 100644 index f0198fa3..00000000 --- a/website2/templates/_scaffold.html +++ /dev/null @@ -1,118 +0,0 @@ -<#macro feature title href> -
-

${title}

-

<#nested>

-
- - -<#macro scaffold load=[]> - - - - - - - - - - Project Lombok - - - - - - - - - <#list load as ld> - <#if ld?ends_with(".css")> - - - - - - - - - - <#list load as ld> - <#if ld?ends_with(".js")> - - - - - - Fork me on GitHub - - -
-
-
- Lombok Project - -
- -
-
-
- <#nested> -
- - - - diff --git a/website2/templates/all-versions.html b/website2/templates/all-versions.html deleted file mode 100644 index d3acd648..00000000 --- a/website2/templates/all-versions.html +++ /dev/null @@ -1,144 +0,0 @@ -<#import "/_scaffold.html" as main> -<@main.scaffold> -
-
-
-
-

-
- - - Download ${version} - -
- <#list linksToVersions as lnk> - ${lnk[1]} - -
- - changelog - -
-

-
-
-
-
-

- Feeling adventurous? Download the latest snapshot - release. -

-
-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- diff --git a/website2/templates/changelog.html b/website2/templates/changelog.html deleted file mode 100644 index 80697e70..00000000 --- a/website2/templates/changelog.html +++ /dev/null @@ -1,11 +0,0 @@ -<#import "/_scaffold.html" as main> -<@main.scaffold> -
-
-

Changelog

-
-
-

@CHANGELOG@

-
-
- diff --git a/website2/templates/credits.html b/website2/templates/credits.html deleted file mode 100644 index 9e929256..00000000 --- a/website2/templates/credits.html +++ /dev/null @@ -1,50 +0,0 @@ -<#import "/_scaffold.html" as main> - -<@main.scaffold> -
-
-

Project Lombok - About the authors and everyone that's helped us create Project Lombok.

-
-
-
-
-

Regular contributors to Project Lombok:

- -
-
-
- Reinier Zwitserloot -
-
-
- Roel Spilker -
-
-
-
- We'd like to thank: -
    -
  • - Perry Nguyen (pfn on ##java on freenode) for creating the inspiration for project lombok. -
  • - Tor Norbye, Jan Lahoda, and Petr Jiricka for helping out with Netbeans internals and/or javac. -
  • - All contributors who submitted patches or helped answering questions!
    • -
- - as well as the authors of the following tools that we use: - -
    -
  • - Github for hosting lombok's repository and issue tracker. -
  • - The ASM team at ObjectWeb for creating an excellent class file editing tool. Lombok uses ASM to interact with Eclipse. -
  • - Markus Gebhard for creating java2html which we use for the example code snippets on the features pages. -
    • -
-
-
-
-
- diff --git a/website2/templates/disable-checked-exceptions.html b/website2/templates/disable-checked-exceptions.html deleted file mode 100644 index 94dd433e..00000000 --- a/website2/templates/disable-checked-exceptions.html +++ /dev/null @@ -1,24 +0,0 @@ -
-
-

Tired of checked exceptions?

-
-
-

- This lombok spinoff project consists of a hack that only works in javac - not eclipse or any other IDE.
- It will completely disable the notion of checked exceptions. You may throw any exception anywhere, and you may also catch any exception anywhere. In standard javac, you may not catch a checked exception that is not declared as thrown by at least 1 statement in your try block, unless it is Exception or Throwable.
- This restriction is lifted as well. -

-
-
-

Usage

- -

- Just make sure disableCheckedExceptions-alpha.jar is on the classpath as you compile. For example:
- javac -cp disableCheckedExceptions-alpha.jar MySource.java -

- Ready to try it out? download it here: disableCheckedExceptions-alpha.jar -

- Want to know how its done? Grab the lombok repository here on github, and look in the experimental directory. -

-
-
diff --git a/website2/templates/download.html b/website2/templates/download.html deleted file mode 100644 index af992c39..00000000 --- a/website2/templates/download.html +++ /dev/null @@ -1,102 +0,0 @@ -<#import "/_scaffold.html" as main> -<@main.scaffold> -
-
-
-
-

-
- - - Download ${version} - -
-
- - changelog - -
-

-
-
-
-
-

- Feeling adventurous? Download the latest snapshot - release. -

-
-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- diff --git a/website2/templates/features/Builder.html b/website2/templates/features/Builder.html deleted file mode 100644 index a6b8d18f..00000000 --- a/website2/templates/features/Builder.html +++ /dev/null @@ -1,163 +0,0 @@ -<#import "_features.html" as f> - -<@f.scaffold title="@Builder" logline="... and Bob's your uncle: No-hassle fancy-pants APIs for object creation!"> - <@f.history> -

- @Builder was introduced as experimental feature in lombok v0.12.0. -

- @Builder gained @Singular support and was promoted to the main lombok package since lombok v1.16.0. -

- @Builder with @Singular adds a clear method since lombok v1.16.8. -

- @Builder.Default functionality was added in lombok v1.16.16. -

- - - <@f.overview> -

- The @Builder annotation produces complex builder APIs for your classes. -

- @Builder lets you automatically produce the code required to have your class be instantiable with code such as:
- Person.builder().name("Adam Savage").city("San Francisco").job("Mythbusters").job("Unchained Reaction").build(); -

- @Builder can be placed on a class, or on a constructor, or on a method. While the "on a class" and "on a constructor" mode are the most common use-case, @Builder is most easily explained with the "method" use-case. -

- A method annotated with @Builder (from now on called the target) causes the following 7 things to be generated: -

- Each listed generated element will be silently skipped if that element already exists (disregarding parameter counts and looking only at names). This includes the builder itself: If that class already exists, lombok will simply start injecting fields and methods inside this already existing class, unless of course the fields / methods to be injected already exist. You may not put any other method (or constructor) generating lombok annotation on a builder class though; for example, you can not put @EqualsAndHashCode on the builder class. -

- @Builder can generate so-called 'singular' methods for collection parameters/fields. These take 1 element instead of an entire list, and add the element to the list. For example: Person.builder().job("Mythbusters").job("Unchained Reaction").build(); would result in the List<String> jobs field to have 2 strings in it. To get this behaviour, the field/parameter needs to be annotated with @Singular. The feature has its own documentation. -

- Now that the "method" mode is clear, putting a @Builder annotation on a constructor functions similarly; effectively, constructors are just static methods that have a special syntax to invoke them: Their 'return type' is the class they construct, and their type parameters are the same as the type parameters of the class itself. -

- Finally, applying @Builder to a class is as if you added @AllArgsConstructor(access = AccessLevel.PACKAGE) to the class and applied the @Builder annotation to this all-args-constructor. This only works if you haven't written any explicit constructors yourself. If you do have an explicit constructor, put the @Builder annotation on the constructor instead of on the class. -

- If using @Builder to generate builders to produce instances of your own class (this is always the case unless adding @Builder to a method that doesn't return your own type), you can use @Builder(toBuilder = true) to also generate an instance method in your class called toBuilder(); it creates a new builder that starts out with all the values of this instance. You can put the @Builder.ObtainVia annotation on the parameters (in case of a constructor or method) or fields (in case of @Builder on a type) to indicate alternative means by which the value for that field/parameter is obtained from this instance. For example, you can specify a method to be invoked: @Builder.ObtainVia(method = "calculateFoo"). -

- The name of the builder class is FoobarBuilder, where Foobar is the simplified, title-cased form of the return type of the target - that is, the name of your type for @Builder on constructors and types, and the name of the return type for @Builder on methods. For example, if @Builder is applied to a class named com.yoyodyne.FancyList<T>, then the builder name will be FancyListBuilder<T>. If @Builder is applied to a method that returns void, the builder will be named VoidBuilder. -

- The configurable aspects of builder are: -

- Example usage where all options are changed from their defaults:
- @Builder(builderClassName = "HelloWorldBuilder", buildMethodName = "execute", builderMethodName = "helloWorld", toBuilder = true)
-

- - - <@f.featureSection> -

@Builder.Default

- -

- If a certain field/parameter is never set during a build session, then it always gets 0 / null / false. If you've put @Builder on a class (and not a method or constructor) you can instead specify the default directly on the field, and annotate the field with @Builder.Default:
- @Builder.Default private final long created = System.currentTimeMillis(); -

- - - <@f.featureSection> -

@Singular

- -

- By annotating one of the parameters (if annotating a method or constructor with @Builder) or fields (if annotating a class with @Builder) with the @Singular annotation, lombok will treat that builder node as a collection, and it generates 2 'adder' methods instead of a 'setter' method. One which adds a single element to the collection, and one which adds all elements of another collection to the collection. No setter to just set the collection (replacing whatever was already added) will be generated. A 'clear' method is also generated. These 'singular' builders are very complicated in order to guarantee the following properties: -

-

- @Singular can only be applied to collection types known to lombok. Currently, the supported types are: -

-

- If your identifiers are written in common english, lombok assumes that the name of any collection with @Singular on it is an english plural and will attempt to automatically singularize that name. If this is possible, the add-one method will use this name. For example, if your collection is called statuses, then the add-one method will automatically be called status. You can also specify the singular form of your identifier explictly by passing the singular form as argument to the annotation like so: @Singular("axis") List<Line> axes;.
- If lombok cannot singularize your identifier, or it is ambiguous, lombok will generate an error and force you to explicitly specify the singular name. -

- The snippet below does not show what lombok generates for a @Singular field/parameter because it is rather complicated. You can view a snippet here. -

- - - <@f.snippets name="Builder" /> - - <@f.confKeys> -
- lombok.builder.flagUsage = [warning | error] (default: not set) -
- Lombok will flag any usage of @Builder as a warning or error if configured. -
- lombok.singular.useGuava = [true | false] (default: false) -
- If true, lombok will use guava's ImmutableXxx builders and types to implement java.util collection interfaces, instead of creating implementations based on Collections.unmodifiableXxx. You must ensure that guava is actually available on the classpath and buildpath if you use this setting. Guava is used automatically if your field/parameter has one of the guava ImmutableXxx types. -
- lombok.singular.auto = [true | false] (default: true) -
- If true (which is the default), lombok automatically tries to singularize your identifier name by assuming that it is a common english plural. If false, you must always explicitly specify the singular name, and lombok will generate an error if you don't (useful if you write your code in a language other than english). -
- - - <@f.smallPrint> -

- @Singular support for java.util.NavigableMap/Set only works if you are compiling with JDK1.8 or higher. -

- You cannot manually provide some or all parts of a @Singular node; the code lombok generates is too complex for this. If you want to manually control (part of) the builder code associated with some field or parameter, don't use @Singular and add everything you need manually. -

- The sorted collections (java.util: SortedSet, NavigableSet, SortedMap, NavigableMap and guava: ImmutableSortedSet, ImmutableSortedMap) require that the type argument of the collection has natural order (implements java.util.Comparable). There is no way to pass an explicit Comparator to use in the builder. -

- An ArrayList is used to store added elements as call methods of a @Singular marked field, if the target collection is from the java.util package, even if the collection is a set or map. Because lombok ensures that generated collections are compacted, a new backing instance of a set or map must be constructed anyway, and storing the data as an ArrayList during the build process is more efficient that storing it as a map or set. This behaviour is not externally visible, an implementation detail of the current implementation of the java.util recipes for @Singular @Builder. -

- With toBuilder = true applied to methods, any type parameter of the annotated method itself must also show up in the return type. -

- - diff --git a/website2/templates/features/BuilderSingular.html b/website2/templates/features/BuilderSingular.html deleted file mode 100644 index 10253365..00000000 --- a/website2/templates/features/BuilderSingular.html +++ /dev/null @@ -1,5 +0,0 @@ -<#import "_features.html" as f> - -<@f.scaffold title="@Builder @Singular" logline="... and Bob's your uncle: No-hassle fancy-pants APIs for object creation!"> - <@f.snippets name="Singular-snippet" /> - diff --git a/website2/templates/features/Cleanup.html b/website2/templates/features/Cleanup.html deleted file mode 100644 index e868c40d..00000000 --- a/website2/templates/features/Cleanup.html +++ /dev/null @@ -1,35 +0,0 @@ -<#import "_features.html" as f> - -<@f.scaffold title="@Cleanup" logline="Automatic resource management: Call your close() methods safely with no hassle."> - <@f.overview> -

- You can use @Cleanup to ensure a given resource is automatically cleaned up before the code execution path exits your current scope. You do this by annotating any local variable declaration with the @Cleanup annotation like so:
- @Cleanup InputStream in = new FileInputStream("some/file");
- As a result, at the end of the scope you're in, in.close() is called. This call is guaranteed to run by way of a try/finally construct. Look at the example below to see how this works. -

- If the type of object you'd like to cleanup does not have a close() method, but some other no-argument method, you can specify the name of this method like so:
- @Cleanup("dispose") org.eclipse.swt.widgets.CoolBar bar = new CoolBar(parent, 0);
- By default, the cleanup method is presumed to be close(). A cleanup method that takes 1 or more arguments cannot be called via @Cleanup. -

- - - <@f.snippets name="Cleanup" /> - - <@f.confKeys> -
- lombok.cleanup.flagUsage = [warning | error] (default: not set) -
- Lombok will flag any usage of @Cleanup as a warning or error if configured. - - - - <@f.smallPrint> -

- In the finally block, the cleanup method is only called if the given resource is not null. However, if you use delombok on the code, a call to lombok.Lombok.preventNullAnalysis(Object o) is inserted to prevent warnings if static code analysis could determine that a null-check would not be needed. Compilation with lombok.jar on the classpath removes that method call, so there is no runtime dependency. -

- If your code throws an exception, and the cleanup method call that is then triggered also throws an exception, then the original exception is hidden by the exception thrown by the cleanup call. You should not rely on this 'feature'. Preferably, lombok would like to generate code so that, if the main body has thrown an exception, any exception thrown by the close call is silently swallowed (but if the main body exited in any other way, exceptions by the close call will not be swallowed). The authors of lombok do not currently know of a feasible way to implement this scheme, but if java updates allow it, or we find a way, we'll fix it. -

- You do still need to handle any exception that the cleanup method can generate! -

- - diff --git a/website2/templates/features/Data.html b/website2/templates/features/Data.html deleted file mode 100644 index 59370cc8..00000000 --- a/website2/templates/features/Data.html +++ /dev/null @@ -1,41 +0,0 @@ -<#import "_features.html" as f> - -<@f.scaffold title="@Data" - logline="All together now: A shortcut for @ToString, @EqualsAndHashCode, @Getter on all fields, @Setter on all non-final fields, and @RequiredArgsConstructor!"> - - <@f.overview> -

- @Data is a convenient shortcut annotation that bundles the features of @ToString, @EqualsAndHashCode, @Getter / @Setter and @RequiredArgsConstructor together: In other words, @Data generates all the boilerplate that is normally associated with simple POJOs (Plain Old Java Objects) and beans: getters for all fields, setters for all non-final fields, and appropriate toString, equals and hashCode implementations that involve the fields of the class, and a constructor that initializes all final fields, as well as all non-final fields with no initializer that have been marked with @NonNull, in order to ensure the field is never null. -

- @Data is like having implicit @Getter, @Setter, @ToString, @EqualsAndHashCode and @RequiredArgsConstructor annotations on the class (except that no constructor will be generated if any explicitly written constructors already exist). However, the parameters of these annotations (such as callSuper, includeFieldNames and exclude) cannot be set with @Data. If you need to set non-default values for any of these parameters, just add those annotations explicitly; @Data is smart enough to defer to those annotations. -

- All generated getters and setters will be public. To override the access level, annotate the field or class with an explicit @Setter and/or @Getter annotation. You can also use this annotation (by combining it with AccessLevel.NONE) to suppress generating a getter and/or setter altogether. -

- All fields marked as transient will not be considered for hashCode and equals. All static fields will be skipped entirely (not considered for any of the generated methods, and no setter/getter will be made for them). -

- If the class already contains a method with the same name and parameter count 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 equals(AnyType param), no equals method will be generated, even though technically it might be an entirely different method due to having different parameter types. The same rule applies to the constructor (any explicit constructor will prevent @Data from generating one), as well as toString, equals, and all getters and setters. You can mark any constructor or method with @lombok.experimental.Tolerate to hide them from lombok. -

- @Data can handle generics parameters for fields just fine. In order to reduce the boilerplate when constructing objects for classes with generics, you can use the staticConstructor parameter to generate a private constructor, as well as a static method that returns a new instance. This way, javac will infer the variable name. Thus, by declaring like so: @Data(staticConstructor="of") class Foo<T> { private T x;} you can create new instances of Foo by writing: Foo.of(5); instead of having to write: new Foo<Integer>(5);. -

- - - <@f.snippets name="Data" /> - - <@f.confKeys> -
- lombok.data.flagUsage = [warning | error] (default: not set) -
- Lombok will flag any usage of @Data as a warning or error if configured. -
- - - <@f.smallPrint> -

- See the small print of @ToString, @EqualsAndHashCode, @Getter / @Setter and @RequiredArgsConstructor. -

- Any annotations named @NonNull (case insensitive) on a field are interpreted as: This field must not ever hold null. Therefore, these annotations result in an explicit null check in the generated constructor for the provided field. Also, these annotations (as well as any annotation named @Nullable) are copied to the constructor parameter, in both the true constructor and any static constructor. The same principle applies to generated getters and setters (see the documentation for @Getter / @Setter) -

- By default, any variables that start with a $ symbol are excluded automatically. You can include them by specifying an explicit annotation (@Getter or @ToString, for example) and using the 'of' parameter. -

- - diff --git a/website2/templates/features/EqualsAndHashCode.html b/website2/templates/features/EqualsAndHashCode.html deleted file mode 100644 index 3c11367f..00000000 --- a/website2/templates/features/EqualsAndHashCode.html +++ /dev/null @@ -1,56 +0,0 @@ -<#import "_features.html" as f> - -<@f.scaffold title="@EqualsAndHashCode" logline="Equality made easy: Generates hashCode and equals implementations from the fields of your object."> - <@f.overview> -

- Any class definition may be annotated with @EqualsAndHashCode to let lombok generate implementations of the equals(Object other) and hashCode() methods. By default, it'll use all non-static, non-transient fields, but you can exclude more fields by naming them in the optional exclude parameter to the annotation. Alternatively, you can specify exactly which fields you wish to be used by naming them in the of parameter. -

- If applying @EqualsAndHashCode to a class that extends another, this feature gets a bit trickier. Normally, auto-generating an equals and hashCode method for such classes is a bad idea, as the superclass also defines fields, which also need equals/hashCode code but this code will not be generated. By setting callSuper to true, you can include the equals and hashCode methods of your superclass in the generated methods. For hashCode, the result of super.hashCode() is included in the hash algorithm, and forequals, the generated method will return false if the super implementation thinks it is not equal to the passed in object. Be aware that not all equals implementations handle this situation properly. However, lombok-generated equals implementations do handle this situation properly, so you can safely call your superclass equals if it, too, has a lombok-generated equals method. If you have an explicit superclass you are forced to supply some value for callSuper to acknowledge that you've considered it; failure to do so results in a warning. -

- Setting callSuper to true when you don't extend anything (you extend java.lang.Object) is a compile-time error, because it would turn the generated equals() and hashCode() implementations into having the same behaviour as simply inheriting these methods from java.lang.Object: only the same object will be equal to each other and will have the same hashCode. Not setting callSuper to true when you extend another class generates a warning, because unless the superclass has no (equality-important) fields, lombok cannot generate an implementation for you that takes into account the fields declared by your superclasses. You'll need to write your own implementations, or rely on the callSuper chaining facility. You can also use the lombok.equalsAndHashCode.callSuper config key. -

- NEW in Lombok 0.10: Unless your class is final and extends java.lang.Object, lombok generates a canEqual method which means JPA proxies can still be equal to their base class, but subclasses that add new state don't break the equals contract. The complicated reasons for why such a method is necessary are explained in this paper: How to Write an Equality Method in Java. If all classes in a hierarchy are a mix of scala case classes and classes with lombok-generated equals methods, all equality will 'just work'. If you need to write your own equals methods, you should always override canEqual if you change equals and hashCode. -

- NEW in Lombok 1.14.0: To put annotations on the other parameter of the equals (and, if relevant, canEqual) method, you can use onParam=@__({@AnnotationsHere}). Be careful though! This is an experimental feature. For more details see the documentation on the onX feature. -

- - - <@f.snippets name="EqualsAndHashCode" /> - - <@f.confKeys> -
- lombok.equalsAndHashCode.doNotUseGetters = [true | false] (default: false) -
- If set to true, lombok will access fields directly instead of using getters (if available) when generating equals and hashCode methods. The annotation parameter 'doNotUseGetters', if explicitly specified, takes precedence over this setting. -
- lombok.equalsAndHashCode.callSuper = [call | skip | warn] (default: warn) -
- If set to call, lombok will generate calls to the superclass implementation of hashCode and equals if your class extends something. If set to skip no such calls are generated. The default behaviour is like skip, with an additional warning. -
- lombok.equalsAndHashCode.flagUsage = [warning | error] (default: not set) -
- Lombok will flag any usage of @EqualsAndHashCode as a warning or error if configured. -
- - - <@f.smallPrint> -

- Arrays are 'deep' compared/hashCoded, which means that arrays that contain themselves will result in StackOverflowErrors. However, this behaviour is no different from e.g. ArrayList. -

- You may safely presume that the hashCode implementation used will not change between versions of lombok, however this guarantee is not set in stone; if there's a significant performance improvement to be gained from using an alternate hash algorithm, that will be substituted in a future version. -

- For the purposes of equality, 2 NaN (not a number) values for floats and doubles are considered equal, eventhough 'NaN == NaN' would return false. This is analogous to java.lang.Double's equals method, and is in fact required to ensure that comparing an object to an exact copy of itself returns true for equality. -

- If there is any method named either hashCode or equals, regardless of return type, no methods will be generated, and a warning is emitted instead. These 2 methods need to be in sync with each other, which lombok cannot guarantee unless it generates all the methods, hence you always get a warning if one or both of the methods already exist. You can mark any method with @lombok.experimental.Tolerate to hide them from lombok. -

- Attempting to exclude fields that don't exist or would have been excluded anyway (because they are static or transient) results in warnings on the named fields. You therefore don't have to worry about typos. -

- Having both exclude and of generates a warning; the exclude parameter will be ignored in that case. -

- By default, any variables that start with a $ symbol are excluded automatically. You can onlyinclude them by using the 'of' parameter. -

- If a getter exists for a field to be included, it is called instead of using a direct field reference. This behaviour can be suppressed:
- @EqualsAndHashCode(doNotUseGetters = true) -

- - diff --git a/website2/templates/features/GetterLazy.html b/website2/templates/features/GetterLazy.html deleted file mode 100644 index b1f374a8..00000000 --- a/website2/templates/features/GetterLazy.html +++ /dev/null @@ -1,31 +0,0 @@ -<#import "_features.html" as f> - -<@f.scaffold title="@Getter(lazy=true)" logline="Laziness is a virtue!"> - <@f.history> - @Getter(lazy=true) was introduced in Lombok v0.10. - - - <@f.overview> -

- You can let lombok generate a getter which will calculate a value once, the first time this getter is called, and cache it from then on. This can be useful if calculating the value takes a lot of CPU, or the value takes a lot of memory. To use this feature, create a private final variable, initialize it with the expression that's expensive to run, and annotate your field with @Getter(lazy=true). The field will be hidden from the rest of your code, and the expression will be evaluated no more than once, when the getter is first called. There are no magic marker values (i.e. even if the result of your expensive calculation is null, the result is cached) and your expensive calculation need not be thread-safe, as lombok takes care of locking. -

- - - <@f.snippets name="GetterLazy" /> - - <@f.confKeys> -
- lombok.getter.lazy.flagUsage = [warning | error] (default: not set) -
- Lombok will flag any usage of @Getter(lazy=true) as a warning or error if configured. -
- - - <@f.smallPrint> -

- You should never refer to the field directly, always use the getter generated by lombok, because the type of the field will be mangled into an AtomicReference. Do not try to directly access this AtomicReference; if it points to itself, the value has been calculated, and it is null. If the reference points to null, then the value has not been calculated. This behaviour may change in future versions. Therefore, always use the generated getter to access your field! -

- Other Lombok annotations such as @ToString always call the getter even if you use doNotUseGetters=true. -

- - diff --git a/website2/templates/features/GetterSetter.html b/website2/templates/features/GetterSetter.html deleted file mode 100644 index 7ceaa3ba..00000000 --- a/website2/templates/features/GetterSetter.html +++ /dev/null @@ -1,70 +0,0 @@ -<#import "_features.html" as f> - -<@f.scaffold title="@Getter and @Setter" logline="Never write public int getFoo() {return foo;} again."> - <@f.overview> -

- You can annotate any field with @Getter and/or @Setter, to let lombok generate the default getter/setter automatically.
- A default getter simply returns the field, and is named getFoo if the field is called foo (or isFoo 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 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 class with the annotation. -

- You can always manually disable getter/setter generation for any field by using the special AccessLevel.NONE access level. This lets you override the behaviour of a @Getter, @Setter or @Data annotation on a class. -

- To put annotations on the generated method, you can use onMethod=@__({@AnnotationsHere}); to put annotations on the only parameter of a generated setter method, you can use onParam=@__({@AnnotationsHere}). Be careful though! This is an experimental feature. For more details see the documentation on the onX feature. -

- NEW in lombok v1.12.0: javadoc on the field will now be copied to generated getters and setters. Normally, all text is copied, and @return is moved to the getter, whilst @param lines are moved to the setter. Moved means: Deleted from the field's javadoc. It is also possible to define unique text for each getter/setter. To do that, you create a 'section' named GETTER and/or SETTER. A section is a line in your javadoc containing 2 or more dashes, then the text 'GETTER' or 'SETTER', followed by 2 or more dashes, and nothing else on the line. If you use sections, @return and @param stripping for that section is no longer done (move the @return or @param line into the section). -

- - - <@f.snippets name="GetterSetter" /> - - <@f.confKeys> -
- lombok.accessors.chain = [true | false] (default: false) -
- If set to true, generated setters will return this (instead of void). An explicitly configured chain parameter of an @Accessors annotation takes precedence over this setting. -
- lombok.accessors.fluent = [true | false] (default: false) -
- If set to true, generated getters and setters will not be prefixed with the bean-standard 'get, is or set; instead, the methods will use the same name as the field (minus prefixes). An explicitly configured chain parameter of an @Accessors annotation takes precedence over this setting. -
- lombok.accessors.prefix += a field prefix (default: empty list) -
- This is a list property; entries can be added with the += operator. Inherited prefixes from parent config files can be removed with the -= operator. Lombok will strip any matching field prefix from the name of a field in order to determine the name of the getter/setter to generate. For example, if m is one of the prefixes listed in this setting, then a field named mFoobar will result in a getter named getFoobar(), not getMFoobar(). An explicitly configured prefix parameter of an @Accessors annotation takes precedence over this setting. -
- lombok.getter.noIsPrefix = [true | false] (default: false) -
- If set to true, getters generated for boolean fields will use the get prefix instead of the defaultis prefix, and any generated code that calls getters, such as @ToString, will also use get instead of is -
- lombok.setter.flagUsage = [warning | error] (default: not set) -
- Lombok will flag any usage of @Setter as a warning or error if configured. -
- lombok.getter.flagUsage = [warning | error] (default: not set) -
- Lombok will flag any usage of @Getter as a warning or error if configured.