Proofreading (#2819)

Author: altro3

ISSUE_TEMPLATE.md

@@ -7,7 +7,7 @@ NOTE: If you are unsure about something and the issue is more of a question a be
 
 - [ ] Steps to reproduce provided
 - [ ] Stacktrace (if present) provided
-- [ ] Example that reproduces the problem uploaded to Github
+- [ ] Example that reproduces the problem uploaded to GitHub
 - [ ] Full description of the issue provided (see below)
 
 ### Steps to Reproduce
@@ -32,5 +32,5 @@ Tell us what happens instead
 
 ### Example Application
 
-- TODO: link to github repository with example that reproduces the issue
+- TODO: link to GitHub repository with example that reproduces the issue
 

README.md

@@ -9,7 +9,7 @@ Micronaut Data is a database access toolkit that uses Ahead of Time (AoT) compil
 
 Micronaut Data is inspired by [GORM](https://gorm.grails.org) and [Spring Data](https://spring.io/projects/spring-data), however improves on those solutions in the following ways:
 
-* *Compilation Time model* - Both GORM and Spring Data maintain a runtime meta-model that uses reflection to model relationships between entities. This model consumes significant memory and memory requirements grow as your application size grows. The problem is worse when combined with Hibernate which maintains its own meta-model as you end up with duplicate meta-models. Micronaut Data instead moves this model into the compiler.
+* *Compilation Time model* - Both GORM and Spring Data maintain a runtime metamodel that uses reflection to model relationships between entities. This model consumes significant memory and memory requirements grow as your application size grows. The problem is worse when combined with Hibernate which maintains its own metamodel as you end up with duplicate metamodels. Micronaut Data instead moves this model into the compiler.
 * *No query translation* - Both GORM and Spring Data use regular expressions and pattern matching in combination with runtime generated proxies to translate a method definition on a Java interface into a query at runtime. No such runtime translation exists in Micronaut Data and this work is carried out by the Micronaut compiler at compilation time.
 * *No Reflection or Runtime Proxies* - Micronaut Data uses no reflection or runtime proxies, resulting in better performance, smaller stack traces and reduced memory consumption due to a complete lack of reflection caches (Note that the backing implementation, for example Hibernate, may use reflection).
 * *Type Safety* - Micronaut Data will actively check at compile time that a repository method can be implemented and fail compilation if it cannot.
@@ -30,28 +30,28 @@ Or for Micronaut Data JDBC:
 ```bash
 $ curl https://launch.micronaut.io/demo.zip?features=data-jdbc -o demo.zip
 $ unzip demo.zip -d demo
-```  
+```
 
-Note that you can append `&build=maven` to the URL to switch to a Maven build. 
+Note that you can append `&build=maven` to the URL to switch to a Maven build.
 
 
 ## Documentation
 
-See the [Documentation](https://micronaut-projects.github.io/micronaut-data/latest/guide/) for more information. 
+See the [Documentation](https://micronaut-projects.github.io/micronaut-data/latest/guide/) for more information.
 
 See the [Snapshot Documentation](https://micronaut-projects.github.io/micronaut-data/snapshot/guide/) for the current development docs.
 
 ## Snapshots and Releases
 
-Snaphots are automatically published to [JFrog OSS](https://oss.jfrog.org/artifactory/oss-snapshot-local/) using [Github Actions](https://github.com/micronaut-projects/micronaut-data/actions).
+Snaphots are automatically published to [JFrog OSS](https://oss.jfrog.org/artifactory/oss-snapshot-local/) using [GitHub Actions](https://github.com/micronaut-projects/micronaut-data/actions).
 
 See the documentation in the [Micronaut Docs](https://docs.micronaut.io/latest/guide/index.html#usingsnapshots) for how to configure your build to use snapshots.
 
-Releases are published to Maven Central via [Github Actions](https://github.com/micronaut-projects/micronaut-data/actions).
+Releases are published to Maven Central via [GitHub Actions](https://github.com/micronaut-projects/micronaut-data/actions).
 
 A release is performed with the following steps:
 
 * [Edit the version](https://github.com/micronaut-projects/micronaut-data/edit/master/gradle.properties) specified by `projectVersion` in `gradle.properties` to a semantic, unreleased version. Example `1.0.0`
 * [Create a new release](https://github.com/micronaut-projects/micronaut-data/releases/new). The Git Tag should start with `v`. For example `v1.0.0`.
 * [Monitor the Workflow](https://github.com/micronaut-projects/micronaut-data/actions?query=workflow%3ARelease) to check it passed successfully.
-* Celebrate!
+* Celebrate!

data-connection-jdbc/src/main/java/io/micronaut/data/connection/jdbc/advice/ContextualConnectionInterceptor.java

@@ -30,7 +30,7 @@
 import java.sql.Connection;
 
 /**
- * An interceptor that allows injecting a {@link Connection} that acts a proxy to lookup the connection for the current transaction.
+ * An interceptor that allows injecting a {@link Connection} that acts a proxy to look up the connection for the current transaction.
  *
  * @author graemerocher
  * @since 1.0

data-jdbc/src/main/java/io/micronaut/data/jdbc/operations/JdbcSchemaHandler.java

@@ -39,7 +39,7 @@ public interface JdbcSchemaHandler {
     void createSchema(Connection connection, Dialect dialect, String name);
 
     /**
-     * Uses the given schema..
+     * Uses the given schema.
      *
      * @param connection The JDBC connection
      * @param dialect The dialect

data-model/src/main/java/io/micronaut/data/annotation/DataTransformer.java

@@ -24,7 +24,7 @@
 
 /**
  * Generic version of allowing transformations to be applied when reading or writing
- * data to and from the a database. Inspired by Hibernate's <code>ColumnTransformer</code> concept.
+ * data to and from the database. Inspired by Hibernate's <code>ColumnTransformer</code> concept.
  *
  * @author graemerocher
  * @since 1.0

data-model/src/main/java/io/micronaut/data/annotation/Id.java

@@ -18,7 +18,7 @@
 import java.lang.annotation.*;
 
 /**
- * Designates a field or method that is annotated with the Id of an entity. Typically not used
+ * Designates a field or method that is annotated with the ID of an entity. Typically not used
  * directly but instead mapped to via annotation such as {@code javax.persistence.Id}.
  *
  * @author graemerocher

data-model/src/main/java/io/micronaut/data/annotation/Index.java

@@ -25,7 +25,7 @@
 import java.lang.annotation.Target;
 
 /**
- * Designates one of the indexes part of the indexes member within an Table annotation. Typically not used
+ * Designates one of the indexes part of the indexes member within a Table annotation. Typically not used
  * directly but instead mapped to via annotation such as {@code javax.persistence.Index}.
  *
  * @author Davide Pugliese

data-model/src/main/java/io/micronaut/data/annotation/Query.java

@@ -18,7 +18,7 @@
 import java.lang.annotation.*;
 
 /**
- * Defines the query string such as SQL, JPA-QL, Cypher etc that should be executed.
+ * Defines the query string such as SQL, JPA-QL, Cypher etc. that should be executed.
  *
  * @author graemerocher
  * @since 1.0

data-model/src/main/java/io/micronaut/data/annotation/Relation.java

@@ -71,24 +71,23 @@ enum Cascade {
      */
     enum Kind {
         /**
-         * One to many association.
+         * One-To-Many association.
          */
         ONE_TO_MANY(false),
         /**
-         * One to one association.
+         * One-to-one association.
          */
         ONE_TO_ONE(true),
         /**
-         * Many to many association.
+         * Many-To-Many association.
          */
         MANY_TO_MANY(false),
         /**
          * Embedded association.
          */
         EMBEDDED(true),
-
         /**
-         * Many to one association.
+         * Many-To-One association.
          */
         MANY_TO_ONE(true);
 

data-model/src/main/java/io/micronaut/data/annotation/Repository.java

@@ -26,7 +26,7 @@
 import java.lang.annotation.Target;
 
 /**
- * Designates a type of a data repository. If the type is an interface or abstract
+ * Designates a type of data repository. If the type is an interface or abstract
  * class this annotation will attempt to automatically provide implementations at compilation time.
  *
  * @author graemerocher

data-model/src/main/java/io/micronaut/data/intercept/CountInterceptor.java

@@ -16,7 +16,7 @@
 package io.micronaut.data.intercept;
 
 /**
- * An interceptor that executes a a count of all records.
+ * An interceptor that executes a count of all records.
  *
  * @param <T> The declaring type
  * @author graemerocher

data-model/src/main/java/io/micronaut/data/intercept/annotation/DataMethod.java

@@ -99,21 +99,21 @@
     String META_MEMBER_PARAMETER_BINDING_PATHS = META_MEMBER_PARAMETER_BINDING + "Paths";
 
     /**
-     * The member name that holds parameter auto populated property paths.
+     * The member name that holds parameter auto-populated property paths.
      * @deprecated No longer used
      */
     @Deprecated(forRemoval = true)
     String META_MEMBER_PARAMETER_AUTO_POPULATED_PROPERTY_PATHS = META_MEMBER_PARAMETER_BINDING + "AutoPopulatedPaths";
 
     /**
-     * The member name that holds parameter auto populated property paths.
+     * The member name that holds parameter auto-populated property paths.
      * @deprecated No longer used
      */
     @Deprecated(forRemoval = true)
     String META_MEMBER_PARAMETER_AUTO_POPULATED_PREVIOUS_PROPERTY_PATHS = META_MEMBER_PARAMETER_BINDING + "AutoPopulatedPreviousPaths";
 
     /**
-     * The member name that holds parameter auto populated property paths.
+     * The member name that holds parameter auto-populated property paths.
      * @deprecated No longer used
      */
     @Deprecated(forRemoval = true)
@@ -292,7 +292,7 @@ enum OperationType {
          */
         COUNT,
         /**
-         * A exists operation.
+         * An exists operation.
          */
         EXISTS,
         /**

data-model/src/main/java/io/micronaut/data/intercept/async/CountAsyncInterceptor.java

@@ -20,7 +20,7 @@
 import java.util.concurrent.CompletionStage;
 
 /**
- * An interceptor that executes a a count of all records asynchronously.
+ * An interceptor that executes a count of all records asynchronously.
  *
  * @param <T> The declaring type
  * @author graemerocher

data-model/src/main/java/io/micronaut/data/intercept/reactive/FindByIdReactiveInterceptor.java

@@ -18,7 +18,7 @@
 import io.micronaut.data.intercept.DataInterceptor;
 
 /**
- * An interceptor that executes an find by id reactively.
+ * An interceptor that executes a find by id reactively.
  *
  * @param <T> The declaring type
  * @param <R> The result type

data-model/src/main/java/io/micronaut/data/intercept/reactive/UpdateReactiveInterceptor.java

@@ -18,7 +18,7 @@
 import io.micronaut.data.intercept.DataInterceptor;
 
 /**
- * An interceptor that saves a updates entity reactively.
+ * An interceptor that saves an updates entity reactively.
  *
  * @param <T> The declaring type
  * @param <R> The result type

data-model/src/main/java/io/micronaut/data/model/DataType.java

@@ -31,7 +31,7 @@
 import java.util.*;
 
 /**
- * Enum of basic data types allowing compile time computation which can then subsequently be used at runtime for fast
+ * Enum of basic data types allowing to compile time computation which can then subsequently be used at runtime for fast
  * switching.
  *
  * @author graemerocher

data-model/src/main/java/io/micronaut/data/model/PersistentProperty.java

@@ -121,7 +121,7 @@ default boolean isGenerated() {
     }
 
     /**
-     * @return True if the property is autopopulated
+     * @return True if the property is auto-populated
      */
     default boolean isAutoPopulated() {
         return !isGenerated() && getAnnotationMetadata().hasStereotype(AutoPopulated.class);

data-model/src/main/java/io/micronaut/data/model/naming/NamingStrategy.java

@@ -44,7 +44,7 @@
 public interface NamingStrategy {
 
     /**
-     * Constant for the default under score separated lower case strategy.
+     * Constant for the default underscore separated lower case strategy.
      */
     NamingStrategy DEFAULT = new NamingStrategies.UnderScoreSeparatedLowerCase();
 

data-model/src/main/java/io/micronaut/data/model/query/Criteria.java

@@ -213,7 +213,7 @@ public interface Criteria  {
     @NonNull Criteria contains(@NonNull String propertyName, @NonNull Object parameter);
 
     /**
-     * Creates an ilike Criterion based on the specified property name and value. Unlike a like condition, ilike is case insensitive.
+     * Creates an ilike Criterion based on the specified property name and value. Unlike a like condition, ilike is case-insensitive.
      *
      * @param propertyName The property name
      * @param parameter The parameter that provides the value
@@ -223,7 +223,7 @@ public interface Criteria  {
     @NonNull Criteria ilike(@NonNull String propertyName, @NonNull Object parameter);
 
     /**
-     * Creates an rlike Criterion based on the specified property name and value.
+     * Creates a rlike Criterion based on the specified property name and value.
      *
      * @param propertyName The property name
      * @param parameter The parameter that provides the value

data-model/src/main/java/io/micronaut/data/model/query/DefaultQuery.java

@@ -95,9 +95,8 @@ public List<Projection> getProjections() {
         return projections.getProjectionList();
     }
 
-
     /**
-     * Obtain the joint for for a given association.
+     * Obtain the joint for a given association.
      * @param path The path to the association
      * @return The join type
      */

data-model/src/main/java/io/micronaut/data/model/query/QueryModel.java

@@ -377,7 +377,7 @@ QueryModel from(@NonNull PersistentEntity entity) {
 
     /**
      * Whether to lock the selected entities.
-     * @return true if the the selected entities should be locked
+     * @return true if the selected entities should be locked
      */
     boolean isForUpdate();
 
@@ -1293,7 +1293,7 @@ public Junction(List<Criterion> criteria) {
         }
 
         /**
-         * Adds an additional criterion.
+         * Adds another criterion.
          * @param c The criterion
          * @return This junction
          */

data-model/src/main/java/io/micronaut/data/model/query/builder/AbstractSqlLikeQueryBuilder.java

@@ -2529,8 +2529,8 @@ public static final class Placeholder {
         /**
          * Default constructor.
          *
-         * @param name The name of the place holder
-         * @param key  The key to set the value of the place holder
+         * @param name The name of the placeholder
+         * @param key  The key to set the value of the placeholder
          */
         public Placeholder(String name, String key) {
             this.name = name;
@@ -2543,14 +2543,14 @@ public String toString() {
         }
 
         /**
-         * @return The place holder name
+         * @return The placeholder name
          */
         public String getName() {
             return name;
         }
 
         /**
-         * This the precomputed key to set the place holder. In SQL this would be the index.
+         * This the precomputed key to set the placeholder. In SQL this would be the index.
          *
          * @return The key used to set the placeholder.
          */

data-model/src/main/java/io/micronaut/data/model/query/builder/sql/Dialect.java

@@ -187,7 +187,7 @@ public boolean supportsJsonEntity() {
     /**
      * Whether the dialect supports UPDATE ... RETURNING clause.
      *
-     * @return true if does supports
+     * @return true if it does support
      * @since 4.2.0
      */
     public boolean supportsUpdateReturning() {
@@ -197,7 +197,7 @@ public boolean supportsUpdateReturning() {
     /**
      * Whether the dialect supports INSERT ... RETURNING clause.
      *
-     * @return true if does supports
+     * @return true if it does support
      * @since 4.2.0
      */
     public boolean supportsInsertReturning() {
@@ -207,7 +207,7 @@ public boolean supportsInsertReturning() {
     /**
      * Whether the dialect supports DELETE ... RETURNING clause.
      *
-     * @return true if does supports
+     * @return true if it does support
      * @since 4.2.0
      */
     public boolean supportsDeleteReturning() {

data-model/src/main/java/io/micronaut/data/model/query/builder/sql/SqlQueryBuilder.java

@@ -322,7 +322,7 @@ public static boolean isForeignKeyWithJoinTable(@NonNull Association association
     }
 
     /**
-     * Builds the create table statement. Designed for testing and not production usage. For production a
+     * Builds the creation table statement. Designed for testing and not production usage. For production a
      * SQL migration tool such as Flyway or Liquibase is recommended.
      *
      * @param entity The entity
@@ -694,7 +694,7 @@ private String addGeneratedStatementToColumn(PersistentProperty prop, String col
                     }
                     break;
                 case ORACLE:
-                    // for Oracle we use sequences so just add NOT NULL
+                    // for Oracle, we use sequences so just add NOT NULL
                     // then alter the table for sequences
                     if (type == UUID) {
                         column += " NOT NULL DEFAULT SYS_GUID()";
@@ -822,7 +822,7 @@ protected void selectAllColumnsFromJoinPaths(QueryState queryState,
                     queryBuffer.append(COMMA);
 
                     boolean includeIdentity = association.isForeignKey();
-                    // in the case of a foreign key association the ID is not in the table
+                    // in the case of a foreign key association the ID is not in the table,
                     // so we need to retrieve it
                     traversePersistentProperties(associatedEntity, includeIdentity, true, (propertyAssociations, prop) -> {
                         String columnName;

data-model/src/main/java/io/micronaut/data/model/query/builder/sql/SqlQueryConfiguration.java

@@ -40,7 +40,7 @@
         Dialect dialect();
 
         /**
-         * A String format (see {@link String#format(String, Object...)} to format the appearance
+         * A String format (see {@link String#format(String, Object...)}) to format the appearance
          * of position parameters. It receives exactly one parameter which is the parameter index (starting from 1).
          * <p>
          * NOTE: If {@link #positionalParameterName()} is specified, the formatter will receive the custom name.
@@ -50,7 +50,7 @@
         String positionalParameterFormat() default "?";
 
         /**
-         * A String format (see {@link String#format(String, Object...)} to format the parameter name.
+         * A String format (see {@link String#format(String, Object...)}) to format the parameter name.
          * It receives exactly one parameter which is the parameter index (starting from 1).
          *
          * @return The position parameter name.