Resolve linting errors in the javadoc contents (airbytehq#7612)

* Javadoc cleanup

.gitignore

@@ -1,6 +1,7 @@
 .gradle
 .idea
 *.iml
+*.swp
 build
 out
 .DS_Store

airbyte-integrations/bases/base-java/src/main/java/io/airbyte/integrations/base/AirbyteMessageConsumer.java

@@ -17,13 +17,14 @@
  * to.
  *
  * Lifecycle:
+ * <ul>
  * <li>1. Instantiate consumer.</li>
  * <li>2. start() to initialize any resources that need to be created BEFORE the consumer consumes
  * any messages.</li>
  * <li>3. Consumes ALL records via {@link AirbyteMessageConsumer#accept(AirbyteMessage)}</li>
  * <li>4. Always (on success or failure) finalize by calling
  * {@link AirbyteMessageConsumer#close()}</li>
- *
+ * </ul>
  * We encourage implementing this interface using the {@link FailureTrackingAirbyteMessageConsumer}
  * class.
  */

airbyte-integrations/bases/debezium/src/main/java/io/airbyte/integrations/debezium/internals/AirbyteFileOffsetBackingStore.java

@@ -28,10 +28,10 @@
 /**
  * This class handles reading and writing a debezium offset file. In many cases it is duplicating
  * logic in debezium because that logic is not exposed in the public API. We mostly treat the
- * contents of this state file like a black box. We know it is a Map<ByteBuffer, Bytebuffer>. We
- * deserialize it to a Map<String, String> so that the state file can be human readable. If we ever
- * discover that any of the contents of these offset files is not string serializable we will likely
- * have to drop the human readability support and just base64 encode it.
+ * contents of this state file like a black box. We know it is a Map&lt;ByteBuffer, Bytebuffer&gt;.
+ * We deserialize it to a Map&lt;String, String&gt; so that the state file can be human readable. If
+ * we ever discover that any of the contents of these offset files is not string serializable we
+ * will likely have to drop the human readability support and just base64 encode it.
  */
 public class AirbyteFileOffsetBackingStore {
 

airbyte-integrations/bases/debezium/src/main/java/io/airbyte/integrations/debezium/internals/AirbyteSchemaHistoryStorage.java

@@ -26,8 +26,8 @@
  * The purpose of this class is : to , 1. Read the contents of the file {@link #path} which contains
  * the schema history at the end of the sync so that it can be saved in state for future syncs.
  * Check {@link #read()} 2. Write the saved content back to the file {@link #path} at the beginning
- * of the sync so that debezium can function smoothly. Check {@link #persist(Optional<JsonNode>)}.
- * To understand more about file, please refer {@link FilteredFileDatabaseHistory}
+ * of the sync so that debezium can function smoothly. Check persist(Optional&lt;JsonNode&gt;). To
+ * understand more about file, please refer {@link FilteredFileDatabaseHistory}
  */
 public class AirbyteSchemaHistoryStorage {
 

airbyte-integrations/bases/debezium/src/main/java/io/airbyte/integrations/debezium/internals/MySQLConverter.java

@@ -19,9 +19,9 @@
  * https://debezium.io/documentation/reference/1.4/development/converters.html This is built from
  * reference with {@link io.debezium.connector.mysql.converters.TinyIntOneToBooleanConverter} If you
  * rename this class then remember to rename the datetime.type property value in
- * {@link io.airbyte-integrations.source.mysql.MySqlCdcProperties#getDebeziumProperties()} (If you
- * don't rename, a test would still fail but it might be tricky to figure out where to change the
- * property name)
+ * io.airbyte-integrations.source.mysql.MySqlCdcProperties#getDebeziumProperties() (If you don't
+ * rename, a test would still fail but it might be tricky to figure out where to change the property
+ * name)
  */
 public class MySQLConverter implements CustomConverter<SchemaBuilder, RelationalColumn> {
 

airbyte-integrations/connectors/destination-azure-blob-storage/src/main/java/io/airbyte/integrations/destination/azure_blob_storage/writer/BaseAzureBlobStorageWriter.java

@@ -15,9 +15,11 @@
 
 /**
  * The base implementation takes care of the following:
+ * <ul>
  * <li>Create shared instance variables.</li>
  * <li>Create the bucket and prepare the bucket path.</li>
  * <li>Log and close the write.</li>
+ * </ul>
  */
 public abstract class BaseAzureBlobStorageWriter implements AzureBlobStorageWriter {
 

airbyte-integrations/connectors/destination-bigquery-denormalized/src/main/java/io/airbyte/integrations/destination/bigquery/BigQueryDenormalizedRecordConsumer.java

@@ -76,7 +76,7 @@ protected JsonNode formatRecord(final Schema schema, final AirbyteRecordMessage
   }
 
   @Override
-  public void close(boolean hasFailed) {
+  public void close(final boolean hasFailed) {
     fieldsWithRefDefinition.clear();
     super.close(hasFailed);
   }
@@ -86,7 +86,7 @@ protected JsonNode formatData(final FieldList fields, final JsonNode root) {
     if (fields == null) {
       return root;
     }
-    List<String> dateTimeFields = BigQueryUtils.getDateTimeFieldsFromSchema(fields);
+    final List<String> dateTimeFields = BigQueryUtils.getDateTimeFieldsFromSchema(fields);
     if (!dateTimeFields.isEmpty()) {
       BigQueryUtils.transformJsonDateTimeToBigDataFormat(dateTimeFields, (ObjectNode) root);
     }

airbyte-integrations/connectors/destination-bigquery-denormalized/src/test-integration/java/io/airbyte/integrations/destination/bigquery/BigQueryDenormalizedDestinationTest.java

@@ -281,8 +281,8 @@ private Set<String> extractJsonValues(final JsonNode node, final String attribut
     return resultSet;
   }
 
-  private JsonNode removeAirbyteMetadataFields(JsonNode record) {
-    for (String airbyteMetadataField : AIRBYTE_METADATA_FIELDS) {
+  private JsonNode removeAirbyteMetadataFields(final JsonNode record) {
+    for (final String airbyteMetadataField : AIRBYTE_METADATA_FIELDS) {
       ((ObjectNode) record).remove(airbyteMetadataField);
     }
     return record;
@@ -311,7 +311,7 @@ private static Stream<Arguments> schemaAndDataProvider() {
         arguments(getSchema(), MESSAGE_USERS2));
   }
 
-  private static AirbyteMessage createRecordMessage(String stream, JsonNode data) {
+  private static AirbyteMessage createRecordMessage(final String stream, final JsonNode data) {
     return new AirbyteMessage().withType(AirbyteMessage.Type.RECORD)
         .withRecord(new AirbyteRecordMessage().withStream(stream)
             .withData(data)

airbyte-integrations/connectors/destination-databricks/src/main/java/io/airbyte/integrations/destination/databricks/DatabricksStreamCopier.java

@@ -26,15 +26,18 @@
  * This implementation is similar to
  * {@link io.airbyte.integrations.destination.jdbc.copy.s3.S3StreamCopier}. The difference is that
  * this implementation creates Parquet staging files, instead of CSV ones.
- * <p/>
+ * <p>
+ * </p>
  * It does the following operations:
+ * <ul>
  * <li>1. Parquet writer writes data stream into staging parquet file in
- * s3://<bucket-name>/<bucket-path>/<staging-folder>.</li>
+ * s3://bucket-name/bucket-path/staging-folder.</li>
  * <li>2. Create a tmp delta table based on the staging parquet file.</li>
  * <li>3. Create the destination delta table based on the tmp delta table schema in
- * s3://<bucket>/<stream-name>.</li>
+ * s3://bucket/stream-name.</li>
  * <li>4. Copy the staging parquet file into the destination delta table.</li>
  * <li>5. Delete the tmp delta table, and the staging parquet file.</li>
+ * </ul>
  */
 public class DatabricksStreamCopier implements StreamCopier {
 

airbyte-integrations/connectors/destination-gcs/src/main/java/io/airbyte/integrations/destination/gcs/writer/BaseGcsWriter.java

@@ -28,8 +28,10 @@
 
 /**
  * The base implementation takes care of the following:
+ * <ul>
  * <li>Create shared instance variables.</li>
  * <li>Create the bucket and prepare the bucket path.</li>
+ * </ul>
  */
 public abstract class BaseGcsWriter implements S3Writer {
 
@@ -52,8 +54,10 @@ protected BaseGcsWriter(final GcsDestinationConfig config,
   }
 
   /**
+   * <ul>
    * <li>1. Create bucket if necessary.</li>
    * <li>2. Under OVERWRITE mode, delete all objects with the output prefix.</li>
+   * </ul>
    */
   @Override
   public void initialize() {

airbyte-integrations/connectors/destination-s3/src/main/java/io/airbyte/integrations/destination/s3/avro/JsonToAvroSchemaConverter.java

@@ -30,7 +30,8 @@
  * The main function of this class is to convert a JsonSchema to Avro schema. It can also
  * standardize schema names, and keep track of a mapping from the original names to the standardized
  * ones, which is needed for unit tests.
- * <p/>
+ * <p>
+ * </p>
  * For limitations of this converter, see the README of this connector:
  * https://docs.airbyte.io/integrations/destinations/s3#avro
  */

airbyte-integrations/connectors/destination-s3/src/main/java/io/airbyte/integrations/destination/s3/util/AvroRecordHelper.java

@@ -24,9 +24,11 @@ public static JsonFieldNameUpdater getFieldNameUpdater(final String streamName,
 
   /**
    * Convert an Airbyte JsonNode from Avro / Parquet Record to a plain one.
+   * <ul>
    * <li>Remove the airbyte id and emission timestamp fields.</li>
-   * <li>Remove null fields that must exist in Parquet but does not in original Json.</li> This
-   * function mutates the input Json.
+   * <li>Remove null fields that must exist in Parquet but does not in original Json. This function
+   * mutates the input Json.</li>
+   * </ul>
    */
   public static JsonNode pruneAirbyteJson(final JsonNode input) {
     final ObjectNode output = (ObjectNode) input;

airbyte-integrations/connectors/destination-s3/src/main/java/io/airbyte/integrations/destination/s3/util/S3OutputPathHelper.java

@@ -17,8 +17,9 @@ public static String getOutputPrefix(final String bucketPath, final AirbyteStrea
   }
 
   /**
-   * Prefix: <bucket-path>/<source-namespace-if-present>/<stream-name>
+   * Prefix: &lt;bucket-path&gt;/&lt;source-namespace-if-present&gt;/&lt;stream-name&gt;
    */
+  // Prefix: <bucket-path>/<source-namespace-if-present>/<stream-name>
   public static String getOutputPrefix(final String bucketPath, final String namespace, final String streamName) {
     final List<String> paths = new LinkedList<>();
 

airbyte-integrations/connectors/destination-s3/src/main/java/io/airbyte/integrations/destination/s3/writer/BaseS3Writer.java

@@ -28,9 +28,11 @@
 
 /**
  * The base implementation takes care of the following:
+ * <ul>
  * <li>Create shared instance variables.</li>
  * <li>Create the bucket and prepare the bucket path.</li>
  * <li>Log and close the write.</li>
+ * </ul>
  */
 public abstract class BaseS3Writer implements S3Writer {
 
@@ -57,8 +59,10 @@ public String getOutputPrefix() {
   }
 
   /**
+   * <ul>
    * <li>1. Create bucket if necessary.</li>
    * <li>2. Under OVERWRITE mode, delete all objects with the output prefix.</li>
+   * </ul>
    */
   @Override
   public void initialize() {

airbyte-integrations/connectors/source-relational-db/src/main/java/io/airbyte/integrations/source/relationaldb/AbstractRelationalDbSource.java

@@ -19,8 +19,8 @@
  * This class contains helper functions and boilerplate for implementing a source connector for a
  * relational DB source.
  *
- * @see io.airbyte.integrations.source.jdbc.AbstractJdbcSource if you are implementing a relational
- *      DB which can be accessed via JDBC driver.
+ * see io.airbyte.integrations.source.jdbc.AbstractJdbcSource if you are implementing a relational
+ * DB which can be accessed via JDBC driver.
  */
 public abstract class AbstractRelationalDbSource<DataType, Database extends SqlDatabase> extends
     AbstractDbSource<DataType, Database> implements Source {