diff --git a/pom.xml b/pom.xml index d93ffb6d5..38f55f10f 100644 --- a/pom.xml +++ b/pom.xml @@ -80,7 +80,7 @@ spring-data-neo4j SDNEO4J 1.2.1 - 0.8.5 + 0.8.6 spring.data.neo4j 1.8 2.3.1 @@ -118,7 +118,7 @@ ${skipTests} 2.4.1-SNAPSHOT - ../../../../../spring-data-commons/src/main/asciidoc + ../../../../spring-data-commons/src/main/asciidoc @@ -501,6 +501,19 @@ true + + org.apache.maven.plugins + maven-javadoc-plugin + + + + soundtrack + X + Soundtrack + + + + org.jacoco jacoco-maven-plugin diff --git a/src/main/asciidoc/faq/faq.adoc b/src/main/asciidoc/faq/faq.adoc index bd4c90cfe..54acb5fbd 100644 --- a/src/main/asciidoc/faq/faq.adoc +++ b/src/main/asciidoc/faq/faq.adoc @@ -166,7 +166,7 @@ If this is not feasible for any reason, you can either add == How do I use Spring Expression Language in custom queries? -https://docs.spring.io/spring/docs/current/spring-framework-reference/core.html#expressions[Spring Expression Language (SpEL)] can be used in custom queries inside `:#{}`. +{spring-framework-ref}/core.html#expressions[Spring Expression Language (SpEL)] can be used in custom queries inside `:#{}`. This is the standard Spring Data way of defining a block of text inside a query that undergoes SpEL evaluation. The following example basically defines the same query as above, but uses a `WHERE` clause to avoid even more curly braces: diff --git a/src/main/asciidoc/index.adoc b/src/main/asciidoc/index.adoc index 904b5896e..dce9b2310 100644 --- a/src/main/asciidoc/index.adoc +++ b/src/main/asciidoc/index.adoc @@ -21,10 +21,8 @@ include::{manualIncludeDir}/README.adoc[tags=properties] :gh-base: https://github.com/spring-projects/spring-data-neo4j :java-driver-starter-href: https://github.com/neo4j/neo4j-java-driver-spring-boot-starter -:springVersion: 5.3.0-RC1 -:spring-framework-docs: https://docs.spring.io/spring/docs/{springVersion}/spring-framework-reference -:spring-framework-javadoc: https://docs.spring.io/spring/docs/{springVersion}/javadoc-api -:spring-data-commons-docs: ../../../../../spring-data-commons/src/main/asciidoc +:spring-framework-ref: https://docs.spring.io/spring/docs/{springVersion}/reference/html +:spring-data-commons-docs: ../../../../spring-data-commons/src/main/asciidoc (C) 2008-2020 The original authors. diff --git a/src/main/asciidoc/introduction-and-preface/building-blocks.adoc b/src/main/asciidoc/introduction-and-preface/building-blocks.adoc index a67ebb104..a9b4b5774 100644 --- a/src/main/asciidoc/introduction-and-preface/building-blocks.adoc +++ b/src/main/asciidoc/introduction-and-preface/building-blocks.adoc @@ -83,34 +83,34 @@ You will find it's documentation in the <>. |`org.springframework.data.neo4j.config` | -include::../../../main/java/org/springframework/data/neo4j/config/package-info.java[tags=intent,indent=0] +include::../../../../src/main/java/org/springframework/data/neo4j/config/package-info.java[tags=intent,indent=0] |`org.springframework.data.neo4j.core` | -include::../../../main/java/org/springframework/data/neo4j/core/package-info.java[tags=intent,indent=0] +include::../../../../src/main/java/org/springframework/data/neo4j/core/package-info.java[tags=intent,indent=0] |`org.springframework.data.neo4j.core.convert` | -include::../../../main/java/org/springframework/data/neo4j/core/convert/package-info.java[tags=intent,indent=] +include::../../../../src/main/java/org/springframework/data/neo4j/core/convert/package-info.java[tags=intent,indent=] |`org.springframework.data.neo4j.core.support` | -include::../../../main/java/org/springframework/data/neo4j/core/support/package-info.java[tags=intent,indent=] +include::../../../../src/main/java/org/springframework/data/neo4j/core/support/package-info.java[tags=intent,indent=] |`org.springframework.data.neo4j.core.transaction` | -include::../../../main/java/org/springframework/data/neo4j/core/transaction/package-info.java[tags=intent,indent=] +include::../../../../src/main/java/org/springframework/data/neo4j/core/transaction/package-info.java[tags=intent,indent=] |`org.springframework.data.neo4j.repository` | -include::../../../main/java/org/springframework/data/neo4j/repository/package-info.java[tags=intent,indent=0] +include::../../../../src/main/java/org/springframework/data/neo4j/repository/package-info.java[tags=intent,indent=0] |`org.springframework.data.neo4j.repository.config` | -include::../../../main/java/org/springframework/data/neo4j/repository/config/package-info.java[tags=intent,indent=0] +include::../../../../src/main/java/org/springframework/data/neo4j/repository/config/package-info.java[tags=intent,indent=0] |`org.springframework.data.neo4j.repository.support` | -include::../../../main/java/org/springframework/data/neo4j/repository/support/package-info.java[tags=intent,indent=0] +include::../../../../src/main/java/org/springframework/data/neo4j/repository/support/package-info.java[tags=intent,indent=0] |=== diff --git a/src/main/asciidoc/introduction-and-preface/preface.adoc b/src/main/asciidoc/introduction-and-preface/preface.adoc index 24c468ca2..cc22a85e9 100644 --- a/src/main/asciidoc/introduction-and-preface/preface.adoc +++ b/src/main/asciidoc/introduction-and-preface/preface.adoc @@ -31,10 +31,10 @@ Here is a list of useful resources: [[preface.spring-data]] == Spring and Spring Data -Spring Data uses Spring Framework's https://docs.spring.io/spring/docs/{springVersion}/spring-framework-reference/core.html[core] functionality, such as the https://docs.spring.io/spring/docs/{springVersion}/spring-framework-reference/core.html#beans[IoC] container, -https://docs.spring.io/spring/docs/{springVersion}/spring-framework-reference/core.html#core-convert[type conversion system], -https://docs.spring.io/spring/docs/{springVersion}/spring-framework-reference/core.html#expressions[expression language], -https://docs.spring.io/spring/docs/{springVersion}/spring-framework-reference/integration.html#jmx[JMX integration], and portable https://docs.spring.io/spring/docs/{springVersion}/spring-framework-reference/data-access.html#dao-exceptions[DAO exception hierarchy]. +Spring Data uses Spring Framework's {spring-framework-ref}/core.html[core] functionality, such as the {spring-framework-ref}/core.html#beans[IoC] container, +{spring-framework-ref}/core.html#core-convert[type conversion system], +{spring-framework-ref}/core.html#expressions[expression language], +{spring-framework-ref}/integration.html#jmx[JMX integration], and portable {spring-framework-ref}/data-access.html#dao-exceptions[DAO exception hierarchy]. While it is not necessary to know all the Spring APIs, understanding the concepts behind them is. At a minimum, the idea behind IoC should be familiar. diff --git a/src/main/java/org/springframework/data/neo4j/config/EnableNeo4jAuditing.java b/src/main/java/org/springframework/data/neo4j/config/EnableNeo4jAuditing.java index cd0bfc2f7..93ecf4ad6 100644 --- a/src/main/java/org/springframework/data/neo4j/config/EnableNeo4jAuditing.java +++ b/src/main/java/org/springframework/data/neo4j/config/EnableNeo4jAuditing.java @@ -43,21 +43,21 @@ public @interface EnableNeo4jAuditing { /** * Configures the {@link AuditorAware} bean to be used to lookup the current principal. * - * @return + * @return The name of the {@link AuditorAware} bean to be used to lookup the current principal. */ String auditorAwareRef() default ""; /** * Configures whether the creation and modification dates are set. Defaults to {@literal true}. * - * @return + * @return whether to set the creation and modification dates. */ boolean setDates() default true; /** * Configures whether the entity shall be marked as modified on creation. Defaults to {@literal true}. * - * @return + * @return whether to mark the entity as modified on creation. */ boolean modifyOnCreate() default true; @@ -65,7 +65,7 @@ public @interface EnableNeo4jAuditing { * Configures a {@link DateTimeProvider} bean name that allows customizing actual date time class to be used for * setting creation and modification dates. * - * @return + * @return The name of the {@link DateTimeProvider} bean to provide the current date time for creation and modification dates. */ String dateTimeProviderRef() default ""; } diff --git a/src/main/java/org/springframework/data/neo4j/config/EnableReactiveNeo4jAuditing.java b/src/main/java/org/springframework/data/neo4j/config/EnableReactiveNeo4jAuditing.java index 309233876..86eb84ee9 100644 --- a/src/main/java/org/springframework/data/neo4j/config/EnableReactiveNeo4jAuditing.java +++ b/src/main/java/org/springframework/data/neo4j/config/EnableReactiveNeo4jAuditing.java @@ -43,21 +43,21 @@ public @interface EnableReactiveNeo4jAuditing { /** * Configures the {@link AuditorAware} bean to be used to lookup the current principal. * - * @return + * @return The name of the {@link AuditorAware} bean to be used to lookup the current principal. */ String auditorAwareRef() default ""; /** * Configures whether the creation and modification dates are set. Defaults to {@literal true}. * - * @return + * @return whether to set the creation and modification dates. */ boolean setDates() default true; /** * Configures whether the entity shall be marked as modified on creation. Defaults to {@literal true}. * - * @return + * @return whether to mark the entity as modified on creation. */ boolean modifyOnCreate() default true; @@ -65,7 +65,7 @@ public @interface EnableReactiveNeo4jAuditing { * Configures a {@link DateTimeProvider} bean name that allows customizing actual date time class to be used for * setting creation and modification dates. * - * @return + * @return The name of the {@link DateTimeProvider} bean to provide the current date time for creation and modification dates. */ String dateTimeProviderRef() default ""; } diff --git a/src/main/java/org/springframework/data/neo4j/core/convert/Neo4jPersistentPropertyConverter.java b/src/main/java/org/springframework/data/neo4j/core/convert/Neo4jPersistentPropertyConverter.java index dc3705b14..d90c8287d 100644 --- a/src/main/java/org/springframework/data/neo4j/core/convert/Neo4jPersistentPropertyConverter.java +++ b/src/main/java/org/springframework/data/neo4j/core/convert/Neo4jPersistentPropertyConverter.java @@ -31,13 +31,13 @@ public interface Neo4jPersistentPropertyConverter { /** * @param source The value to store, never null. - * @return + * @return The converted value, never null. */ Value write(T source); /** * @param source The value to read, never null or {@link org.neo4j.driver.Values#NULL} - * @return + * @return The converted value, maybe null if {@code source} was equals to {@link org.neo4j.driver.Values#NULL}. */ T read(Value source); } diff --git a/src/main/java/org/springframework/data/neo4j/repository/query/CypherAdapterUtils.java b/src/main/java/org/springframework/data/neo4j/repository/query/CypherAdapterUtils.java index 4a0cc3329..67eea0334 100644 --- a/src/main/java/org/springframework/data/neo4j/repository/query/CypherAdapterUtils.java +++ b/src/main/java/org/springframework/data/neo4j/repository/query/CypherAdapterUtils.java @@ -39,7 +39,7 @@ import org.springframework.data.neo4j.core.mapping.NodeDescription; public final class CypherAdapterUtils { /** - * Maps Spring Datas {@link Sort.Order} to a {@link SortItem}. See {@link #toSortItems(NodeDescription, Sort)}. + * Maps Spring Datas {@link org.springframework.data.domain.Sort.Order} to a {@link SortItem}. See {@link #toSortItems(NodeDescription, Sort)}. * * @param nodeDescription {@link NodeDescription} to get properties for sorting from. * @return A stream if sort items. Will be empty when sort is unsorted. diff --git a/src/main/java/org/springframework/data/neo4j/repository/support/ReactivePersistenceExceptionTranslationPostProcessor.java b/src/main/java/org/springframework/data/neo4j/repository/support/ReactivePersistenceExceptionTranslationPostProcessor.java index 4c216401b..276d54421 100644 --- a/src/main/java/org/springframework/data/neo4j/repository/support/ReactivePersistenceExceptionTranslationPostProcessor.java +++ b/src/main/java/org/springframework/data/neo4j/repository/support/ReactivePersistenceExceptionTranslationPostProcessor.java @@ -40,7 +40,7 @@ import org.springframework.util.Assert; * Bean post-processor that automatically applies persistence exception translation to all methods returning either * {@link reactor.core.publisher.Mono} or {@link reactor.core.publisher.Flux} of any bean marked with * Spring's @{@link Repository Repository} annotation, adding a corresponding - * {@link ReactivePersistenceExceptionTranslationAdvisor} to the exposed proxy (either an existing AOP proxy or a newly + * {@link AbstractPointcutAdvisor} to the exposed proxy (either an existing AOP proxy or a newly * generated proxy that implements all of the target's interfaces). *

* That proxy will modify the reactive types by the matched method and inject an exception translation into the reactive