This is an automated email from the ASF dual-hosted git repository.
aaronai pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/rocketmq-clients.git
The following commit(s) were added to refs/heads/master by this push:
new 444ed580 Add ExcludeFromJacocoGeneratedReport annotation (#441)
444ed580 is described below
commit 444ed580994c4a18d79e4f109d15254abba8c783
Author: Aaron Ai <[email protected]>
AuthorDate: Sat Apr 1 10:31:18 2023 +0800
Add ExcludeFromJacocoGeneratedReport annotation (#441)
---
.../apache/rocketmq/client/java/impl/Settings.java | 2 ++
.../java/impl/consumer/ProcessQueueImpl.java | 2 ++
.../java/impl/consumer/PushConsumerImpl.java | 2 ++
.../impl/consumer/PushSubscriptionSettings.java | 2 ++
.../impl/consumer/SimpleSubscriptionSettings.java | 2 ++
.../java/impl/producer/PublishingSettings.java | 2 ++
.../misc/ExcludeFromJacocoGeneratedReport.java | 35 ++++++++++++++++++++++
7 files changed, 47 insertions(+)
diff --git
a/java/client/src/main/java/org/apache/rocketmq/client/java/impl/Settings.java
b/java/client/src/main/java/org/apache/rocketmq/client/java/impl/Settings.java
index 17c2f794..f9923018 100644
---
a/java/client/src/main/java/org/apache/rocketmq/client/java/impl/Settings.java
+++
b/java/client/src/main/java/org/apache/rocketmq/client/java/impl/Settings.java
@@ -20,6 +20,7 @@ package org.apache.rocketmq.client.java.impl;
import com.google.common.base.MoreObjects;
import java.time.Duration;
import org.apache.rocketmq.client.java.misc.ClientId;
+import org.apache.rocketmq.client.java.misc.ExcludeFromJacocoGeneratedReport;
import org.apache.rocketmq.client.java.retry.RetryPolicy;
import org.apache.rocketmq.client.java.route.Endpoints;
@@ -51,6 +52,7 @@ public abstract class Settings {
return retryPolicy;
}
+ @ExcludeFromJacocoGeneratedReport
@Override
public String toString() {
return MoreObjects.toStringHelper(this)
diff --git
a/java/client/src/main/java/org/apache/rocketmq/client/java/impl/consumer/ProcessQueueImpl.java
b/java/client/src/main/java/org/apache/rocketmq/client/java/impl/consumer/ProcessQueueImpl.java
index ff4a13dc..a80f90a2 100644
---
a/java/client/src/main/java/org/apache/rocketmq/client/java/impl/consumer/ProcessQueueImpl.java
+++
b/java/client/src/main/java/org/apache/rocketmq/client/java/impl/consumer/ProcessQueueImpl.java
@@ -56,6 +56,7 @@ import org.apache.rocketmq.client.java.message.GeneralMessage;
import org.apache.rocketmq.client.java.message.GeneralMessageImpl;
import org.apache.rocketmq.client.java.message.MessageViewImpl;
import org.apache.rocketmq.client.java.misc.ClientId;
+import org.apache.rocketmq.client.java.misc.ExcludeFromJacocoGeneratedReport;
import org.apache.rocketmq.client.java.retry.RetryPolicy;
import org.apache.rocketmq.client.java.route.Endpoints;
import org.apache.rocketmq.client.java.route.MessageQueueImpl;
@@ -637,6 +638,7 @@ class ProcessQueueImpl implements ProcessQueue {
return cachedMessagesBytes.get();
}
+ @ExcludeFromJacocoGeneratedReport
public void doStats() {
final long receptionTimes = this.receptionTimes.getAndSet(0);
final long receivedMessagesQuantity =
this.receivedMessagesQuantity.getAndSet(0);
diff --git
a/java/client/src/main/java/org/apache/rocketmq/client/java/impl/consumer/PushConsumerImpl.java
b/java/client/src/main/java/org/apache/rocketmq/client/java/impl/consumer/PushConsumerImpl.java
index 277ad437..295367ac 100644
---
a/java/client/src/main/java/org/apache/rocketmq/client/java/impl/consumer/PushConsumerImpl.java
+++
b/java/client/src/main/java/org/apache/rocketmq/client/java/impl/consumer/PushConsumerImpl.java
@@ -68,6 +68,7 @@ import
org.apache.rocketmq.client.java.message.GeneralMessageImpl;
import org.apache.rocketmq.client.java.message.MessageViewImpl;
import org.apache.rocketmq.client.java.message.protocol.Resource;
import org.apache.rocketmq.client.java.metrics.GaugeObserver;
+import org.apache.rocketmq.client.java.misc.ExcludeFromJacocoGeneratedReport;
import org.apache.rocketmq.client.java.misc.ExecutorServices;
import org.apache.rocketmq.client.java.misc.ThreadFactoryImpl;
import org.apache.rocketmq.client.java.retry.RetryPolicy;
@@ -541,6 +542,7 @@ class PushConsumerImpl extends ConsumerImpl implements
PushConsumer {
return future;
}
+ @ExcludeFromJacocoGeneratedReport
@Override
public void doStats() {
final long receptionTimes = this.receptionTimes.getAndSet(0);
diff --git
a/java/client/src/main/java/org/apache/rocketmq/client/java/impl/consumer/PushSubscriptionSettings.java
b/java/client/src/main/java/org/apache/rocketmq/client/java/impl/consumer/PushSubscriptionSettings.java
index adb45fc0..70338b0c 100644
---
a/java/client/src/main/java/org/apache/rocketmq/client/java/impl/consumer/PushSubscriptionSettings.java
+++
b/java/client/src/main/java/org/apache/rocketmq/client/java/impl/consumer/PushSubscriptionSettings.java
@@ -34,6 +34,7 @@ import org.apache.rocketmq.client.java.impl.Settings;
import org.apache.rocketmq.client.java.impl.UserAgent;
import org.apache.rocketmq.client.java.message.protocol.Resource;
import org.apache.rocketmq.client.java.misc.ClientId;
+import org.apache.rocketmq.client.java.misc.ExcludeFromJacocoGeneratedReport;
import org.apache.rocketmq.client.java.retry.CustomizedBackoffRetryPolicy;
import org.apache.rocketmq.client.java.retry.ExponentialBackoffRetryPolicy;
import org.apache.rocketmq.client.java.route.Endpoints;
@@ -124,6 +125,7 @@ public class PushSubscriptionSettings extends Settings {
}
}
+ @ExcludeFromJacocoGeneratedReport
@Override
public String toString() {
return MoreObjects.toStringHelper(this)
diff --git
a/java/client/src/main/java/org/apache/rocketmq/client/java/impl/consumer/SimpleSubscriptionSettings.java
b/java/client/src/main/java/org/apache/rocketmq/client/java/impl/consumer/SimpleSubscriptionSettings.java
index cadf6e89..0ee02edb 100644
---
a/java/client/src/main/java/org/apache/rocketmq/client/java/impl/consumer/SimpleSubscriptionSettings.java
+++
b/java/client/src/main/java/org/apache/rocketmq/client/java/impl/consumer/SimpleSubscriptionSettings.java
@@ -33,6 +33,7 @@ import org.apache.rocketmq.client.java.impl.Settings;
import org.apache.rocketmq.client.java.impl.UserAgent;
import org.apache.rocketmq.client.java.message.protocol.Resource;
import org.apache.rocketmq.client.java.misc.ClientId;
+import org.apache.rocketmq.client.java.misc.ExcludeFromJacocoGeneratedReport;
import org.apache.rocketmq.client.java.route.Endpoints;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
@@ -93,6 +94,7 @@ public class SimpleSubscriptionSettings extends Settings {
}
}
+ @ExcludeFromJacocoGeneratedReport
@Override
public String toString() {
return MoreObjects.toStringHelper(this)
diff --git
a/java/client/src/main/java/org/apache/rocketmq/client/java/impl/producer/PublishingSettings.java
b/java/client/src/main/java/org/apache/rocketmq/client/java/impl/producer/PublishingSettings.java
index a4c5e629..f1605c33 100644
---
a/java/client/src/main/java/org/apache/rocketmq/client/java/impl/producer/PublishingSettings.java
+++
b/java/client/src/main/java/org/apache/rocketmq/client/java/impl/producer/PublishingSettings.java
@@ -28,6 +28,7 @@ import org.apache.rocketmq.client.java.impl.ClientType;
import org.apache.rocketmq.client.java.impl.Settings;
import org.apache.rocketmq.client.java.impl.UserAgent;
import org.apache.rocketmq.client.java.misc.ClientId;
+import org.apache.rocketmq.client.java.misc.ExcludeFromJacocoGeneratedReport;
import org.apache.rocketmq.client.java.retry.ExponentialBackoffRetryPolicy;
import org.apache.rocketmq.client.java.retry.RetryPolicy;
import org.apache.rocketmq.client.java.route.Endpoints;
@@ -85,6 +86,7 @@ public class PublishingSettings extends Settings {
this.maxBodySizeBytes = publishing.getMaxBodySize();
}
+ @ExcludeFromJacocoGeneratedReport
@Override
public String toString() {
return MoreObjects.toStringHelper(this)
diff --git
a/java/client/src/main/java/org/apache/rocketmq/client/java/misc/ExcludeFromJacocoGeneratedReport.java
b/java/client/src/main/java/org/apache/rocketmq/client/java/misc/ExcludeFromJacocoGeneratedReport.java
new file mode 100644
index 00000000..5f8c142e
--- /dev/null
+++
b/java/client/src/main/java/org/apache/rocketmq/client/java/misc/ExcludeFromJacocoGeneratedReport.java
@@ -0,0 +1,35 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.apache.rocketmq.client.java.misc;
+
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+/**
+ * This annotation is used to exclude a specific method from being included in
the code coverage
+ * report generated by Jacoco. It should be applied at the method level, and
indicates that the
+ * annotated method should be excluded from the code coverage report. The
annotation is implemented
+ * with a retention policy of RUNTIME, allowing it to be read at runtime. The
annotation target is
+ * set to METHOD, indicating that it can only be applied to methods.
+ */
+@Retention(RetentionPolicy.RUNTIME)
+@Target(ElementType.METHOD)
+public @interface ExcludeFromJacocoGeneratedReport {
+}
