spring-projects#282 - Changes in JavaDocs

Author: rchigvintsev

Diff for: src/main/java/org/springframework/data/r2dbc/repository/query/ConditionFactory.java

@@ -36,13 +36,15 @@ class ConditionFactory {
     private final ParameterMetadataProvider parameterMetadataProvider;
 
     /**
-     * Creates new instance of this class with the given {@link MappingContext} and {@link ParameterMetadataProvider}.
+     * Creates new instance of this class with the given {@link MappingContext}, {@link RenderNamingStrategy} and
+     * {@link ParameterMetadataProvider}.
      *
      * @param mappingContext            mapping context (must not be {@literal null})
      * @param namingStrategy            naming strategy for SQL rendering (must not be {@literal null})
      * @param parameterMetadataProvider parameter metadata provider (must not be {@literal null})
      */
-    ConditionFactory(MappingContext<? extends RelationalPersistentEntity<?>, ? extends RelationalPersistentProperty> mappingContext,
+    ConditionFactory(MappingContext<? extends RelationalPersistentEntity<?>, ? extends RelationalPersistentProperty>
+                             mappingContext,
                      RenderNamingStrategy namingStrategy,
                      ParameterMetadataProvider parameterMetadataProvider) {
         Assert.notNull(mappingContext, "Mapping context must not be null");
@@ -59,6 +61,7 @@ class ConditionFactory {
      *
      * @param part method name part (must not be {@literal null})
      * @return {@link Condition} instance
+     * @throws IllegalArgumentException if part type is not supported
      */
     public Condition createCondition(Part part) {
         Part.Type type = part.getType();
@@ -215,6 +218,8 @@ private boolean canUpperCase(Class<?> expressionType) {
     // TODO: include support of functions in WHERE conditions into spring-data-relational
     /**
      * Models the ANSI SQL {@code UPPER} function.
+     * <p>
+     * Results in a rendered function: {@code UPPER(<expression>)}.
      */
     private class Upper implements Expression {
         private Literal<Object> delegate;

Diff for: src/main/java/org/springframework/data/r2dbc/repository/query/ParameterMetadataProvider.java

@@ -44,7 +44,7 @@ class ParameterMetadataProvider {
     private final LikeEscaper likeEscaper;
 
     /**
-     * Creates new instance of this class with the given {@link RelationalParameterAccessor}.
+     * Creates new instance of this class with the given {@link RelationalParameterAccessor} and {@link LikeEscaper}.
      *
      * @param accessor relational parameter accessor (must not be {@literal null}).
      * @param likeEscaper escaper for LIKE operator parameters (must not be {@literal null})
@@ -54,7 +54,7 @@ class ParameterMetadataProvider {
     }
 
     /**
-     * Creates new instance of this class with the given {@link Parameters}.
+     * Creates new instance of this class with the given {@link Parameters} and {@link LikeEscaper}.
      *
      * @param parameters  method parameters (must not be {@literal null})
      * @param likeEscaper escaper for LIKE operator parameters (must not be {@literal null})
@@ -64,8 +64,8 @@ class ParameterMetadataProvider {
     }
 
     /**
-     * Creates new instance of this class with the given {@link Parameters} and {@link Iterator} over all bindable
-     * parameter values.
+     * Creates new instance of this class with the given {@link Parameters}, {@link Iterator} over all bindable
+     * parameter values and {@link LikeEscaper}.
      *
      * @param bindableParameterValueIterator iterator over bindable parameter values
      * @param parameters                     method parameters (must not be {@literal null})

Diff for: src/main/java/org/springframework/data/r2dbc/repository/query/PartTreeR2dbcQuery.java

@@ -45,7 +45,8 @@ public class PartTreeR2dbcQuery extends AbstractR2dbcQuery {
     private LikeEscaper likeEscaper = LikeEscaper.DEFAULT;
 
     /**
-     * Creates new instance of this class with the given {@link R2dbcQueryMethod} and {@link DatabaseClient}.
+     * Creates new instance of this class with the given {@link R2dbcQueryMethod}, {@link DatabaseClient},
+     * {@link R2dbcConverter} and {@link ReactiveDataAccessStrategy}.
      *
      * @param method             query method (must not be {@literal null})
      * @param databaseClient     database client (must not be {@literal null})
@@ -69,6 +70,12 @@ public PartTreeR2dbcQuery(R2dbcQueryMethod method,
         }
     }
 
+    /**
+     * Creates new {@link BindableQuery} for the given {@link RelationalParameterAccessor}.
+     *
+     * @param accessor query parameter accessor (must not be {@literal null})
+     * @return new instance of {@link BindableQuery}
+     */
     @Override
     protected BindableQuery createQuery(RelationalParameterAccessor accessor) {
         RelationalEntityMetadata<?> entityMetadata = getQueryMethod().getEntityInformation();

Diff for: src/main/java/org/springframework/data/r2dbc/repository/query/R2dbcQueryCreator.java

@@ -36,7 +36,7 @@
 import java.util.stream.Collectors;
 
 /**
- * Implementation of {@link AbstractQueryCreator} that creates {@link BindableQuery} from a {@link PartTree}.
+ * Implementation of {@link AbstractQueryCreator} that creates SQL query from a {@link PartTree}.
  *
  * @author Roman Chigvintsev
  */
@@ -77,27 +77,49 @@ public R2dbcQueryCreator(PartTree tree,
                 namingStrategy, parameterMetadataProvider);
     }
 
+    /**
+     * Creates {@link Condition} for the given method name part.
+     *
+     * @param part method name part (must not be {@literal null})
+     * @param iterator iterator over query parameter values
+     * @return new instance of {@link Condition}
+     */
     @Override
     protected Condition create(Part part, Iterator<Object> iterator) {
         return conditionFactory.createCondition(part);
     }
 
+    /**
+     * Combines the given {@link Condition} with the new one created for the given method name part using {@code AND}.
+     *
+     * @param part method name part (must not be {@literal null})
+     * @param base condition to be combined (must not be {@literal null})
+     * @param iterator iterator over query parameter values
+     * @return condition combination
+     */
     @Override
     protected Condition and(Part part, Condition base, Iterator<Object> iterator) {
         return base.and(conditionFactory.createCondition(part));
     }
 
+    /**
+     * Combines two {@link Condition}s using {@code OR}.
+     *
+     * @param base condition to be combined (must not be {@literal null})
+     * @param condition another condition to be combined (must not be {@literal null})
+     * @return condition combination
+     */
     @Override
     protected Condition or(Condition base, Condition condition) {
         return base.or(condition);
     }
 
     /**
-     * Creates {@link BindableQuery} applying the given {@link Condition} and {@link Sort} definition.
+     * Creates SQL query applying the given {@link Condition} and {@link Sort} definition.
      *
      * @param condition condition to be applied to query
      * @param sort      sort option to be applied to query (must not be {@literal null})
-     * @return new instance of {@link BindableQuery}
+     * @return SQL query
      */
     @Override
     protected String complete(Condition condition, Sort sort) {