diff --git a/src/main/asciidoc/object-mapping.adoc b/src/main/asciidoc/object-mapping.adoc index a5a709035..629c98d5f 100644 --- a/src/main/asciidoc/object-mapping.adoc +++ b/src/main/asciidoc/object-mapping.adoc @@ -73,7 +73,7 @@ Unless already populated by the entity's constructor (i.e. consumed through its After that, all non-transient properties that have not already been populated by the constructor are set on the entity instance. For that we use the following algorithm: -1. If the property is immutable but exposes a wither method (see below), we use the wither to create a new entity instance with the new property value. +1. If the property is immutable but exposes a `with…` method (see below), we use the `with…` method to create a new entity instance with the new property value. 2. If property access (i.e. access through getters and setters) is defined, we're invoking the setter method. 3. By default, we set the field value directly. @@ -82,7 +82,7 @@ For that we use the following algorithm: **** Similarly to our <> we also use Spring Data runtime generated accessor classes to interact with the entity instance. -[source, java] +[source,java] ---- class Person { @@ -197,7 +197,7 @@ The same pattern is usually applied for other properties that are store managed <2> The `firstname` and `lastname` properties are ordinary immutable properties potentially exposed through getters. <3> The `age` property is an immutable but derived one from the `birthday` property. With the design shown, the database value will trump the defaulting as Spring Data uses the only declared constructor. -Even if the intent is that the calculation should be preferred, it's important that this constructor also takes `age` as parameter (to potentially ignore it) as otherwise the property population step will attempt to set the age field and fail due to it being immutable and no wither being present. +Even if the intent is that the calculation should be preferred, it's important that this constructor also takes `age` as parameter (to potentially ignore it) as otherwise the property population step will attempt to set the age field and fail due to it being immutable and no `with…` method being present. <4> The `comment` property is mutable is populated by setting its field directly. <5> The `remarks` properties are mutable and populated by setting the `comment` field directly or by invoking the setter method for <6> The class exposes a factory method and a constructor for object creation. @@ -214,7 +214,7 @@ Constructor-only materialization is up to 30% faster than properties population. * _Use factory methods instead of overloaded constructors to avoid ``@PersistenceConstructor``_ -- With an all-argument constructor needed for optimal performance, we usually want to expose more application use case specific constructors that omit things like auto-generated identifiers etc. It's an established pattern to rather use static factory methods to expose these variants of the all-args constructor. * _Make sure you adhere to the constraints that allow the generated instantiator and property accessor classes to be used_ -- -* _For identifiers to be generated, still use a final field in combination with a wither method_ -- +* _For identifiers to be generated, still use a final field in combination with a `with…` method_ -- * _Use Lombok to avoid boilerplate code_ -- As persistence operations usually require a constructor taking all arguments, their declaration becomes a tedious repetition of boilerplate parameter to field assignments that can best be avoided by using Lombok's `@AllArgsConstructor`. [[mapping.kotlin]] @@ -224,7 +224,8 @@ Spring Data adapts specifics of Kotlin to allow object creation and mutation. === Kotlin object creation -Kotlin classes are supported to be instantiated , all classes are immutable by default and require explicit property declarations to define mutable properties. Consider the following `data` class `Person`: +Kotlin classes are supported to be instantiated , all classes are immutable by default and require explicit property declarations to define mutable properties. +Consider the following `data` class `Person`: ==== [source,java] diff --git a/src/main/java/org/springframework/data/convert/DefaultConverterBuilder.java b/src/main/java/org/springframework/data/convert/DefaultConverterBuilder.java index 4b3c8f619..80c467d12 100644 --- a/src/main/java/org/springframework/data/convert/DefaultConverterBuilder.java +++ b/src/main/java/org/springframework/data/convert/DefaultConverterBuilder.java @@ -19,7 +19,7 @@ import lombok.AccessLevel; import lombok.EqualsAndHashCode; import lombok.NonNull; import lombok.RequiredArgsConstructor; -import lombok.experimental.Wither; +import lombok.With; import java.util.Collections; import java.util.Optional; @@ -44,12 +44,13 @@ import org.springframework.lang.Nullable; * factory methods on {@link ConverterBuilder} to create instances of this class. * * @author Oliver Gierke + * @author Mark Paluch * @since 2.0 * @see ConverterBuilder#writing(Class, Class, Function) * @see ConverterBuilder#reading(Class, Class, Function) * @soundtrack John Mayer - Still Feel Like Your Man (The Search for Everything) */ -@Wither(AccessLevel.PACKAGE) +@With(AccessLevel.PACKAGE) @RequiredArgsConstructor(access = AccessLevel.PACKAGE) class DefaultConverterBuilder implements ConverterAware, ReadingConverterBuilder, WritingConverterBuilder { diff --git a/src/main/java/org/springframework/data/domain/TypedExampleMatcher.java b/src/main/java/org/springframework/data/domain/TypedExampleMatcher.java index 2dedb50b1..52bfd5cd3 100644 --- a/src/main/java/org/springframework/data/domain/TypedExampleMatcher.java +++ b/src/main/java/org/springframework/data/domain/TypedExampleMatcher.java @@ -19,7 +19,7 @@ import lombok.AccessLevel; import lombok.EqualsAndHashCode; import lombok.RequiredArgsConstructor; import lombok.ToString; -import lombok.experimental.Wither; +import lombok.With; import java.util.Arrays; import java.util.Collections; @@ -32,6 +32,7 @@ import org.springframework.util.Assert; * Default implementation of {@link ExampleMatcher}. * * @author Christoph Strobl + * @author Mark Paluch * @since 2.0 */ @ToString @@ -44,7 +45,7 @@ class TypedExampleMatcher implements ExampleMatcher { private final PropertySpecifiers propertySpecifiers; private final Set ignoredPaths; private final boolean defaultIgnoreCase; - private final @Wither(AccessLevel.PACKAGE) MatchMode mode; + private final @With(AccessLevel.PACKAGE) MatchMode mode; TypedExampleMatcher() { diff --git a/src/main/java/org/springframework/data/mapping/PersistentProperty.java b/src/main/java/org/springframework/data/mapping/PersistentProperty.java index 8ccd6c29b..9051d6cb4 100644 --- a/src/main/java/org/springframework/data/mapping/PersistentProperty.java +++ b/src/main/java/org/springframework/data/mapping/PersistentProperty.java @@ -114,11 +114,11 @@ public interface PersistentProperty

> { } /** - * Returns the wither {@link Method} to set a property value on a new object instance. Might return {@literal null} in - * case there is no wither available. + * Returns the with {@link Method} to set a property value on a new object instance. Might return {@literal null} in + * case there is no with available. *

- * Wither {@link Method methods} are property-bound instance {@link Method methods} that accept a single argument of - * the property type creating a new object instance. + * With {@link Method methods} are property-bound instance {@link Method methods} that accept a single argument of the + * property type creating a new object instance. * * 

 	 * class Person {
@@ -133,7 +133,7 @@ public interface PersistentProperty
> {
 	 * }
 	 *
* - * @return the wither {@link Method} to set a property value on a new object instance if available, otherwise + * @return the with {@link Method} to set a property value on a new object instance if available, otherwise * {@literal null}. * @since 2.1 */ diff --git a/src/test/java/org/springframework/data/mapping/PersistentPropertyAccessorUnitTests.java b/src/test/java/org/springframework/data/mapping/PersistentPropertyAccessorUnitTests.java index 91aead75a..63c0679c2 100644 --- a/src/test/java/org/springframework/data/mapping/PersistentPropertyAccessorUnitTests.java +++ b/src/test/java/org/springframework/data/mapping/PersistentPropertyAccessorUnitTests.java @@ -22,7 +22,7 @@ import lombok.AllArgsConstructor; import lombok.Builder; import lombok.Data; import lombok.Value; -import lombok.experimental.Wither; +import lombok.With; import java.util.Collection; import java.util.Collections; @@ -41,6 +41,7 @@ import org.springframework.data.mapping.model.ConvertingPropertyAccessor; /** * @author Oliver Gierke + * @author Mark Paluch */ public class PersistentPropertyAccessorUnitTests { @@ -204,13 +205,13 @@ public class PersistentPropertyAccessorUnitTests { // DATACMNS-1322 @Value - @Wither(AccessLevel.PACKAGE) + @With(AccessLevel.PACKAGE) static class NestedImmutable { String value; } @Value - @Wither(AccessLevel.PACKAGE) + @With(AccessLevel.PACKAGE) static class Outer { NestedImmutable immutable; } diff --git a/src/test/java/org/springframework/data/mapping/model/PersistentPropertyAccessorTests.java b/src/test/java/org/springframework/data/mapping/model/PersistentPropertyAccessorTests.java index b030dd78b..bff872190 100644 --- a/src/test/java/org/springframework/data/mapping/model/PersistentPropertyAccessorTests.java +++ b/src/test/java/org/springframework/data/mapping/model/PersistentPropertyAccessorTests.java @@ -19,7 +19,7 @@ import static org.assertj.core.api.Assertions.*; import lombok.Data; import lombok.Value; -import lombok.experimental.Wither; +import lombok.With; import java.sql.Timestamp; import java.util.ArrayList; @@ -217,7 +217,7 @@ public class PersistentPropertyAccessorTests { @Value static class ValueClass { - @Wither String id; + @With String id; String immutable; } diff --git a/src/test/java/org/springframework/data/mapping/model/PropertyUnitTests.java b/src/test/java/org/springframework/data/mapping/model/PropertyUnitTests.java index 1bed89f7b..99e6b445b 100644 --- a/src/test/java/org/springframework/data/mapping/model/PropertyUnitTests.java +++ b/src/test/java/org/springframework/data/mapping/model/PropertyUnitTests.java @@ -18,7 +18,7 @@ package org.springframework.data.mapping.model; import static org.assertj.core.api.Assertions.*; import lombok.Value; -import lombok.experimental.Wither; +import lombok.With; import org.junit.Test; import org.springframework.data.util.ClassTypeInformation; @@ -96,7 +96,7 @@ public class PropertyUnitTests { } @Value - @Wither + @With static class WitherType { String id;