Fix typos (liquibase#5716)

* Fix java doc and typos.

* Remove space.

* grammar

* Revert.

* Typos.

CODE_OF_CONDUCT.md

@@ -28,7 +28,7 @@ Examples of unacceptable behavior by participants include:
 * Public or private harassment
 * Publishing others' private information, such as a physical or electronic
  address, without explicit permission
-* Publishing or using any name other than an @mentionable Github account name.
+* Publishing or using any name other than a @mentionable GitHub account name.
 * Other conduct which could reasonably be considered inappropriate in a
  professional setting
 

changelog.txt

@@ -1804,7 +1804,7 @@ Changes in version 4.16.0 (2022.09.08)
 * Tidy ExecutorService code, remove superfluous map access (Issue 1841) by @jamey-clari in #1842
 * Fixed order of enum values on MySQL 8 by @Tantalon in #3150
 * Removed invalid warning in Maven by @nvoxland in #3189
-* [PRO] QC: checks show changes (--show-cols flag, drop some, etc) by @dyadyushko in #3187
+* [PRO] QC: checks show changes (--show-cols flag, drop some, etc.) by @dyadyushko in #3187
 
 Changes in version 4.15.0 (2022.08.04)
 

liquibase-integration-tests/src/test/resources/changelogs/h2/complete/root.changelog.xml

@@ -36,7 +36,7 @@
         <preConditions>
             <or>
                 <dbms type="h2"/>
-                <sqlCheck expectedResult="3">INVALID SQL HERE, SHOULD NOT HIT DUE TO SHORT CIRCUT</sqlCheck>
+                <sqlCheck expectedResult="3">INVALID SQL HERE, SHOULD NOT HIT DUE TO SHORT CIRCUIT</sqlCheck>
             </or>
         </preConditions>
         <createSequence sequenceName="seq_person"/>

liquibase-maven-plugin/src/main/java/org/liquibase/maven/plugins/AbstractLiquibaseChangeLogMojo.java

@@ -67,7 +67,7 @@ public abstract class AbstractLiquibaseChangeLogMojo extends AbstractLiquibaseMo
 
     /**
      * Specifies which Liquibase labels Liquibase will execute, which can be separated by a comma if multiple labels
-     are required or you need to designate a more complex expression.
+     * are required or you need to designate a more complex expression.
      * If a label is not specified, then ALL labels will be executed.
      *
      * @parameter property="liquibase.labelFilter" default-value=""

liquibase-maven-plugin/src/main/java/org/liquibase/maven/plugins/AbstractLiquibaseMojo.java

@@ -70,7 +70,7 @@
 public abstract class AbstractLiquibaseMojo extends AbstractMojo {
 
     /**
-     * Suffix for fields that are representing a default value for a another field.
+     * Suffix for fields that are representing a default value for another field.
      */
     private static final String DEFAULT_FIELD_SUFFIX = "Default";
 

liquibase-maven-plugin/src/test/java/org/liquibase/maven/MavenIntegrationTest.java

@@ -9,7 +9,7 @@
 import java.io.IOException;
 
 /**
- * Maven integration test. Run an update executing maven as if it was ran by the user
+ * Maven integration test. Run an update executing maven as if it was run by the user
  * @author lujop
  */
 public class MavenIntegrationTest {

liquibase-standard/src/main/java/liquibase/change/AbstractChange.java

@@ -33,7 +33,7 @@
 import static liquibase.statement.SqlStatement.EMPTY_SQL_STATEMENT;
 
 /**
- * Standard superclass to simplify {@link Change } implementations. You can implement Change directly, this class is
+ * Standard superclass to simplify {@link Change} implementations. You can implement Change directly, this class is
  * purely for convenience but recommended.
  * <p></p>
  * By default, this base class relies on annotations such as {@link DatabaseChange} and {@link DatabaseChangeProperty}
@@ -59,7 +59,7 @@ public void finishInitialization() throws SetupException {
     }
 
     /**
-     * Generate the ChangeMetaData for this class. Default implementation reads from the @{@link DatabaseChange } annotation
+     * Generate the ChangeMetaData for this class. Default implementation reads from the @{@link DatabaseChange} annotation
      * and calls out to {@link #createChangeParameterMetadata(String)} for each property.
      *
      * @throws UnexpectedLiquibaseException if no @DatabaseChange annotation on this Change class
@@ -344,7 +344,7 @@ public void setChangeSet(ChangeSet changeSet) {
     /**
      * Implementation delegates logic to the
      * {@link liquibase.sqlgenerator.SqlGenerator#generateStatementsIsVolatile(Database) } method on the
-     * {@link SqlStatement} objects returned by {@link #generateStatements }.
+     * {@link SqlStatement} objects returned by {@link #generateStatements}.
      * If zero or null SqlStatements are returned by generateStatements then this method returns false.
      */
     @Override
@@ -364,7 +364,7 @@ public boolean generateStatementsVolatile(Database database) {
     /**
      * Implementation delegates logic to the
      * {@link liquibase.sqlgenerator.SqlGenerator#generateRollbackStatementsIsVolatile(Database) }
-     * method on the {@link SqlStatement} objects returned by {@link #generateStatements }
+     * method on the {@link SqlStatement} objects returned by {@link #generateStatements}
      * If no or null SqlStatements are returned by generateRollbackStatements then this method returns false.
      */
     @Override
@@ -387,7 +387,7 @@ public boolean generateRollbackStatementsVolatile(Database database) {
     /**
      * Implementation delegates logic to the
      * {@link liquibase.sqlgenerator.SqlGenerator#supports(liquibase.statement.SqlStatement, liquibase.database.Database)}
-     * method on the {@link SqlStatement} objects returned by {@link #generateStatements }.
+     * method on the {@link SqlStatement} objects returned by {@link #generateStatements}.
      * If no or null SqlStatements are returned by generateStatements then this method returns true.
      * If {@link #generateStatementsVolatile(liquibase.database.Database)} returns true, we cannot call generateStatements and so assume true.
      */
@@ -412,7 +412,7 @@ public boolean supports(Database database) {
      * Implementation delegates logic to the
      * {@link liquibase.sqlgenerator.SqlGenerator#warn(liquibase.statement.SqlStatement, liquibase.database.Database,
      * liquibase.sqlgenerator.SqlGeneratorChain)} method on the {@link SqlStatement} objects returned by
-     * {@link #generateStatements }.
+     * {@link #generateStatements}.
      * If a generated statement is not supported for the given database, no warning will be added since that is a
      * validation error. If no or null SqlStatements are returned by generateStatements then this method returns no
      * warnings.
@@ -447,7 +447,7 @@ public Warnings warn(Database database) {
      * and also delegates logic to the
      * {@link liquibase.sqlgenerator.SqlGenerator#validate(liquibase.statement.SqlStatement,
      * liquibase.database.Database, liquibase.sqlgenerator.SqlGeneratorChain)}  method on the {@link SqlStatement}
-     * objects returned by {@link #generateStatements }.
+     * objects returned by {@link #generateStatements}.
      * If no or null SqlStatements are returned by generateStatements then this method returns no errors.
      * If there are no parameters than this method returns no errors
      */
@@ -616,7 +616,7 @@ public void setResourceAccessor(ResourceAccessor resourceAccessor) {
     /**
      * Implementation delegates logic to the
      * {@link liquibase.sqlgenerator.SqlGeneratorFactory#getAffectedDatabaseObjects(liquibase.statement.SqlStatement,
-     * liquibase.database.Database)} method on the {@link SqlStatement} objects returned by {@link #generateStatements }
+     * liquibase.database.Database)} method on the {@link SqlStatement} objects returned by {@link #generateStatements}
      * Returns empty set if change is not supported for the passed database
      */
     @Override

liquibase-standard/src/main/java/liquibase/change/Change.java

@@ -21,7 +21,7 @@
 /**
  * Interface all changes (refactorings) implement.
  * <p>
- * Instances of these objects are normally created via the {@link ChangeFactory } by {@link liquibase.parser.ChangeLogParser} implementations.
+ * Instances of these objects are normally created via the {@link ChangeFactory} by {@link liquibase.parser.ChangeLogParser} implementations.
  *
  * @see ChangeFactory
  * @see Database

liquibase-standard/src/main/java/liquibase/change/ChangeWithColumns.java

@@ -13,7 +13,7 @@ public interface ChangeWithColumns<T extends ColumnConfig> {
     void addColumn(T column);
 
     /**
-     * Return all the {@link ColumnConfig} objects defined for this {@link Change }
+     * Return all the {@link ColumnConfig} objects defined for this {@link Change}
      */
     List<T> getColumns();
 

liquibase-standard/src/main/java/liquibase/change/DatabaseChange.java

@@ -3,7 +3,7 @@
 import java.lang.annotation.*;
 
 /**
- * Annotation used by {@link AbstractChange } to declare {@link ChangeMetaData} information.
+ * Annotation used by {@link AbstractChange} to declare {@link ChangeMetaData} information.
  * This annotation should not be checked for outside AbstractChange, if any code is trying to determine the
  * metadata provided by this annotation, it should get it from
  * {@link liquibase.change.ChangeFactory#getChangeMetaData(Change)}
@@ -24,7 +24,7 @@
     String description();
 
     /**
-     * Value to put into {@link ChangeMetaData#getPriority()} ()}
+     * Value to put into {@link ChangeMetaData#getPriority()}
      */
     int priority();
 

liquibase-standard/src/main/java/liquibase/change/DatabaseChangeProperty.java

@@ -7,7 +7,7 @@
 import java.lang.annotation.*;
 
 /**
- * Annotation used by {@link AbstractChange } to declare {@link ChangeParameterMetaData} information.
+ * Annotation used by {@link AbstractChange} to declare {@link ChangeParameterMetaData} information.
  * The annotation should be placed on the read method.
  * This annotation should not be checked for outside AbstractChange, if any code is trying to determine the
  * metadata provided by this annotation, it should get it from

liquibase-standard/src/main/java/liquibase/change/core/CreateProcedureChange.java

@@ -377,7 +377,7 @@ public SqlStatement[] generateStatements(Database database) {
             procedureText = StringUtil.trimToNull(getProcedureText());
         } else {
             if (getChangeSet() == null) {
-                //only try to read a file when inside a changest. Not when analyizing supported
+                //only try to read a file when inside a changest. Not when analyzing supported
                 procedureText = "NO CHANGESET";
             } else {
                 try {

liquibase-standard/src/main/java/liquibase/change/core/SQLFileChange.java

@@ -124,18 +124,18 @@ public ValidationErrors validate(Database database) {
             try {
                 Resource resource = getResource();
                 if (!resource.exists()) {
-                    alertOnNonExistantSqlFile(validationErrors);
+                    alertOnNonExistentSqlFile(validationErrors);
                 }
             } catch (IOException e) {
                 Scope.getCurrentScope().getLog(getClass()).warning("Failed to obtain sqlFile resource at path '" + path + "'while attempting to validate the existence of the sqlFile.", e);
-                alertOnNonExistantSqlFile(validationErrors);
+                alertOnNonExistentSqlFile(validationErrors);
             }
         }
 
         return validationErrors;
     }
 
-    private void alertOnNonExistantSqlFile(ValidationErrors validationErrors) {
+    private void alertOnNonExistentSqlFile(ValidationErrors validationErrors) {
         if (ChangeLogParserConfiguration.ON_MISSING_SQL_FILE.getCurrentValue().equals(ChangeLogParserConfiguration.MissingIncludeConfiguration.WARN)) {
             validationErrors.addWarning(FileUtil.getFileNotFoundMessage(path));
         } else {

liquibase-standard/src/main/java/liquibase/change/custom/CustomChange.java

@@ -38,7 +38,7 @@ public interface CustomChange {
 
     /**
      * Tests that the change is configured correctly before attempting to execute it.
-     * @param database The database the change will be ran against
+     * @param database The database the change will be run against
      */
     ValidationErrors validate(Database database);
 

liquibase-standard/src/main/java/liquibase/change/custom/CustomChangeWrapper.java

@@ -187,7 +187,7 @@ public SqlStatement[] generateStatements(Database database) {
      * or {@link CustomTaskRollback#rollback(liquibase.database.Database)} depending on the CustomChange implementation.
      * <p></p>
      * If the CustomChange returns a null SqlStatement array, this method returns an empty array. If a CustomTaskChange is being used, this method will return an empty array.
-     * Any {@link RollbackImpossibleException} exceptions thrown by the CustomChange will thrown by this method.
+     * Any {@link RollbackImpossibleException} exceptions thrown by the CustomChange will be thrown by this method.
      */
     @Override
     public SqlStatement[] generateRollbackStatements(Database database) throws RollbackImpossibleException {

liquibase-standard/src/main/java/liquibase/changelog/ChangeLogHistoryService.java

@@ -49,7 +49,7 @@ default List<RanChangeSet> getRanChangeSets(boolean allowChecksumsUpgrade) throw
     ChangeSet.RunStatus getRunStatus(ChangeSet changeSet) throws DatabaseException, DatabaseHistoryException;
 
     /**
-     * Returns the date the given changeSet was ran. Returns null if changeSet was not null.
+     * Returns the date the given changeSet was run. Returns null if changeSet was not null.
      */
     Date getRanDate(ChangeSet changeSet) throws DatabaseException, DatabaseHistoryException;
 

liquibase-standard/src/main/java/liquibase/changelog/ChangeSet.java

@@ -233,7 +233,7 @@ public String toString() {
     private String created;
 
     /**
-     * Allow changeSet to be ran "first" or "last". Multiple changeSets with the same runOrder will preserve their order relative to each other.
+     * Allow changeSet to be run "first" or "last". Multiple changeSets with the same runOrder will preserve their order relative to each other.
      */
     @Getter
     private String runOrder;

liquibase-standard/src/main/java/liquibase/changelog/ChangeSetStatus.java

@@ -12,7 +12,7 @@
 
 /**
  * Contains the current status of a ChangeSet. Normally returned by {@link liquibase.changelog.visitor.StatusVisitor}.
- * Contains information on whether the changeSet has ran before and will run next time.
+ * Contains information on whether the changeSet has run before and will run next time.
  */
 public class ChangeSetStatus {
 
@@ -125,7 +125,7 @@ public boolean isFilteredBy(Class<? extends ChangeSetFilter> filterType) {
     }
 
     /**
-     * Return the checksum stored from the last execution of the changeset. Returns null if it has not ran before
+     * Return the checksum stored from the last execution of the changeset. Returns null if it has not run before
      */
     public CheckSum getStoredCheckSum() {
         return storedCheckSum;
@@ -136,7 +136,7 @@ public void setStoredCheckSum(CheckSum storedCheckSum) {
     }
 
     /**
-     * Return the date the changeset was last executed. Returns null if it has not ran before
+     * Return the date the changeset was last executed. Returns null if it has not run before
      */
     public Date getDateLastExecuted() {
         return dateLastExecuted;
@@ -147,7 +147,7 @@ public void setDateLastExecuted(Date dateLastExecuted) {
     }
 
     /**
-     * Returns true if the changeset was ran previously.
+     * Returns true if the changeset was run previously.
      */
     public boolean getPreviouslyRan() {
         return previouslyRan;

liquibase-standard/src/main/java/liquibase/changelog/filter/AlreadyRanChangeSetFilter.java

@@ -16,7 +16,7 @@ public ChangeSetFilterResult accepts(ChangeSet changeSet) {
         if (getRanChangeSet(changeSet) != null) {
             return new ChangeSetFilterResult(true, "Changeset already ran", this.getClass(), getMdcName(), getDisplayName());
         } else {
-            return new ChangeSetFilterResult(false, "Changeset has not ran", this.getClass(), getMdcName(), getDisplayName());
+            return new ChangeSetFilterResult(false, "Changeset has not run", this.getClass(), getMdcName(), getDisplayName());
         }
     }
 

liquibase-standard/src/main/java/liquibase/command/AbstractCliWrapperCommandStep.java

@@ -57,7 +57,7 @@ protected void preRunCheck(CommandResultsBuilder resultsBuilder) {
 
     /**
      * Collects the values from commandScope into an argument array to pass to {@link Main}.
-     * All arguments will values in commandScope will be passed as global arguments EXCEPT for ones listed in the commandArguments.
+     * All arguments with values in commandScope will be passed as global arguments EXCEPT for ones listed in the commandArguments.
      * If main takes a "positional argument" like `liquibase tag tagName`, specify the commandScope argument that should be converted to a positional argument in "positionalArgumentName".
      *
      * @see #removeArgumentValues(String[], String...) If any arguments should not have a value (like a --verbose flag), see

liquibase-standard/src/main/java/liquibase/command/CleanUpCommandStep.java

@@ -4,7 +4,7 @@
 
 /**
  * Interface implemented by CommandSteps when they need to execute clean up tasks (such as closing database
- * connections, flushing files, etc) after other steps in the pipeline are executed.
+ * connections, flushing files, etc.) after other steps in the pipeline are executed.
  */
 public interface CleanUpCommandStep {
 

liquibase-standard/src/main/java/liquibase/configuration/ConfigurationDefinition.java

@@ -11,7 +11,7 @@
 import java.util.regex.Pattern;
 
 /**
- * A higher-level/detailed definition to provide type-safety, metadata, default values, etc..
+ * A higher-level/detailed definition to provide type-safety, metadata, default values, etc.
  * Any code that is working with configurations should be using an instance of this class, rather than the lower-level, generic {@link LiquibaseConfiguration}
  * <p>
  * ConfigurationDefinitions that are registered with {@link LiquibaseConfiguration#registerDefinition(ConfigurationDefinition)} will

liquibase-standard/src/main/java/liquibase/database/AbstractJdbcDatabase.java

@@ -93,7 +93,7 @@ public abstract class AbstractJdbcDatabase implements Database {
     protected List<String> unmodifiableDataTypes = new ArrayList<>();
     protected BigInteger defaultAutoIncrementStartWith = BigInteger.ONE;
     protected BigInteger defaultAutoIncrementBy = BigInteger.ONE;
-    // most databases either lowercase or uppercase unuqoted objects such as table and column names.
+    // most databases either lowercase or uppercase unquoted objects such as table and column names.
     protected Boolean unquotedObjectsAreUppercased;
     // whether object names should be quoted
     protected ObjectQuotingStrategy quotingStrategy = ObjectQuotingStrategy.LEGACY;

liquibase-standard/src/main/java/liquibase/database/Database.java

@@ -422,7 +422,7 @@ default boolean supports(Class<? extends DatabaseObject> object) {
     RanChangeSet getRanChangeSet(ChangeSet changeSet) throws DatabaseException, DatabaseHistoryException;
 
     /**
-     * After the changeset has been ran against the database this method will update the change log table
+     * After the changeset has been run against the database this method will update the change log table
      * with the information.
      */
     void markChangeSetExecStatus(ChangeSet changeSet, ChangeSet.ExecType execType) throws DatabaseException;
@@ -613,7 +613,7 @@ default boolean failOnDefferable() {
 
     /**
      * Allows the database to perform actions after an update is finished,
-     * i. e. after the last change of a changelog was applied.
+     * i.e. after the last change of a changelog was applied.
      */
     default void afterUpdate() throws LiquibaseException {
         // Do nothing by default

liquibase-standard/src/main/java/liquibase/database/core/MariaDBDatabase.java

@@ -86,7 +86,7 @@ public int getMaxFractionalDigitsForTimestamp() {
 
     @Override
     public boolean isCorrectDatabaseImplementation(DatabaseConnection conn) throws DatabaseException {
-        // Presumbably for compatiblity reasons, a MariaDB instance might identify with getDatabaseProductName()=MySQL.
+        // Presumably for compatibility reasons, a MariaDB instance might identify with getDatabaseProductName()=MySQL.
         // To be certain, We search for "mariadb" in the version string.
         if (PRODUCT_NAME.equalsIgnoreCase(conn.getDatabaseProductName())) {
             return true; // Identified as MariaDB product

liquibase-standard/src/main/java/liquibase/database/core/SybaseASADatabase.java

@@ -315,7 +315,7 @@ public void setConnection(DatabaseConnection conn) {
 
     @Override
     public boolean requiresExplicitNullForColumns() {
-        /* SAP Adaptive Server Enterprise and, by extension, SQL Anywhere in ASE compatiblity mode have the
+        /* SAP Adaptive Server Enterprise and, by extension, SQL Anywhere in ASE compatibility mode have the
          * strange requirement of setting the nullability of a column to NOT NULL if neither NULL nor
          * NOT NULL are specified. See:
          * http://dcx.sap.com/index.html#sqla170/en/html/819378356ce21014a17f8d51529119ee.html

liquibase-standard/src/main/java/liquibase/database/core/SybaseDatabase.java

@@ -286,7 +286,7 @@ protected String getQuotingEndCharacter() {
 
     @Override
     public boolean requiresExplicitNullForColumns() {
-        /* SAP Adaptive Server Enterprise and, by extension, SQL Anywhere in ASE compatiblity mode have the
+        /* SAP Adaptive Server Enterprise and, by extension, SQL Anywhere in ASE compatibility mode have the
          * strange requirement of setting the nullability of a column to NOT NULL if neither NULL nor
          * NOT NULL are specified. See:
          * http://dcx.sap.com/index.html#sqla170/en/html/819378356ce21014a17f8d51529119ee.html