Skip to content

Commit

Permalink
Bump MP Parent to 3.1 + automatic changes from building
Browse files Browse the repository at this point in the history
  • Loading branch information
Channyboy committed Apr 24, 2023
1 parent 06c1125 commit 4691aa2
Show file tree
Hide file tree
Showing 20 changed files with 69 additions and 69 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@

/**
* A gauge metric is an instantaneous reading of a particular value. To instrument a queue's depth, for example:<br>
*
*
* <pre>
* <code>
* final Queue&lt;String&gt; queue = new ConcurrentLinkedQueue&lt;String&gt;();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ public interface MetricRegistry {

/**
* An enumeration representing the provided scopes of the MetricRegistry.
*
*
* @deprecated As of release 5.0, please use {@link MetricRegistry#APPLICATION_SCOPE},
* {@link MetricRegistry#BASE_SCOPE} or {@link MetricRegistry#VENDOR_SCOPE} with {@link RegistryScope}
* instead.
Expand All @@ -56,7 +56,7 @@ enum Type {
/**
* The Application (default) scoped MetricRegistry. Any metric registered/accessed via CDI will use this
* MetricRegistry.
*
*
* @deprecated As of release 5.0, please use {@link MetricRegistry#APPLICATION_SCOPE} with {@link RegistryScope}
* instead.
*/
Expand All @@ -66,7 +66,7 @@ enum Type {
/**
* The Base scoped MetricRegistry. This MetricRegistry will contain required metrics specified in the
* MicroProfile Metrics specification.
*
*
* @deprecated As of release 5.0, please use {@link MetricRegistry#BASE_SCOPE} with {@link RegistryScope}
* instead.
*/
Expand All @@ -76,7 +76,7 @@ enum Type {
/**
* The Vendor scoped MetricRegistry. This MetricRegistry will contain vendor provided metrics which may vary
* between different vendors.
*
*
* @deprecated As of release 5.0, please use {@link MetricRegistry#VENDOR_SCOPE} with {@link RegistryScope}
* instead.
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -68,15 +68,15 @@ public abstract class Snapshot {

/**
* Represents a percentile and its value at the moment it was sampled from the Snapshot.
*
*
* See {@link #percentileValue()}
*/
public static class PercentileValue {
private final double percentile;
private final double value;

/**
*
*
* @param percentile
* percentile
* @param value
Expand All @@ -89,7 +89,7 @@ public PercentileValue(double percentile, double value) {

/**
* Returns percentile
*
*
* @return double percentile
*/
public double getPercentile() {
Expand All @@ -98,7 +98,7 @@ public double getPercentile() {

/**
* Returns value at percentile
*
*
* @return double value at percentile
*/
public double getValue() {
Expand Down
4 changes: 2 additions & 2 deletions api/src/main/java/org/eclipse/microprofile/metrics/Timer.java
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ interface Context extends Closeable {
/**
* Updates the timer with the difference between current and start time. Call to this method will not reset the
* start time. Multiple calls result in multiple updates.
*
*
* @return the elapsed time in nanoseconds
*/
long stop();
Expand Down Expand Up @@ -92,7 +92,7 @@ interface Context extends Closeable {
/**
* Returns the total elapsed timing durations of all completed timing events that are recorded with
* {@link #update(Duration)}.
*
*
* @return the elapsed time {@link java.time.Duration duration}
*/
Duration getElapsedTime();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@
* <p>
* Given a method annotated with {@literal @}Counted like this:
* </p>
*
*
* <pre>
* <code>
* {@literal @}Counted(name = "fancyName")
Expand All @@ -51,15 +51,15 @@
* }
* </code>
* </pre>
*
*
* A counter with the fully qualified class name + {@code fancyName} will be created and each time the
* {@code #fancyName(String)} method is invoked, the counter will be marked. Similarly, the same applies for a
* constructor annotated with counted.
*
* <p>
* Given a class annotated with {@literal @}Counted like this:
* </p>
*
*
* <pre>
* <code>
* {@literal @}Counted
Expand All @@ -69,7 +69,7 @@
* }
* </code>
* </pre>
*
*
* A counter for the defining class will be created for each of the constructors/methods. Each time the
* constructor/method is invoked, the respective counter will be marked.
*
Expand All @@ -88,15 +88,15 @@

/**
* The name of the counter.
*
*
* @return The name of the counter.
*/
@Nonbinding
String name() default "";

/**
* The tags of the counter.
*
*
* @return The tags of the counter. Each {@code String} tag must be in the form of 'key=value'. If the input is
* empty or does not contain a '=' sign, the entry is ignored.
*
Expand All @@ -107,7 +107,7 @@

/**
* Denotes whether to use the absolute name or use the default given name relative to the annotated class.
*
*
* @return If {@code true}, use the given name as an absolute name. If {@code false} (default), use the given name
* relative to the annotated class. When annotating a class, this must be {@code false}.
*/
Expand All @@ -116,7 +116,7 @@

/**
* The description of the counter.
*
*
* @return The description of the counter.
*
* @see org.eclipse.microprofile.metrics.Metadata
Expand All @@ -126,7 +126,7 @@

/**
* The unit of the counter.
*
*
* @return The unit of the counter. By default, the value is {@link MetricUnits#NONE}.
*
* @see org.eclipse.microprofile.metrics.Metadata
Expand All @@ -137,7 +137,7 @@

/**
* The scope that this counter belongs to.
*
*
* @return The scope this counter belongs to. By default, the value is {@link MetricRegistry#APPLICATION_SCOPE}.
*
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@
* <p>
* Given a method annotated with {@literal @}Gauge like this:
* </p>
*
*
* <pre>
* <code>
* {@literal @}Gauge(name = "queueSize")
Expand All @@ -48,10 +48,10 @@
* }
* </code>
* </pre>
*
*
* A gauge with the fully qualified class name + {@code queueSize} will be created which uses the annotated method's
* return value as its value.
*
*
* The annotated method/field must be of numeric type (extends {@link java.lang.Number}).
*
*/
Expand All @@ -62,15 +62,15 @@

/**
* The name of the gauge.
*
*
* @return The name of the gauge.
*/
@Nonbinding
String name() default "";

/**
* The tags of the gauge.
*
*
* @return The tags of the gauge. Each {@code String} tag must be in the form of 'key=value'. If the input is empty
* or does not contain a '=' sign, the entry is ignored.
*
Expand All @@ -81,7 +81,7 @@

/**
* Denotes whether to use the absolute name or use the default given name relative to the annotated class.
*
*
* @return If {@code true}, use the given name as an absolute name. If {@code false} (default), use the given name
* relative to the annotated class.
*/
Expand All @@ -90,7 +90,7 @@

/**
* The description of the gauge.
*
*
* @return The description of the gauge.
*
* @see org.eclipse.microprofile.metrics.Metadata
Expand All @@ -100,7 +100,7 @@

/**
* The unit of the gauge.
*
*
* @return (Required) The unit of the gauge.
*
* @see org.eclipse.microprofile.metrics.Metadata
Expand All @@ -111,7 +111,7 @@

/**
* The scope that this gauge belongs to.
*
*
* @return The scope this gauge belongs to. By default, the value is {@link MetricRegistry#APPLICATION_SCOPE}.
*
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,15 +37,15 @@
* MetricRegistry.
*
* Given an injected field annotated with {@literal @}Metric like this:
*
*
* <pre>
* <code>
* {@literal @}Inject
* {@literal @}Metric(name="histogram")
* public Histogram histogram;
* </code>
* </pre>
*
*
* A meter of the field's type will be created and injected into managed objects. It will be up to the user to interact
* with the metric. This annotation can be used on fields of type Meter, Timer, SimpleTimer, Counter, and Histogram.
* <p>
Expand All @@ -58,15 +58,15 @@

/**
* The name of the metric.
*
*
* @return The name of the metric.
*/
@Nonbinding
String name() default "";

/**
* The tags of the metric.
*
*
* @return The tags of the metric. Each {@code String} tag must be in the form of 'key=value'. If the input is empty
* or does not contain a '=' sign, the entry is ignored.
*
Expand All @@ -77,7 +77,7 @@

/**
* Denotes whether to use the absolute name or use the default given name relative to the annotated class.
*
*
* @return If {@code true}, use the given name as an absolute name. If {@code false} (default), use the given name
* relative to the annotated class.
*/
Expand All @@ -86,7 +86,7 @@

/**
* The description of the metric.
*
*
* @return The description of the metric.
*
* @see org.eclipse.microprofile.metrics.Metadata
Expand All @@ -96,7 +96,7 @@

/**
* The unit of the metric.
*
*
* @return The unit of the metric. By default, the value is {@link MetricUnits#NONE}.
*
* @see org.eclipse.microprofile.metrics.Metadata
Expand All @@ -107,7 +107,7 @@

/**
* The scope that this metric belongs to.
*
*
* @return The scope this metric belongs to. By default, the value is {@link MetricRegistry#APPLICATION_SCOPE}.
*
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,17 +34,17 @@
* <p>
* This can be used to obtain the respective scoped {@link MetricRegistry}:
* </p>
*
*
* <pre>
* <code>
* {@literal @}Inject
* {@literal @}RegistryScope(scope=MetricRegistry.APPLICATION_SCOPE)
* MetricRegistry appRegistry;
*
*
* {@literal @}Inject
* {@literal @}RegistryScope(scope="customScope")
* MetricRegistry customRegistry;
*
*
* </code>
* </pre>
*
Expand All @@ -60,11 +60,11 @@
public @interface RegistryScope {
/**
* The scope of the MetricRegistry.
*
*
* @return Indicates the scope of the MetricRegistry to be injected. The MicroProfile runtimes provides
* {@code application}, {@code base} and {@code vendor} scopes automatically and creates user-defined scopes
* as needed.
*
*
* see {@link MetricRegistry#APPLICATION_SCOPE}, {@link MetricRegistry#BASE_SCOPE} and
* {@link MetricRegistry#VENDOR_SCOPE}
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@
* <p>
* This can be used to obtain the respective scoped {@link MetricRegistry}:
* </p>
*
*
* <pre>
* <code>
* {@literal @}Inject
Expand All @@ -48,7 +48,7 @@
* @see org.eclipse.microprofile.metrics.MetricRegistry.Type
*
* @author Raymond Lam
*
*
* @deprecated As of rlease 5.0, please use {@link RegistryScope} instead
*
*/
Expand All @@ -60,7 +60,7 @@
public @interface RegistryType {
/**
* The scope of the MetricRegistry.
*
*
* @return Returns the scope of the MetricRegistry. The {@link MetricRegistry.Type} can be {@code APPLICATION},
* {@code BASE}, or {@code VENDOR}.
* @see org.eclipse.microprofile.metrics.MetricRegistry.Type
Expand Down
Loading

0 comments on commit 4691aa2

Please sign in to comment.