Skip to content

Commit af53758

Browse files
Linsiyuan9Linsiyuan9
authored
KAFKA-17814 Use final declaration to replace the suppression this-escape (apache#17613)
Reviewers: Chia-Ping Tsai <[email protected]>
1 parent 908dfa3 commit af53758

File tree

49 files changed

+58
-108
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

49 files changed

+58
-108
lines changed

‎clients/src/main/java/org/apache/kafka/clients/consumer/internals/OffsetsRequestManager.java

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@
7777
* {@link ConsumerMetadata}, so this implements {@link ClusterResourceListener} to get notified
7878
* when the cluster metadata is updated.
7979
*/
80-
public class OffsetsRequestManager implements RequestManager, ClusterResourceListener {
80+
public final class OffsetsRequestManager implements RequestManager, ClusterResourceListener {
8181

8282
private final ConsumerMetadata metadata;
8383
private final IsolationLevel isolationLevel;
@@ -109,7 +109,6 @@ public class OffsetsRequestManager implements RequestManager, ClusterResourceLis
109109
*/
110110
private PendingFetchCommittedRequest pendingOffsetFetchEvent;
111111

112-
@SuppressWarnings("this-escape")
113112
public OffsetsRequestManager(final SubscriptionState subscriptionState,
114113
final ConsumerMetadata metadata,
115114
final IsolationLevel isolationLevel,

‎clients/src/main/java/org/apache/kafka/clients/consumer/internals/metrics/ConsumerRebalanceMetricsManager.java

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@
3232
import static org.apache.kafka.clients.consumer.internals.ConsumerUtils.CONSUMER_METRIC_GROUP_PREFIX;
3333
import static org.apache.kafka.clients.consumer.internals.ConsumerUtils.COORDINATOR_METRICS_SUFFIX;
3434

35-
public class ConsumerRebalanceMetricsManager extends RebalanceMetricsManager {
35+
public final class ConsumerRebalanceMetricsManager extends RebalanceMetricsManager {
3636
private final Sensor successfulRebalanceSensor;
3737
private final Sensor failedRebalanceSensor;
3838

@@ -47,7 +47,6 @@ public class ConsumerRebalanceMetricsManager extends RebalanceMetricsManager {
4747
private long lastRebalanceEndMs = -1L;
4848
private long lastRebalanceStartMs = -1L;
4949

50-
@SuppressWarnings("this-escape")
5150
public ConsumerRebalanceMetricsManager(Metrics metrics) {
5251
super(CONSUMER_METRIC_GROUP_PREFIX + COORDINATOR_METRICS_SUFFIX);
5352

‎clients/src/main/java/org/apache/kafka/clients/consumer/internals/metrics/ShareRebalanceMetricsManager.java

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,14 +28,13 @@
2828
import static org.apache.kafka.clients.consumer.internals.ConsumerUtils.CONSUMER_SHARE_METRIC_GROUP_PREFIX;
2929
import static org.apache.kafka.clients.consumer.internals.ConsumerUtils.COORDINATOR_METRICS_SUFFIX;
3030

31-
public class ShareRebalanceMetricsManager extends RebalanceMetricsManager {
31+
public final class ShareRebalanceMetricsManager extends RebalanceMetricsManager {
3232
private final Sensor rebalanceSensor;
3333
public final MetricName rebalanceTotal;
3434
public final MetricName rebalanceRatePerHour;
3535
private long lastRebalanceEndMs = -1L;
3636
private long lastRebalanceStartMs = -1L;
3737

38-
@SuppressWarnings("this-escape")
3938
public ShareRebalanceMetricsManager(Metrics metrics) {
4039
super(CONSUMER_SHARE_METRIC_GROUP_PREFIX + COORDINATOR_METRICS_SUFFIX);
4140

‎clients/src/main/java/org/apache/kafka/common/metrics/Metrics.java

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@
6767
* sensor.record(messageSize);
6868
* </pre>
6969
*/
70-
public class Metrics implements Closeable {
70+
public final class Metrics implements Closeable {
7171

7272
private final MetricConfig config;
7373
private final ConcurrentMap<MetricName, KafkaMetric> metrics;
@@ -155,7 +155,6 @@ public Metrics(MetricConfig defaultConfig, List<MetricsReporter> reporters, Time
155155
* @param enableExpiration true if the metrics instance can garbage collect inactive sensors, false otherwise
156156
* @param metricsContext The metricsContext to initialize metrics reporter with
157157
*/
158-
@SuppressWarnings("this-escape")
159158
public Metrics(MetricConfig defaultConfig, List<MetricsReporter> reporters, Time time, boolean enableExpiration,
160159
MetricsContext metricsContext) {
161160
this.config = defaultConfig;

‎clients/src/main/java/org/apache/kafka/common/protocol/types/Schema.java

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@
2424
/**
2525
* The schema for a compound record definition
2626
*/
27-
public class Schema extends Type {
27+
public final class Schema extends Type {
2828
private static final Object[] NO_VALUES = new Object[0];
2929

3030
private final BoundField[] fields;
@@ -53,7 +53,6 @@ public Schema(Field... fs) {
5353
*
5454
* @throws SchemaException If the given list have duplicate fields
5555
*/
56-
@SuppressWarnings("this-escape")
5756
public Schema(boolean tolerateMissingFieldsWithDefaults, Field... fs) {
5857
this.fields = new BoundField[fs.length];
5958
this.fieldsByName = new HashMap<>();

‎clients/src/main/java/org/apache/kafka/common/security/oauthbearer/internals/OAuthBearerSaslClientProvider.java

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,11 +22,10 @@
2222
import java.security.Provider;
2323
import java.security.Security;
2424

25-
public class OAuthBearerSaslClientProvider extends Provider {
25+
public final class OAuthBearerSaslClientProvider extends Provider {
2626
private static final long serialVersionUID = 1L;
2727

28-
@SuppressWarnings("this-escape")
29-
protected OAuthBearerSaslClientProvider() {
28+
private OAuthBearerSaslClientProvider() {
3029
super("SASL/OAUTHBEARER Client Provider", "1.0", "SASL/OAUTHBEARER Client Provider for Kafka");
3130
put("SaslClientFactory." + OAuthBearerLoginModule.OAUTHBEARER_MECHANISM,
3231
OAuthBearerSaslClientFactory.class.getName());

‎clients/src/main/java/org/apache/kafka/common/security/oauthbearer/internals/OAuthBearerSaslServerProvider.java

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,11 +22,10 @@
2222
import java.security.Provider;
2323
import java.security.Security;
2424

25-
public class OAuthBearerSaslServerProvider extends Provider {
25+
public final class OAuthBearerSaslServerProvider extends Provider {
2626
private static final long serialVersionUID = 1L;
2727

28-
@SuppressWarnings("this-escape")
29-
protected OAuthBearerSaslServerProvider() {
28+
private OAuthBearerSaslServerProvider() {
3029
super("SASL/OAUTHBEARER Server Provider", "1.0", "SASL/OAUTHBEARER Server Provider for Kafka");
3130
put("SaslServerFactory." + OAuthBearerLoginModule.OAUTHBEARER_MECHANISM,
3231
OAuthBearerSaslServerFactory.class.getName());

‎clients/src/main/java/org/apache/kafka/common/security/plain/internals/PlainSaslServerProvider.java

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,12 +21,11 @@
2121
import java.security.Provider;
2222
import java.security.Security;
2323

24-
public class PlainSaslServerProvider extends Provider {
24+
public final class PlainSaslServerProvider extends Provider {
2525

2626
private static final long serialVersionUID = 1L;
2727

28-
@SuppressWarnings("this-escape")
29-
protected PlainSaslServerProvider() {
28+
private PlainSaslServerProvider() {
3029
super("Simple SASL/PLAIN Server Provider", "1.0", "Simple SASL/PLAIN Server Provider for Kafka");
3130
put("SaslServerFactory." + PlainSaslServer.PLAIN_MECHANISM, PlainSaslServerFactory.class.getName());
3231
}

‎clients/src/main/java/org/apache/kafka/common/security/scram/internals/ScramSaslClientProvider.java

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,12 +21,11 @@
2121
import java.security.Provider;
2222
import java.security.Security;
2323

24-
public class ScramSaslClientProvider extends Provider {
24+
public final class ScramSaslClientProvider extends Provider {
2525

2626
private static final long serialVersionUID = 1L;
2727

28-
@SuppressWarnings("this-escape")
29-
protected ScramSaslClientProvider() {
28+
private ScramSaslClientProvider() {
3029
super("SASL/SCRAM Client Provider", "1.0", "SASL/SCRAM Client Provider for Kafka");
3130
for (ScramMechanism mechanism : ScramMechanism.values())
3231
put("SaslClientFactory." + mechanism.mechanismName(), ScramSaslClientFactory.class.getName());

‎clients/src/main/java/org/apache/kafka/common/security/scram/internals/ScramSaslServerProvider.java

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,12 +21,11 @@
2121
import java.security.Provider;
2222
import java.security.Security;
2323

24-
public class ScramSaslServerProvider extends Provider {
24+
public final class ScramSaslServerProvider extends Provider {
2525

2626
private static final long serialVersionUID = 1L;
2727

28-
@SuppressWarnings("this-escape")
29-
protected ScramSaslServerProvider() {
28+
private ScramSaslServerProvider() {
3029
super("SASL/SCRAM Server Provider", "1.0", "SASL/SCRAM Server Provider for Kafka");
3130
for (ScramMechanism mechanism : ScramMechanism.values())
3231
put("SaslServerFactory." + mechanism.mechanismName(), ScramSaslServerFactory.class.getName());

‎clients/src/test/java/org/apache/kafka/clients/admin/MockAdminClient.java

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -129,7 +129,6 @@ public static class Builder {
129129
private Map<String, Short> maxSupportedFeatureLevels = Collections.emptyMap();
130130
private Map<String, String> defaultGroupConfigs = Collections.emptyMap();
131131

132-
@SuppressWarnings("this-escape")
133132
public Builder() {
134133
numBrokers(1);
135134
}
@@ -145,7 +144,7 @@ public Builder brokers(List<Node> brokers) {
145144
return this;
146145
}
147146

148-
public Builder numBrokers(int numBrokers) {
147+
public final Builder numBrokers(int numBrokers) {
149148
if (brokers.size() >= numBrokers) {
150149
brokers = brokers.subList(0, numBrokers);
151150
brokerLogDirs = brokerLogDirs.subList(0, numBrokers);
@@ -236,7 +235,6 @@ public MockAdminClient(List<Node> brokers, Node controller) {
236235
Collections.emptyMap());
237236
}
238237

239-
@SuppressWarnings("this-escape")
240238
private MockAdminClient(
241239
List<Node> brokers,
242240
Node controller,
@@ -274,7 +272,7 @@ private MockAdminClient(
274272
this.maxSupportedFeatureLevels = new HashMap<>(maxSupportedFeatureLevels);
275273
}
276274

277-
public synchronized void controller(Node controller) {
275+
public final synchronized void controller(Node controller) {
278276
if (!brokers.contains(controller))
279277
throw new IllegalArgumentException("The controller node must be in the list of brokers");
280278
this.controller = controller;

‎clients/src/test/java/org/apache/kafka/common/network/NioEchoServer.java

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@
6161
* with the configured security protocol.
6262
*
6363
*/
64-
public class NioEchoServer extends Thread {
64+
public final class NioEchoServer extends Thread {
6565
private static final Logger LOG = LoggerFactory.getLogger(NioEchoServer.class);
6666

6767
public enum MetricType {
@@ -103,7 +103,6 @@ public NioEchoServer(ListenerName listenerName, SecurityProtocol securityProtoco
103103
new DelegationTokenCache(ScramMechanism.mechanismNames()));
104104
}
105105

106-
@SuppressWarnings("this-escape")
107106
public NioEchoServer(ListenerName listenerName, SecurityProtocol securityProtocol, AbstractConfig config,
108107
String serverHost, ChannelBuilder channelBuilder, CredentialCache credentialCache,
109108
int failedAuthenticationDelayMs, Time time, DelegationTokenCache tokenCache) throws Exception {

‎clients/src/test/java/org/apache/kafka/common/network/PlaintextSender.java

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,9 +23,8 @@
2323
/**
2424
* test helper class that will connect to a given server address, write out the given payload and disconnect
2525
*/
26-
public class PlaintextSender extends Thread {
26+
public final class PlaintextSender extends Thread {
2727

28-
@SuppressWarnings("this-escape")
2928
public PlaintextSender(final InetSocketAddress serverAddress, final byte[] payload) {
3029
super(() -> {
3130
try (Socket connection = new Socket(serverAddress.getAddress(), serverAddress.getPort());

‎clients/src/test/java/org/apache/kafka/common/network/SslSender.java

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,14 +27,13 @@
2727
import javax.net.ssl.TrustManager;
2828
import javax.net.ssl.X509TrustManager;
2929

30-
public class SslSender extends Thread {
30+
public final class SslSender extends Thread {
3131

3232
private final String tlsProtocol;
3333
private final InetSocketAddress serverAddress;
3434
private final byte[] payload;
3535
private final CountDownLatch handshaked = new CountDownLatch(1);
3636

37-
@SuppressWarnings("this-escape")
3837
public SslSender(String tlsProtocol, InetSocketAddress serverAddress, byte[] payload) {
3938
this.tlsProtocol = tlsProtocol;
4039
this.serverAddress = serverAddress;

‎clients/src/test/java/org/apache/kafka/common/security/ssl/DefaultSslEngineFactoryTest.java

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,6 @@
3434
import static org.junit.jupiter.api.Assertions.assertNotNull;
3535
import static org.junit.jupiter.api.Assertions.assertNull;
3636

37-
@SuppressWarnings("this-escape")
3837
public class DefaultSslEngineFactoryTest {
3938

4039
/*
@@ -196,7 +195,7 @@ public class DefaultSslEngineFactoryTest {
196195

197196
private static final Password KEY_PASSWORD = new Password("key-password");
198197

199-
private DefaultSslEngineFactory factory = sslEngineFactory();
198+
private DefaultSslEngineFactory factory;
200199
Map<String, Object> configs = new HashMap<>();
201200

202201
@BeforeEach

‎clients/src/test/java/org/apache/kafka/common/security/ssl/mock/TestProvider.java

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818

1919
import java.security.Provider;
2020

21-
public class TestProvider extends Provider {
21+
public final class TestProvider extends Provider {
2222

2323
private static final String KEY_MANAGER_FACTORY = String.format("KeyManagerFactory.%s", TestKeyManagerFactory.ALGORITHM);
2424
private static final String TRUST_MANAGER_FACTORY = String.format("TrustManagerFactory.%s", TestTrustManagerFactory.ALGORITHM);
@@ -27,8 +27,7 @@ public TestProvider() {
2727
this("TestProvider", "0.1", "provider for test cases");
2828
}
2929

30-
@SuppressWarnings("this-escape")
31-
protected TestProvider(String name, String version, String info) {
30+
private TestProvider(String name, String version, String info) {
3231
super(name, version, info);
3332
super.put(KEY_MANAGER_FACTORY, TestKeyManagerFactory.class.getName());
3433
super.put(TRUST_MANAGER_FACTORY, TestTrustManagerFactory.class.getName());

‎clients/src/test/java/org/apache/kafka/common/utils/MockScheduler.java

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@
2929
import java.util.concurrent.Future;
3030
import java.util.concurrent.ScheduledExecutorService;
3131

32-
public class MockScheduler implements Scheduler, MockTime.Listener {
32+
public final class MockScheduler implements Scheduler, MockTime.Listener {
3333
private static final Logger log = LoggerFactory.getLogger(MockScheduler.class);
3434

3535
/**
@@ -42,7 +42,6 @@ public class MockScheduler implements Scheduler, MockTime.Listener {
4242
*/
4343
private final TreeMap<Long, List<KafkaFutureImpl<Long>>> waiters = new TreeMap<>();
4444

45-
@SuppressWarnings("this-escape")
4645
public MockScheduler(MockTime time) {
4746
this.time = time;
4847
time.addListener(this);

‎connect/json/src/main/java/org/apache/kafka/connect/json/JsonConverterConfig.java

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@
2828
/**
2929
* Configuration options for {@link JsonConverter} instances.
3030
*/
31-
public class JsonConverterConfig extends ConverterConfig {
31+
public final class JsonConverterConfig extends ConverterConfig {
3232

3333
public static final String SCHEMAS_ENABLE_CONFIG = "schemas.enable";
3434
public static final boolean SCHEMAS_ENABLE_DEFAULT = true;
@@ -87,7 +87,6 @@ public static ConfigDef configDef() {
8787
private final DecimalFormat decimalFormat;
8888
private final boolean replaceNullWithDefault;
8989

90-
@SuppressWarnings("this-escape")
9190
public JsonConverterConfig(Map<String, ?> props) {
9291
super(CONFIG, props);
9392
this.schemasEnabled = getBoolean(SCHEMAS_ENABLE_CONFIG);

‎connect/mirror/src/main/java/org/apache/kafka/connect/mirror/MirrorMakerConfig.java

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@
5959
* --->%---
6060
* </pre>
6161
*/
62-
public class MirrorMakerConfig extends AbstractConfig {
62+
public final class MirrorMakerConfig extends AbstractConfig {
6363

6464
public static final String CLUSTERS_CONFIG = "clusters";
6565
private static final String CLUSTERS_DOC = "List of cluster aliases.";
@@ -89,7 +89,6 @@ public class MirrorMakerConfig extends AbstractConfig {
8989

9090
private final Map<String, String> rawProperties;
9191

92-
@SuppressWarnings("this-escape")
9392
public MirrorMakerConfig(Map<String, String> props) {
9493
super(config(), props, true);
9594
plugins = new Plugins(originalsStrings());

‎connect/runtime/src/main/java/org/apache/kafka/connect/runtime/SourceConnectorConfig.java

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -49,11 +49,11 @@
4949
import static org.apache.kafka.connect.source.SourceTask.TransactionBoundary.INTERVAL;
5050
import static org.apache.kafka.connect.source.SourceTask.TransactionBoundary.POLL;
5151

52-
public class SourceConnectorConfig extends ConnectorConfig {
52+
public final class SourceConnectorConfig extends ConnectorConfig {
5353

5454
private static final Logger log = LoggerFactory.getLogger(SourceConnectorConfig.class);
5555

56-
protected static final String TOPIC_CREATION_GROUP = "Topic Creation";
56+
static final String TOPIC_CREATION_GROUP = "Topic Creation";
5757

5858
public static final String TOPIC_CREATION_PREFIX = "topic.creation.";
5959

@@ -62,7 +62,7 @@ public class SourceConnectorConfig extends ConnectorConfig {
6262
+ "created by source connectors";
6363
private static final String TOPIC_CREATION_GROUPS_DISPLAY = "Topic Creation Groups";
6464

65-
protected static final String EXACTLY_ONCE_SUPPORT_GROUP = "Exactly Once Support";
65+
static final String EXACTLY_ONCE_SUPPORT_GROUP = "Exactly Once Support";
6666

6767
public enum ExactlyOnceSupportLevel {
6868
REQUESTED,
@@ -103,7 +103,7 @@ public String toString() {
103103
+ TRANSACTION_BOUNDARY_CONFIG + " is specified.";
104104
private static final String TRANSACTION_BOUNDARY_INTERVAL_DISPLAY = "Transaction boundary interval";
105105

106-
protected static final String OFFSETS_TOPIC_GROUP = "offsets.topic";
106+
static final String OFFSETS_TOPIC_GROUP = "offsets.topic";
107107

108108
public static final String OFFSETS_TOPIC_CONFIG = "offsets.storage.topic";
109109
private static final String OFFSETS_TOPIC_DOC = "The name of a separate offsets topic to use for this connector. "
@@ -248,7 +248,6 @@ public static ConfigDef enrich(ConfigDef baseConfigDef, Map<String, String> prop
248248
return newDef;
249249
}
250250

251-
@SuppressWarnings("this-escape")
252251
public SourceConnectorConfig(Plugins plugins, Map<String, String> props, boolean createTopics) {
253252
super(plugins, configDef(), props);
254253
if (createTopics && props.entrySet().stream().anyMatch(e -> e.getKey().startsWith(TOPIC_CREATION_PREFIX))) {

‎connect/runtime/src/main/java/org/apache/kafka/connect/runtime/Worker.java

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -134,14 +134,14 @@
134134
* Since each task has a dedicated thread, this is mainly just a container for them.
135135
* </p>
136136
*/
137-
public class Worker {
137+
public final class Worker {
138138

139139
public static final long CONNECTOR_GRACEFUL_SHUTDOWN_TIMEOUT_MS = TimeUnit.SECONDS.toMillis(5);
140140
public static final long EXECUTOR_SHUTDOWN_TERMINATION_TIMEOUT_MS = TimeUnit.SECONDS.toMillis(1);
141141

142142
private static final Logger log = LoggerFactory.getLogger(Worker.class);
143143

144-
protected Herder herder;
144+
Herder herder;
145145
private final ExecutorService executor;
146146
private final Time time;
147147
private final String workerId;
@@ -173,7 +173,6 @@ public Worker(
173173
this(workerId, time, plugins, config, globalOffsetBackingStore, Executors.newCachedThreadPool(), connectorClientConfigOverridePolicy, Admin::create);
174174
}
175175

176-
@SuppressWarnings("this-escape")
177176
Worker(
178177
String workerId,
179178
Time time,
@@ -222,7 +221,7 @@ public WorkerConfigTransformer configTransformer() {
222221
return workerConfigTransformer;
223222
}
224223

225-
protected Herder herder() {
224+
Herder herder() {
226225
return herder;
227226
}
228227

0 commit comments

Comments
 (0)