From 211d1440a26eebe407ae044eca4f7318232299b8 Mon Sep 17 00:00:00 2001 From: Mark Paluch Date: Tue, 20 Apr 2021 16:01:53 +0200 Subject: [PATCH] Polishing. Tweak Javadoc. Closes #614. --- .../unwrapping/ApplicationConfiguration.java | 6 +++--- .../springdata/mongodb/unwrapping/Email.java | 2 ++ .../springdata/mongodb/unwrapping/UserName.java | 2 ++ .../mongodb/unwrapping/UserRepository.java | 6 ++---- .../unwrapping/UnwrappingIntegrationTests.java | 13 +++++++------ 5 files changed, 16 insertions(+), 13 deletions(-) diff --git a/mongodb/example/src/main/java/example/springdata/mongodb/unwrapping/ApplicationConfiguration.java b/mongodb/example/src/main/java/example/springdata/mongodb/unwrapping/ApplicationConfiguration.java index ff004cfe..13be1e60 100644 --- a/mongodb/example/src/main/java/example/springdata/mongodb/unwrapping/ApplicationConfiguration.java +++ b/mongodb/example/src/main/java/example/springdata/mongodb/unwrapping/ApplicationConfiguration.java @@ -18,9 +18,9 @@ package example.springdata.mongodb.unwrapping; import org.springframework.boot.autoconfigure.SpringBootApplication; /** + * Simple Spring Boot application. + * * @author Christoph Strobl */ @SpringBootApplication -public class ApplicationConfiguration { - -} +public class ApplicationConfiguration {} diff --git a/mongodb/example/src/main/java/example/springdata/mongodb/unwrapping/Email.java b/mongodb/example/src/main/java/example/springdata/mongodb/unwrapping/Email.java index 548fc6f7..0b19fda7 100644 --- a/mongodb/example/src/main/java/example/springdata/mongodb/unwrapping/Email.java +++ b/mongodb/example/src/main/java/example/springdata/mongodb/unwrapping/Email.java @@ -18,6 +18,8 @@ package example.springdata.mongodb.unwrapping; import java.util.Objects; /** + * Value object capturing the {@code email} address. + * * @author Christoph Strobl */ public class Email { // might as well be a record type in more recent java versions diff --git a/mongodb/example/src/main/java/example/springdata/mongodb/unwrapping/UserName.java b/mongodb/example/src/main/java/example/springdata/mongodb/unwrapping/UserName.java index 8ea20911..0f90c25d 100644 --- a/mongodb/example/src/main/java/example/springdata/mongodb/unwrapping/UserName.java +++ b/mongodb/example/src/main/java/example/springdata/mongodb/unwrapping/UserName.java @@ -18,6 +18,8 @@ package example.springdata.mongodb.unwrapping; import java.util.Objects; /** + * Value object capturing the {@code username}. + * * @author Christoph Strobl */ public class UserName { // might as well be a record type in more recent java versions diff --git a/mongodb/example/src/main/java/example/springdata/mongodb/unwrapping/UserRepository.java b/mongodb/example/src/main/java/example/springdata/mongodb/unwrapping/UserRepository.java index 992be590..2e8320a0 100644 --- a/mongodb/example/src/main/java/example/springdata/mongodb/unwrapping/UserRepository.java +++ b/mongodb/example/src/main/java/example/springdata/mongodb/unwrapping/UserRepository.java @@ -23,14 +23,12 @@ import org.springframework.data.repository.CrudRepository; public interface UserRepository extends CrudRepository { /** - * Use the value type directly. - * This will unwrap the values into the target query object. + * Use the value type directly. This will unwrap the values into the target query object. */ User findByUserName(UserName userName); /** - * Use one of the unwrapped properties. - * This will drill into the unwrapped using the value for the target query. + * Use one of the unwrapped properties. This will drill into the unwrapped using the value for the target query. */ User findByEmailEmail(String email); } diff --git a/mongodb/example/src/test/java/example/springdata/mongodb/unwrapping/UnwrappingIntegrationTests.java b/mongodb/example/src/test/java/example/springdata/mongodb/unwrapping/UnwrappingIntegrationTests.java index ec924366..27b32035 100644 --- a/mongodb/example/src/test/java/example/springdata/mongodb/unwrapping/UnwrappingIntegrationTests.java +++ b/mongodb/example/src/test/java/example/springdata/mongodb/unwrapping/UnwrappingIntegrationTests.java @@ -19,21 +19,22 @@ import static org.assertj.core.api.Assertions.*; import java.util.Arrays; -import com.mongodb.client.model.Filters; import org.bson.Document; import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Test; -import org.junit.jupiter.api.extension.ExtendWith; + import org.springframework.beans.factory.annotation.Autowired; -import org.springframework.boot.test.context.SpringBootTest; +import org.springframework.boot.test.autoconfigure.data.mongo.DataMongoTest; import org.springframework.data.mongodb.core.MongoOperations; -import org.springframework.test.context.junit.jupiter.SpringExtension; + +import com.mongodb.client.model.Filters; /** + * Integration tests showing unwrapped/embedded document usage. + * * @author Christoph Strobl */ -@SpringBootTest -@ExtendWith(SpringExtension.class) +@DataMongoTest class UnwrappingIntegrationTests { @Autowired UserRepository repository;