From 23635ae0af50d4bd06a052d32afe13cf3b2b7871 Mon Sep 17 00:00:00 2001 From: David Chan Date: Tue, 28 Jun 2022 10:11:09 -0400 Subject: [PATCH] Doc + copyright --- .../microprofile/metrics/annotation/Gauge.java | 2 +- .../microprofile/metrics/annotation/Metric.java | 2 +- .../metrics/annotation/RegistryType.java | 15 ++++++++------- .../metrics/annotation/package-info.java | 10 +++++----- 4 files changed, 15 insertions(+), 14 deletions(-) diff --git a/api/src/main/java/org/eclipse/microprofile/metrics/annotation/Gauge.java b/api/src/main/java/org/eclipse/microprofile/metrics/annotation/Gauge.java index 3e97bb4b..cb58033c 100644 --- a/api/src/main/java/org/eclipse/microprofile/metrics/annotation/Gauge.java +++ b/api/src/main/java/org/eclipse/microprofile/metrics/annotation/Gauge.java @@ -1,6 +1,6 @@ /* ********************************************************************** - * Copyright (c) 2017 Contributors to the Eclipse Foundation + * Copyright (c) 2017, 2022 Contributors to the Eclipse Foundation * 2010-2013 Coda Hale, Yammer.com * * See the NOTICES file(s) distributed with this work for additional diff --git a/api/src/main/java/org/eclipse/microprofile/metrics/annotation/Metric.java b/api/src/main/java/org/eclipse/microprofile/metrics/annotation/Metric.java index b1880e85..41e95ef9 100644 --- a/api/src/main/java/org/eclipse/microprofile/metrics/annotation/Metric.java +++ b/api/src/main/java/org/eclipse/microprofile/metrics/annotation/Metric.java @@ -1,6 +1,6 @@ /* ********************************************************************** - * Copyright (c) 2017, 2019 Contributors to the Eclipse Foundation + * Copyright (c) 2017, 2022 Contributors to the Eclipse Foundation * 2012 Ryan W Tenney (ryan@10e.us) * * See the NOTICES file(s) distributed with this work for additional diff --git a/api/src/main/java/org/eclipse/microprofile/metrics/annotation/RegistryType.java b/api/src/main/java/org/eclipse/microprofile/metrics/annotation/RegistryType.java index 1acf3cdc..d22167b5 100644 --- a/api/src/main/java/org/eclipse/microprofile/metrics/annotation/RegistryType.java +++ b/api/src/main/java/org/eclipse/microprofile/metrics/annotation/RegistryType.java @@ -1,6 +1,6 @@ /* ********************************************************************** - * Copyright (c) 2017 Contributors to the Eclipse Foundation + * Copyright (c) 2017, 2022 Contributors to the Eclipse Foundation * * See the NOTICES file(s) distributed with this work for additional * information regarding copyright ownership. @@ -30,7 +30,7 @@ import org.eclipse.microprofile.metrics.MetricRegistry; /** - * The type of Metric Registry to inject. + * The scope of Metric Registry to inject. *

* This can be used to obtain the respective scoped {@link MetricRegistry}: *

@@ -38,17 +38,18 @@ *
  * 
  *      {@literal @}Inject
- *      {@literal @}RegistryType(type=MetricRegistry.APPLICATION_SCOPE)
+ *      {@literal @}RegistryType(scope=MetricRegistry.APPLICATION_SCOPE)
  *      MetricRegistry appRegistry;
  * 
  *      {@literal @}Inject
- *      {@literal @}RegistryType(type="customScope")
- *      MetricRegistry appRegistry;
+ *      {@literal @}RegistryType(scope="customScope")
+ *      MetricRegistry customRegistry;
+ * 
  * 
  * 
* * see {@link MetricRegistry.APPLICATION_SCOPE}, {@link MetricRegistry.BASE_SCOPE} and - * {@link MetricRegistry.VEDNOR_SCOPE} + * {@link MetricRegistry.VENDOR_SCOPE} * * @author Raymond Lam * @@ -64,7 +65,7 @@ * {@code application}, {@code base} and {@code vendor} scopes as part of the runtime. * * see {@link MetricRegistry.APPLICATION_SCOPE}, {@link MetricRegistry.BASE_SCOPE} and - * {@link MetricRegistry.VEDNOR_SCOPE} + * {@link MetricRegistry.VENDOR_SCOPE} */ String scope() default MetricRegistry.APPLICATION_SCOPE; } diff --git a/api/src/main/java/org/eclipse/microprofile/metrics/annotation/package-info.java b/api/src/main/java/org/eclipse/microprofile/metrics/annotation/package-info.java index bff683ea..653e7a26 100644 --- a/api/src/main/java/org/eclipse/microprofile/metrics/annotation/package-info.java +++ b/api/src/main/java/org/eclipse/microprofile/metrics/annotation/package-info.java @@ -70,17 +70,17 @@ * * * - *

CDI Qualifier

+ *

RegistryType annotation

*

* The {@link org.eclipse.microprofile.metrics.annotation.RegistryType RegistryType} is used to identify which - * MetricRegistry (Application, Base, or Vendor) should be injected. By default, no - * RegistryType will inject the application MetricRegistry. + * MetricRegistry (Application, Base, Vendor or a user defined scope) should be injected. By default + * no RegistryType will inject the application MetricRegistry. * *

  * 
  *      {@literal @}Inject
- *      {@literal @}RegistryType(type=MetricRegistry.BASE_SCOPE)
- *      MetricRegistry baseRegistry;
+ *      {@literal @}RegistryType(scope=MetricRegistry.APPLICATION_SCOPE)
+ *      MetricRegistry appRegistry;
  * 
  * 
*