From c4429a962c4579633e48ebfa0d3a07b628a90d39 Mon Sep 17 00:00:00 2001 From: Hang Ruan Date: Fri, 1 Jul 2022 21:51:24 +0800 Subject: [PATCH] [docs][cdc-base] Optimize annotations (#1320) This closes #1320. --- .../cdc/connectors/base/dialect/DataSourceDialect.java | 2 +- .../meta/events/FinishedSnapshotSplitsReportEvent.java | 4 ++-- .../base/source/meta/events/StreamSplitMetaEvent.java | 6 +++--- .../source/meta/events/StreamSplitMetaRequestEvent.java | 4 ++-- .../cdc/connectors/base/source/meta/offset/Offset.java | 4 ++-- .../connectors/base/source/meta/split/SnapshotSplit.java | 2 +- .../base/source/meta/split/SnapshotSplitState.java | 9 ++------- .../connectors/base/source/meta/split/StreamSplit.java | 2 +- .../base/source/meta/split/StreamSplitState.java | 2 +- .../source/reader/external/JdbcSourceScanFetcher.java | 2 +- .../source/reader/external/JdbcSourceStreamFetcher.java | 2 +- .../cdc/connectors/base/utils/SourceRecordUtils.java | 2 +- 12 files changed, 18 insertions(+), 23 deletions(-) diff --git a/flink-cdc-base/src/main/java/com/ververica/cdc/connectors/base/dialect/DataSourceDialect.java b/flink-cdc-base/src/main/java/com/ververica/cdc/connectors/base/dialect/DataSourceDialect.java index 6d8f9269a..b624ed136 100644 --- a/flink-cdc-base/src/main/java/com/ververica/cdc/connectors/base/dialect/DataSourceDialect.java +++ b/flink-cdc-base/src/main/java/com/ververica/cdc/connectors/base/dialect/DataSourceDialect.java @@ -70,6 +70,6 @@ public interface DataSourceDialect createFetchTask(SourceSplitBase sourceSplitBase); - /** The task context used fot fetch task to fetch data from external systems. */ + /** The task context used for fetch task to fetch data from external systems. */ FetchTask.Context createFetchTaskContext(SourceSplitBase sourceSplitBase); } diff --git a/flink-cdc-base/src/main/java/com/ververica/cdc/connectors/base/source/meta/events/FinishedSnapshotSplitsReportEvent.java b/flink-cdc-base/src/main/java/com/ververica/cdc/connectors/base/source/meta/events/FinishedSnapshotSplitsReportEvent.java index d0b30781d..10f235f5a 100644 --- a/flink-cdc-base/src/main/java/com/ververica/cdc/connectors/base/source/meta/events/FinishedSnapshotSplitsReportEvent.java +++ b/flink-cdc-base/src/main/java/com/ververica/cdc/connectors/base/source/meta/events/FinishedSnapshotSplitsReportEvent.java @@ -27,8 +27,8 @@ import com.ververica.cdc.connectors.base.source.reader.JdbcIncrementalSourceRead import java.util.Map; /** - * The {@link SourceEvent} that {@link IncrementalSourceEnumerator} sends to {@link - * JdbcIncrementalSourceReader} to notify the snapshot split has read finished with the consistent + * The {@link SourceEvent} that {@link JdbcIncrementalSourceReader} sends to {@link + * IncrementalSourceEnumerator} to notify the snapshot split has read finished with the consistent * binlog position. */ public class FinishedSnapshotSplitsReportEvent implements SourceEvent { diff --git a/flink-cdc-base/src/main/java/com/ververica/cdc/connectors/base/source/meta/events/StreamSplitMetaEvent.java b/flink-cdc-base/src/main/java/com/ververica/cdc/connectors/base/source/meta/events/StreamSplitMetaEvent.java index bbc89d078..21bdc30d8 100644 --- a/flink-cdc-base/src/main/java/com/ververica/cdc/connectors/base/source/meta/events/StreamSplitMetaEvent.java +++ b/flink-cdc-base/src/main/java/com/ververica/cdc/connectors/base/source/meta/events/StreamSplitMetaEvent.java @@ -28,7 +28,7 @@ import java.util.List; /** * The {@link SourceEvent} that {@link IncrementalSourceEnumerator} sends to {@link - * JdbcIncrementalSourceReader} to pass binlog meta data, i.e. {@link FinishedSnapshotSplitInfo}. + * JdbcIncrementalSourceReader} to pass binlog metadata, i.e. {@link FinishedSnapshotSplitInfo}. */ public class StreamSplitMetaEvent implements SourceEvent { @@ -36,10 +36,10 @@ public class StreamSplitMetaEvent implements SourceEvent { private final String splitId; - /** The meta data of binlog split is divided to multiple groups. */ + /** The metadata of binlog split is divided to multiple groups. */ private final int metaGroupId; /** - * The serialized meta data of binlog split, it's serialized/deserialize by {@link + * The serialized metadata of binlog split, it's serialized/deserialized by {@link * FinishedSnapshotSplitInfo#serialize()} and {@link * FinishedSnapshotSplitInfo#deserialize(byte[])}. */ diff --git a/flink-cdc-base/src/main/java/com/ververica/cdc/connectors/base/source/meta/events/StreamSplitMetaRequestEvent.java b/flink-cdc-base/src/main/java/com/ververica/cdc/connectors/base/source/meta/events/StreamSplitMetaRequestEvent.java index 486bf38f8..20237a58a 100644 --- a/flink-cdc-base/src/main/java/com/ververica/cdc/connectors/base/source/meta/events/StreamSplitMetaRequestEvent.java +++ b/flink-cdc-base/src/main/java/com/ververica/cdc/connectors/base/source/meta/events/StreamSplitMetaRequestEvent.java @@ -24,8 +24,8 @@ import com.ververica.cdc.connectors.base.source.enumerator.IncrementalSourceEnum import com.ververica.cdc.connectors.base.source.reader.JdbcIncrementalSourceReader; /** - * The {@link SourceEvent} that {@link IncrementalSourceEnumerator} sends to {@link - * JdbcIncrementalSourceReader} to pull binlog meta data, i.e. sending {@link StreamSplitMetaEvent}. + * The {@link SourceEvent} that {@link JdbcIncrementalSourceReader} sends to {@link + * IncrementalSourceEnumerator} to pull binlog metadata, i.e. sending {@link StreamSplitMetaEvent}. */ public class StreamSplitMetaRequestEvent implements SourceEvent { diff --git a/flink-cdc-base/src/main/java/com/ververica/cdc/connectors/base/source/meta/offset/Offset.java b/flink-cdc-base/src/main/java/com/ververica/cdc/connectors/base/source/meta/offset/Offset.java index 92e4dcef7..2065c2e1d 100644 --- a/flink-cdc-base/src/main/java/com/ververica/cdc/connectors/base/source/meta/offset/Offset.java +++ b/flink-cdc-base/src/main/java/com/ververica/cdc/connectors/base/source/meta/offset/Offset.java @@ -27,11 +27,11 @@ import java.util.Map; import java.util.Objects; /** - * A structure describes a fine grained offset in a binlog event including binlog position and gtid + * A structure describes a fine-grained offset in a binlog event including binlog position and gtid * set etc. * *

This structure can also be used to deal the binlog event in transaction, a transaction may - * contains multiple change events, and each change event may contain multiple rows. When restart + * contain multiple change events, and each change event may contain multiple rows. When restart * from a specific {@link Offset}, we need to skip the processed change events and the processed * rows. */ diff --git a/flink-cdc-base/src/main/java/com/ververica/cdc/connectors/base/source/meta/split/SnapshotSplit.java b/flink-cdc-base/src/main/java/com/ververica/cdc/connectors/base/source/meta/split/SnapshotSplit.java index 7e3df3a83..40b6be816 100644 --- a/flink-cdc-base/src/main/java/com/ververica/cdc/connectors/base/source/meta/split/SnapshotSplit.java +++ b/flink-cdc-base/src/main/java/com/ververica/cdc/connectors/base/source/meta/split/SnapshotSplit.java @@ -40,7 +40,7 @@ public class SnapshotSplit extends SourceSplitBase { @Nullable private final Object[] splitStart; @Nullable private final Object[] splitEnd; - /** The high watermark is not bull when the split read finished. */ + /** The high watermark is not null when the split read finished. */ @Nullable private final Offset highWatermark; @Nullable transient byte[] serializedFormCache; diff --git a/flink-cdc-base/src/main/java/com/ververica/cdc/connectors/base/source/meta/split/SnapshotSplitState.java b/flink-cdc-base/src/main/java/com/ververica/cdc/connectors/base/source/meta/split/SnapshotSplitState.java index 181cf734d..959f19b5c 100644 --- a/flink-cdc-base/src/main/java/com/ververica/cdc/connectors/base/source/meta/split/SnapshotSplitState.java +++ b/flink-cdc-base/src/main/java/com/ververica/cdc/connectors/base/source/meta/split/SnapshotSplitState.java @@ -22,7 +22,7 @@ import com.ververica.cdc.connectors.base.source.meta.offset.Offset; import javax.annotation.Nullable; -/** The state of split to describe the binlog of MySql table(s). */ +/** The state of split to describe the snapshot of table(s). */ public class SnapshotSplitState extends SourceSplitState { @Nullable private Offset highWatermark; @@ -56,11 +56,6 @@ public class SnapshotSplitState extends SourceSplitState { @Override public String toString() { - return "MySqlSnapshotSplitState{" - + "highWatermark=" - + highWatermark - + ", split=" - + split - + '}'; + return "SnapshotSplitState{highWatermark=" + highWatermark + ", split=" + split + '}'; } } diff --git a/flink-cdc-base/src/main/java/com/ververica/cdc/connectors/base/source/meta/split/StreamSplit.java b/flink-cdc-base/src/main/java/com/ververica/cdc/connectors/base/source/meta/split/StreamSplit.java index 4aed04c93..de6cf6a5f 100644 --- a/flink-cdc-base/src/main/java/com/ververica/cdc/connectors/base/source/meta/split/StreamSplit.java +++ b/flink-cdc-base/src/main/java/com/ververica/cdc/connectors/base/source/meta/split/StreamSplit.java @@ -122,7 +122,7 @@ public class StreamSplit extends SourceSplitBase { } // ------------------------------------------------------------------- - // factory utils to build new MySqlBinlogSplit instance + // factory utils to build new StreamSplit instance // ------------------------------------------------------------------- public static StreamSplit appendFinishedSplitInfos( StreamSplit binlogSplit, List splitInfos) { diff --git a/flink-cdc-base/src/main/java/com/ververica/cdc/connectors/base/source/meta/split/StreamSplitState.java b/flink-cdc-base/src/main/java/com/ververica/cdc/connectors/base/source/meta/split/StreamSplitState.java index 4f0d0f408..5e41912f1 100644 --- a/flink-cdc-base/src/main/java/com/ververica/cdc/connectors/base/source/meta/split/StreamSplitState.java +++ b/flink-cdc-base/src/main/java/com/ververica/cdc/connectors/base/source/meta/split/StreamSplitState.java @@ -80,7 +80,7 @@ public class StreamSplitState extends SourceSplitState { @Override public String toString() { - return "MySqlBinlogSplitState{" + return "StreamSplitState{" + "startingOffset=" + startingOffset + ", endingOffset=" diff --git a/flink-cdc-base/src/main/java/com/ververica/cdc/connectors/base/source/reader/external/JdbcSourceScanFetcher.java b/flink-cdc-base/src/main/java/com/ververica/cdc/connectors/base/source/reader/external/JdbcSourceScanFetcher.java index 6ac8cf6e5..35c0abb3e 100644 --- a/flink-cdc-base/src/main/java/com/ververica/cdc/connectors/base/source/reader/external/JdbcSourceScanFetcher.java +++ b/flink-cdc-base/src/main/java/com/ververica/cdc/connectors/base/source/reader/external/JdbcSourceScanFetcher.java @@ -87,7 +87,7 @@ public class JdbcSourceScanFetcher implements Fetcher