| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <title>MetricRegistry</title> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="MetricRegistry"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6,"i12":6,"i13":6,"i14":6,"i15":6,"i16":6,"i17":6,"i18":6,"i19":9,"i20":9,"i21":6,"i22":6,"i23":38,"i24":6,"i25":6,"i26":6,"i27":6}; |
| var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],8:["t4","Concrete Methods"],32:["t6","Deprecated Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../org/eclipse/microprofile/metrics/MetricFilter.html" title="interface in org.eclipse.microprofile.metrics"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/eclipse/microprofile/metrics/MetricRegistry.Type.html" title="enum in org.eclipse.microprofile.metrics"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/eclipse/microprofile/metrics/MetricRegistry.html" target="_top">Frames</a></li> |
| <li><a href="MetricRegistry.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li><a href="#nested.class.summary">Nested</a> | </li> |
| <li>Field | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.eclipse.microprofile.metrics</div> |
| <h2 title="Class MetricRegistry" class="title">Class MetricRegistry</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.eclipse.microprofile.metrics.MetricRegistry</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre>public abstract class <span class="typeNameLabel">MetricRegistry</span> |
| extends java.lang.Object</pre> |
| <div class="block">The registry that stores metrics and their metadata. |
| The MetricRegistry provides methods to register, create and retrieve metrics and their respective metadata.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/eclipse/microprofile/metrics/MetricFilter.html" title="interface in org.eclipse.microprofile.metrics"><code>MetricFilter</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="nested.class.summary"> |
| <!-- --> |
| </a> |
| <h3>Nested Class Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> |
| <caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Class and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/microprofile/metrics/MetricRegistry.Type.html" title="enum in org.eclipse.microprofile.metrics">MetricRegistry.Type</a></span></code> |
| <div class="block">An enumeration representing the scopes of the MetricRegistry</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colOne" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/eclipse/microprofile/metrics/MetricRegistry.html#MetricRegistry--">MetricRegistry</a></span>()</code> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>abstract <a href="../../../../org/eclipse/microprofile/metrics/Counter.html" title="interface in org.eclipse.microprofile.metrics">Counter</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/microprofile/metrics/MetricRegistry.html#counter-org.eclipse.microprofile.metrics.Metadata-">counter</a></span>(<a href="../../../../org/eclipse/microprofile/metrics/Metadata.html" title="class in org.eclipse.microprofile.metrics">Metadata</a> metadata)</code> |
| <div class="block">Return the <a href="../../../../org/eclipse/microprofile/metrics/Counter.html" title="interface in org.eclipse.microprofile.metrics"><code>Counter</code></a> registered under the <a href="../../../../org/eclipse/microprofile/metrics/Metadata.html" title="class in org.eclipse.microprofile.metrics"><code>Metadata</code></a>'s name; or create and register |
| a new <a href="../../../../org/eclipse/microprofile/metrics/Counter.html" title="interface in org.eclipse.microprofile.metrics"><code>Counter</code></a> if none is registered.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>abstract <a href="../../../../org/eclipse/microprofile/metrics/Counter.html" title="interface in org.eclipse.microprofile.metrics">Counter</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/microprofile/metrics/MetricRegistry.html#counter-java.lang.String-">counter</a></span>(java.lang.String name)</code> |
| <div class="block">Return the <a href="../../../../org/eclipse/microprofile/metrics/Counter.html" title="interface in org.eclipse.microprofile.metrics"><code>Counter</code></a> registered under this name; or create and register |
| a new <a href="../../../../org/eclipse/microprofile/metrics/Counter.html" title="interface in org.eclipse.microprofile.metrics"><code>Counter</code></a> if none is registered.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>abstract java.util.SortedMap<java.lang.String,<a href="../../../../org/eclipse/microprofile/metrics/Counter.html" title="interface in org.eclipse.microprofile.metrics">Counter</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/microprofile/metrics/MetricRegistry.html#getCounters--">getCounters</a></span>()</code> |
| <div class="block">Returns a map of all the counters in the registry and their names.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>abstract java.util.SortedMap<java.lang.String,<a href="../../../../org/eclipse/microprofile/metrics/Counter.html" title="interface in org.eclipse.microprofile.metrics">Counter</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/microprofile/metrics/MetricRegistry.html#getCounters-org.eclipse.microprofile.metrics.MetricFilter-">getCounters</a></span>(<a href="../../../../org/eclipse/microprofile/metrics/MetricFilter.html" title="interface in org.eclipse.microprofile.metrics">MetricFilter</a> filter)</code> |
| <div class="block">Returns a map of all the counters in the registry and their names which match the given |
| filter.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>abstract java.util.SortedMap<java.lang.String,<a href="../../../../org/eclipse/microprofile/metrics/Gauge.html" title="interface in org.eclipse.microprofile.metrics">Gauge</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/microprofile/metrics/MetricRegistry.html#getGauges--">getGauges</a></span>()</code> |
| <div class="block">Returns a map of all the gauges in the registry and their names.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>abstract java.util.SortedMap<java.lang.String,<a href="../../../../org/eclipse/microprofile/metrics/Gauge.html" title="interface in org.eclipse.microprofile.metrics">Gauge</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/microprofile/metrics/MetricRegistry.html#getGauges-org.eclipse.microprofile.metrics.MetricFilter-">getGauges</a></span>(<a href="../../../../org/eclipse/microprofile/metrics/MetricFilter.html" title="interface in org.eclipse.microprofile.metrics">MetricFilter</a> filter)</code> |
| <div class="block">Returns a map of all the gauges in the registry and their names which match the given filter.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>abstract java.util.SortedMap<java.lang.String,<a href="../../../../org/eclipse/microprofile/metrics/Histogram.html" title="interface in org.eclipse.microprofile.metrics">Histogram</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/microprofile/metrics/MetricRegistry.html#getHistograms--">getHistograms</a></span>()</code> |
| <div class="block">Returns a map of all the histograms in the registry and their names.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>abstract java.util.SortedMap<java.lang.String,<a href="../../../../org/eclipse/microprofile/metrics/Histogram.html" title="interface in org.eclipse.microprofile.metrics">Histogram</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/microprofile/metrics/MetricRegistry.html#getHistograms-org.eclipse.microprofile.metrics.MetricFilter-">getHistograms</a></span>(<a href="../../../../org/eclipse/microprofile/metrics/MetricFilter.html" title="interface in org.eclipse.microprofile.metrics">MetricFilter</a> filter)</code> |
| <div class="block">Returns a map of all the histograms in the registry and their names which match the given |
| filter.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>abstract java.util.Map<java.lang.String,<a href="../../../../org/eclipse/microprofile/metrics/Metadata.html" title="class in org.eclipse.microprofile.metrics">Metadata</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/microprofile/metrics/MetricRegistry.html#getMetadata--">getMetadata</a></span>()</code> |
| <div class="block">Returns a map of all the metadata in the registry and their names.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>abstract java.util.SortedMap<java.lang.String,<a href="../../../../org/eclipse/microprofile/metrics/Meter.html" title="interface in org.eclipse.microprofile.metrics">Meter</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/microprofile/metrics/MetricRegistry.html#getMeters--">getMeters</a></span>()</code> |
| <div class="block">Returns a map of all the meters in the registry and their names.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>abstract java.util.SortedMap<java.lang.String,<a href="../../../../org/eclipse/microprofile/metrics/Meter.html" title="interface in org.eclipse.microprofile.metrics">Meter</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/microprofile/metrics/MetricRegistry.html#getMeters-org.eclipse.microprofile.metrics.MetricFilter-">getMeters</a></span>(<a href="../../../../org/eclipse/microprofile/metrics/MetricFilter.html" title="interface in org.eclipse.microprofile.metrics">MetricFilter</a> filter)</code> |
| <div class="block">Returns a map of all the meters in the registry and their names which match the given filter.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code>abstract java.util.Map<java.lang.String,<a href="../../../../org/eclipse/microprofile/metrics/Metric.html" title="interface in org.eclipse.microprofile.metrics">Metric</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/microprofile/metrics/MetricRegistry.html#getMetrics--">getMetrics</a></span>()</code> |
| <div class="block">Returns a map of all the metrics in the registry and their names.</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code>abstract java.util.SortedSet<java.lang.String></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/microprofile/metrics/MetricRegistry.html#getNames--">getNames</a></span>()</code> |
| <div class="block">Returns a set of the names of all the metrics in the registry.</div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code>abstract java.util.SortedMap<java.lang.String,<a href="../../../../org/eclipse/microprofile/metrics/Timer.html" title="interface in org.eclipse.microprofile.metrics">Timer</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/microprofile/metrics/MetricRegistry.html#getTimers--">getTimers</a></span>()</code> |
| <div class="block">Returns a map of all the timers in the registry and their names.</div> |
| </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code>abstract java.util.SortedMap<java.lang.String,<a href="../../../../org/eclipse/microprofile/metrics/Timer.html" title="interface in org.eclipse.microprofile.metrics">Timer</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/microprofile/metrics/MetricRegistry.html#getTimers-org.eclipse.microprofile.metrics.MetricFilter-">getTimers</a></span>(<a href="../../../../org/eclipse/microprofile/metrics/MetricFilter.html" title="interface in org.eclipse.microprofile.metrics">MetricFilter</a> filter)</code> |
| <div class="block">Returns a map of all the timers in the registry and their names which match the given filter.</div> |
| </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code>abstract <a href="../../../../org/eclipse/microprofile/metrics/Histogram.html" title="interface in org.eclipse.microprofile.metrics">Histogram</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/microprofile/metrics/MetricRegistry.html#histogram-org.eclipse.microprofile.metrics.Metadata-">histogram</a></span>(<a href="../../../../org/eclipse/microprofile/metrics/Metadata.html" title="class in org.eclipse.microprofile.metrics">Metadata</a> metadata)</code> |
| <div class="block">Return the <a href="../../../../org/eclipse/microprofile/metrics/Histogram.html" title="interface in org.eclipse.microprofile.metrics"><code>Histogram</code></a> registered under the <a href="../../../../org/eclipse/microprofile/metrics/Metadata.html" title="class in org.eclipse.microprofile.metrics"><code>Metadata</code></a>'s name; or create and register |
| a new <a href="../../../../org/eclipse/microprofile/metrics/Histogram.html" title="interface in org.eclipse.microprofile.metrics"><code>Histogram</code></a> if none is registered.</div> |
| </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code>abstract <a href="../../../../org/eclipse/microprofile/metrics/Histogram.html" title="interface in org.eclipse.microprofile.metrics">Histogram</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/microprofile/metrics/MetricRegistry.html#histogram-java.lang.String-">histogram</a></span>(java.lang.String name)</code> |
| <div class="block">Return the <a href="../../../../org/eclipse/microprofile/metrics/Histogram.html" title="interface in org.eclipse.microprofile.metrics"><code>Histogram</code></a> registered under this name; or create and register |
| a new <a href="../../../../org/eclipse/microprofile/metrics/Histogram.html" title="interface in org.eclipse.microprofile.metrics"><code>Histogram</code></a> if none is registered.</div> |
| </td> |
| </tr> |
| <tr id="i17" class="rowColor"> |
| <td class="colFirst"><code>abstract <a href="../../../../org/eclipse/microprofile/metrics/Meter.html" title="interface in org.eclipse.microprofile.metrics">Meter</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/microprofile/metrics/MetricRegistry.html#meter-org.eclipse.microprofile.metrics.Metadata-">meter</a></span>(<a href="../../../../org/eclipse/microprofile/metrics/Metadata.html" title="class in org.eclipse.microprofile.metrics">Metadata</a> metadata)</code> |
| <div class="block">Return the <a href="../../../../org/eclipse/microprofile/metrics/Meter.html" title="interface in org.eclipse.microprofile.metrics"><code>Meter</code></a> registered under the <a href="../../../../org/eclipse/microprofile/metrics/Metadata.html" title="class in org.eclipse.microprofile.metrics"><code>Metadata</code></a>'s name; or create and register |
| a new <a href="../../../../org/eclipse/microprofile/metrics/Meter.html" title="interface in org.eclipse.microprofile.metrics"><code>Meter</code></a> if none is registered.</div> |
| </td> |
| </tr> |
| <tr id="i18" class="altColor"> |
| <td class="colFirst"><code>abstract <a href="../../../../org/eclipse/microprofile/metrics/Meter.html" title="interface in org.eclipse.microprofile.metrics">Meter</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/microprofile/metrics/MetricRegistry.html#meter-java.lang.String-">meter</a></span>(java.lang.String name)</code> |
| <div class="block">Return the <a href="../../../../org/eclipse/microprofile/metrics/Meter.html" title="interface in org.eclipse.microprofile.metrics"><code>Meter</code></a> registered under this name; or create and register |
| a new <a href="../../../../org/eclipse/microprofile/metrics/Meter.html" title="interface in org.eclipse.microprofile.metrics"><code>Meter</code></a> if none is registered.</div> |
| </td> |
| </tr> |
| <tr id="i19" class="rowColor"> |
| <td class="colFirst"><code>static java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/microprofile/metrics/MetricRegistry.html#name-java.lang.Class-java.lang.String...-">name</a></span>(java.lang.Class<?> klass, |
| java.lang.String... names)</code> |
| <div class="block">Concatenates a class name and elements to form a dotted name, eliding any null values or |
| empty strings.</div> |
| </td> |
| </tr> |
| <tr id="i20" class="altColor"> |
| <td class="colFirst"><code>static java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/microprofile/metrics/MetricRegistry.html#name-java.lang.String-java.lang.String...-">name</a></span>(java.lang.String name, |
| java.lang.String... names)</code> |
| <div class="block">Concatenates elements to form a dotted name, eliding any null values or empty strings.</div> |
| </td> |
| </tr> |
| <tr id="i21" class="rowColor"> |
| <td class="colFirst"><code>abstract <T extends <a href="../../../../org/eclipse/microprofile/metrics/Metric.html" title="interface in org.eclipse.microprofile.metrics">Metric</a>><br>T</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/microprofile/metrics/MetricRegistry.html#register-org.eclipse.microprofile.metrics.Metadata-T-">register</a></span>(<a href="../../../../org/eclipse/microprofile/metrics/Metadata.html" title="class in org.eclipse.microprofile.metrics">Metadata</a> metadata, |
| T metric)</code> |
| <div class="block">Given a <a href="../../../../org/eclipse/microprofile/metrics/Metric.html" title="interface in org.eclipse.microprofile.metrics"><code>Metric</code></a>, registers it under the provided <a href="../../../../org/eclipse/microprofile/metrics/Metadata.html" title="class in org.eclipse.microprofile.metrics"><code>Metadata</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i22" class="altColor"> |
| <td class="colFirst"><code>abstract <T extends <a href="../../../../org/eclipse/microprofile/metrics/Metric.html" title="interface in org.eclipse.microprofile.metrics">Metric</a>><br>T</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/microprofile/metrics/MetricRegistry.html#register-java.lang.String-T-">register</a></span>(java.lang.String name, |
| T metric)</code> |
| <div class="block">Given a <a href="../../../../org/eclipse/microprofile/metrics/Metric.html" title="interface in org.eclipse.microprofile.metrics"><code>Metric</code></a>, registers it under the given name.</div> |
| </td> |
| </tr> |
| <tr id="i23" class="rowColor"> |
| <td class="colFirst"><code>abstract <T extends <a href="../../../../org/eclipse/microprofile/metrics/Metric.html" title="interface in org.eclipse.microprofile.metrics">Metric</a>><br>T</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/microprofile/metrics/MetricRegistry.html#register-java.lang.String-T-org.eclipse.microprofile.metrics.Metadata-">register</a></span>(java.lang.String name, |
| T metric, |
| <a href="../../../../org/eclipse/microprofile/metrics/Metadata.html" title="class in org.eclipse.microprofile.metrics">Metadata</a> metadata)</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="block"><span class="deprecationComment">As of version 1.1, use <a href="../../../../org/eclipse/microprofile/metrics/MetricRegistry.html#register-org.eclipse.microprofile.metrics.Metadata-T-"><code>register(Metadata, Metric)</code></a> instead</span></div> |
| </div> |
| </td> |
| </tr> |
| <tr id="i24" class="altColor"> |
| <td class="colFirst"><code>abstract boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/microprofile/metrics/MetricRegistry.html#remove-java.lang.String-">remove</a></span>(java.lang.String name)</code> |
| <div class="block">Removes the metric with the given name.</div> |
| </td> |
| </tr> |
| <tr id="i25" class="rowColor"> |
| <td class="colFirst"><code>abstract void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/microprofile/metrics/MetricRegistry.html#removeMatching-org.eclipse.microprofile.metrics.MetricFilter-">removeMatching</a></span>(<a href="../../../../org/eclipse/microprofile/metrics/MetricFilter.html" title="interface in org.eclipse.microprofile.metrics">MetricFilter</a> filter)</code> |
| <div class="block">Removes all metrics which match the given filter.</div> |
| </td> |
| </tr> |
| <tr id="i26" class="altColor"> |
| <td class="colFirst"><code>abstract <a href="../../../../org/eclipse/microprofile/metrics/Timer.html" title="interface in org.eclipse.microprofile.metrics">Timer</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/microprofile/metrics/MetricRegistry.html#timer-org.eclipse.microprofile.metrics.Metadata-">timer</a></span>(<a href="../../../../org/eclipse/microprofile/metrics/Metadata.html" title="class in org.eclipse.microprofile.metrics">Metadata</a> metadata)</code> |
| <div class="block">Return the <a href="../../../../org/eclipse/microprofile/metrics/Timer.html" title="interface in org.eclipse.microprofile.metrics"><code>Timer</code></a> registered under the <a href="../../../../org/eclipse/microprofile/metrics/Metadata.html" title="class in org.eclipse.microprofile.metrics"><code>Metadata</code></a>'s name; or create and register |
| a new <a href="../../../../org/eclipse/microprofile/metrics/Timer.html" title="interface in org.eclipse.microprofile.metrics"><code>Timer</code></a> if none is registered.</div> |
| </td> |
| </tr> |
| <tr id="i27" class="rowColor"> |
| <td class="colFirst"><code>abstract <a href="../../../../org/eclipse/microprofile/metrics/Timer.html" title="interface in org.eclipse.microprofile.metrics">Timer</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/microprofile/metrics/MetricRegistry.html#timer-java.lang.String-">timer</a></span>(java.lang.String name)</code> |
| <div class="block">Return the <a href="../../../../org/eclipse/microprofile/metrics/Timer.html" title="interface in org.eclipse.microprofile.metrics"><code>Timer</code></a> registered under this name; or create and register |
| a new <a href="../../../../org/eclipse/microprofile/metrics/Timer.html" title="interface in org.eclipse.microprofile.metrics"><code>Timer</code></a> if none is registered.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.Object</h3> |
| <code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="MetricRegistry--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>MetricRegistry</h4> |
| <pre>public MetricRegistry()</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="name-java.lang.String-java.lang.String...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>name</h4> |
| <pre>public static java.lang.String name(java.lang.String name, |
| java.lang.String... names)</pre> |
| <div class="block">Concatenates elements to form a dotted name, eliding any null values or empty strings.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - the first element of the name</dd> |
| <dd><code>names</code> - the remaining elements of the name</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>name</code> and <code>names</code> concatenated by periods</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="name-java.lang.Class-java.lang.String...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>name</h4> |
| <pre>public static java.lang.String name(java.lang.Class<?> klass, |
| java.lang.String... names)</pre> |
| <div class="block">Concatenates a class name and elements to form a dotted name, eliding any null values or |
| empty strings.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>klass</code> - the first element of the name</dd> |
| <dd><code>names</code> - the remaining elements of the name</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>klass</code> and <code>names</code> concatenated by periods</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="register-java.lang.String-org.eclipse.microprofile.metrics.Metric-"> |
| <!-- --> |
| </a><a name="register-java.lang.String-T-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>register</h4> |
| <pre>public abstract <T extends <a href="../../../../org/eclipse/microprofile/metrics/Metric.html" title="interface in org.eclipse.microprofile.metrics">Metric</a>> T register(java.lang.String name, |
| T metric) |
| throws java.lang.IllegalArgumentException</pre> |
| <div class="block">Given a <a href="../../../../org/eclipse/microprofile/metrics/Metric.html" title="interface in org.eclipse.microprofile.metrics"><code>Metric</code></a>, registers it under the given name. |
| A <a href="../../../../org/eclipse/microprofile/metrics/Metadata.html" title="class in org.eclipse.microprofile.metrics"><code>Metadata</code></a> object will be registered with the name and type.</div> |
| <dl> |
| <dt><span class="paramLabel">Type Parameters:</span></dt> |
| <dd><code>T</code> - the type of the metric</dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - the name of the metric</dd> |
| <dd><code>metric</code> - the metric</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>metric</code></dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.IllegalArgumentException</code> - if the name is already registered</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="register-java.lang.String-org.eclipse.microprofile.metrics.Metric-org.eclipse.microprofile.metrics.Metadata-"> |
| <!-- --> |
| </a><a name="register-java.lang.String-T-org.eclipse.microprofile.metrics.Metadata-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>register</h4> |
| <pre>@Deprecated |
| public abstract <T extends <a href="../../../../org/eclipse/microprofile/metrics/Metric.html" title="interface in org.eclipse.microprofile.metrics">Metric</a>> T register(java.lang.String name, |
| T metric, |
| <a href="../../../../org/eclipse/microprofile/metrics/Metadata.html" title="class in org.eclipse.microprofile.metrics">Metadata</a> metadata) |
| throws java.lang.IllegalArgumentException</pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">As of version 1.1, use <a href="../../../../org/eclipse/microprofile/metrics/MetricRegistry.html#register-org.eclipse.microprofile.metrics.Metadata-T-"><code>register(Metadata, Metric)</code></a> instead</span></div> |
| <div class="block">Given a <a href="../../../../org/eclipse/microprofile/metrics/Metric.html" title="interface in org.eclipse.microprofile.metrics"><code>Metric</code></a>, registers it under the given name along with the provided <a href="../../../../org/eclipse/microprofile/metrics/Metadata.html" title="class in org.eclipse.microprofile.metrics"><code>Metadata</code></a>.</div> |
| <dl> |
| <dt><span class="paramLabel">Type Parameters:</span></dt> |
| <dd><code>T</code> - the type of the metric</dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - the name of the metric</dd> |
| <dd><code>metric</code> - the metric</dd> |
| <dd><code>metadata</code> - the metadata</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>metric</code></dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.IllegalArgumentException</code> - if the name is already registered</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="register-org.eclipse.microprofile.metrics.Metadata-org.eclipse.microprofile.metrics.Metric-"> |
| <!-- --> |
| </a><a name="register-org.eclipse.microprofile.metrics.Metadata-T-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>register</h4> |
| <pre>public abstract <T extends <a href="../../../../org/eclipse/microprofile/metrics/Metric.html" title="interface in org.eclipse.microprofile.metrics">Metric</a>> T register(<a href="../../../../org/eclipse/microprofile/metrics/Metadata.html" title="class in org.eclipse.microprofile.metrics">Metadata</a> metadata, |
| T metric) |
| throws java.lang.IllegalArgumentException</pre> |
| <div class="block">Given a <a href="../../../../org/eclipse/microprofile/metrics/Metric.html" title="interface in org.eclipse.microprofile.metrics"><code>Metric</code></a>, registers it under the provided <a href="../../../../org/eclipse/microprofile/metrics/Metadata.html" title="class in org.eclipse.microprofile.metrics"><code>Metadata</code></a>.</div> |
| <dl> |
| <dt><span class="paramLabel">Type Parameters:</span></dt> |
| <dd><code>T</code> - the type of the metric</dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>metadata</code> - the metadata</dd> |
| <dd><code>metric</code> - the metric</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>metric</code></dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.IllegalArgumentException</code> - if the name is already registered</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.1</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="counter-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>counter</h4> |
| <pre>public abstract <a href="../../../../org/eclipse/microprofile/metrics/Counter.html" title="interface in org.eclipse.microprofile.metrics">Counter</a> counter(java.lang.String name)</pre> |
| <div class="block">Return the <a href="../../../../org/eclipse/microprofile/metrics/Counter.html" title="interface in org.eclipse.microprofile.metrics"><code>Counter</code></a> registered under this name; or create and register |
| a new <a href="../../../../org/eclipse/microprofile/metrics/Counter.html" title="interface in org.eclipse.microprofile.metrics"><code>Counter</code></a> if none is registered. |
| If a <a href="../../../../org/eclipse/microprofile/metrics/Counter.html" title="interface in org.eclipse.microprofile.metrics"><code>Counter</code></a> was created, a <a href="../../../../org/eclipse/microprofile/metrics/Metadata.html" title="class in org.eclipse.microprofile.metrics"><code>Metadata</code></a> object will be registered with the name and type.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - the name of the metric</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a new or pre-existing <a href="../../../../org/eclipse/microprofile/metrics/Counter.html" title="interface in org.eclipse.microprofile.metrics"><code>Counter</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="counter-org.eclipse.microprofile.metrics.Metadata-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>counter</h4> |
| <pre>public abstract <a href="../../../../org/eclipse/microprofile/metrics/Counter.html" title="interface in org.eclipse.microprofile.metrics">Counter</a> counter(<a href="../../../../org/eclipse/microprofile/metrics/Metadata.html" title="class in org.eclipse.microprofile.metrics">Metadata</a> metadata)</pre> |
| <div class="block">Return the <a href="../../../../org/eclipse/microprofile/metrics/Counter.html" title="interface in org.eclipse.microprofile.metrics"><code>Counter</code></a> registered under the <a href="../../../../org/eclipse/microprofile/metrics/Metadata.html" title="class in org.eclipse.microprofile.metrics"><code>Metadata</code></a>'s name; or create and register |
| a new <a href="../../../../org/eclipse/microprofile/metrics/Counter.html" title="interface in org.eclipse.microprofile.metrics"><code>Counter</code></a> if none is registered. |
| If a <a href="../../../../org/eclipse/microprofile/metrics/Counter.html" title="interface in org.eclipse.microprofile.metrics"><code>Counter</code></a> was created, the provided <a href="../../../../org/eclipse/microprofile/metrics/Metadata.html" title="class in org.eclipse.microprofile.metrics"><code>Metadata</code></a> object will be registered. |
| <p> |
| Note: The <a href="../../../../org/eclipse/microprofile/metrics/Metadata.html" title="class in org.eclipse.microprofile.metrics"><code>Metadata</code></a> will not be updated if the metric is already registered. |
| </p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>metadata</code> - the name of the metric</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a new or pre-existing <a href="../../../../org/eclipse/microprofile/metrics/Counter.html" title="interface in org.eclipse.microprofile.metrics"><code>Counter</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="histogram-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>histogram</h4> |
| <pre>public abstract <a href="../../../../org/eclipse/microprofile/metrics/Histogram.html" title="interface in org.eclipse.microprofile.metrics">Histogram</a> histogram(java.lang.String name)</pre> |
| <div class="block">Return the <a href="../../../../org/eclipse/microprofile/metrics/Histogram.html" title="interface in org.eclipse.microprofile.metrics"><code>Histogram</code></a> registered under this name; or create and register |
| a new <a href="../../../../org/eclipse/microprofile/metrics/Histogram.html" title="interface in org.eclipse.microprofile.metrics"><code>Histogram</code></a> if none is registered. |
| If a <a href="../../../../org/eclipse/microprofile/metrics/Histogram.html" title="interface in org.eclipse.microprofile.metrics"><code>Histogram</code></a> was created, a <a href="../../../../org/eclipse/microprofile/metrics/Metadata.html" title="class in org.eclipse.microprofile.metrics"><code>Metadata</code></a> object will be registered with the name and type.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - the name of the metric</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a new or pre-existing <a href="../../../../org/eclipse/microprofile/metrics/Histogram.html" title="interface in org.eclipse.microprofile.metrics"><code>Histogram</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="histogram-org.eclipse.microprofile.metrics.Metadata-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>histogram</h4> |
| <pre>public abstract <a href="../../../../org/eclipse/microprofile/metrics/Histogram.html" title="interface in org.eclipse.microprofile.metrics">Histogram</a> histogram(<a href="../../../../org/eclipse/microprofile/metrics/Metadata.html" title="class in org.eclipse.microprofile.metrics">Metadata</a> metadata)</pre> |
| <div class="block">Return the <a href="../../../../org/eclipse/microprofile/metrics/Histogram.html" title="interface in org.eclipse.microprofile.metrics"><code>Histogram</code></a> registered under the <a href="../../../../org/eclipse/microprofile/metrics/Metadata.html" title="class in org.eclipse.microprofile.metrics"><code>Metadata</code></a>'s name; or create and register |
| a new <a href="../../../../org/eclipse/microprofile/metrics/Histogram.html" title="interface in org.eclipse.microprofile.metrics"><code>Histogram</code></a> if none is registered. |
| If a <a href="../../../../org/eclipse/microprofile/metrics/Histogram.html" title="interface in org.eclipse.microprofile.metrics"><code>Histogram</code></a> was created, the provided <a href="../../../../org/eclipse/microprofile/metrics/Metadata.html" title="class in org.eclipse.microprofile.metrics"><code>Metadata</code></a> object will be registered. |
| <p> |
| Note: The <a href="../../../../org/eclipse/microprofile/metrics/Metadata.html" title="class in org.eclipse.microprofile.metrics"><code>Metadata</code></a> will not be updated if the metric is already registered. |
| </p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>metadata</code> - the name of the metric</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a new or pre-existing <a href="../../../../org/eclipse/microprofile/metrics/Histogram.html" title="interface in org.eclipse.microprofile.metrics"><code>Histogram</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="meter-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>meter</h4> |
| <pre>public abstract <a href="../../../../org/eclipse/microprofile/metrics/Meter.html" title="interface in org.eclipse.microprofile.metrics">Meter</a> meter(java.lang.String name)</pre> |
| <div class="block">Return the <a href="../../../../org/eclipse/microprofile/metrics/Meter.html" title="interface in org.eclipse.microprofile.metrics"><code>Meter</code></a> registered under this name; or create and register |
| a new <a href="../../../../org/eclipse/microprofile/metrics/Meter.html" title="interface in org.eclipse.microprofile.metrics"><code>Meter</code></a> if none is registered. |
| If a <a href="../../../../org/eclipse/microprofile/metrics/Meter.html" title="interface in org.eclipse.microprofile.metrics"><code>Meter</code></a> was created, a <a href="../../../../org/eclipse/microprofile/metrics/Metadata.html" title="class in org.eclipse.microprofile.metrics"><code>Metadata</code></a> object will be registered with the name and type.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - the name of the metric</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a new or pre-existing <a href="../../../../org/eclipse/microprofile/metrics/Meter.html" title="interface in org.eclipse.microprofile.metrics"><code>Meter</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="meter-org.eclipse.microprofile.metrics.Metadata-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>meter</h4> |
| <pre>public abstract <a href="../../../../org/eclipse/microprofile/metrics/Meter.html" title="interface in org.eclipse.microprofile.metrics">Meter</a> meter(<a href="../../../../org/eclipse/microprofile/metrics/Metadata.html" title="class in org.eclipse.microprofile.metrics">Metadata</a> metadata)</pre> |
| <div class="block">Return the <a href="../../../../org/eclipse/microprofile/metrics/Meter.html" title="interface in org.eclipse.microprofile.metrics"><code>Meter</code></a> registered under the <a href="../../../../org/eclipse/microprofile/metrics/Metadata.html" title="class in org.eclipse.microprofile.metrics"><code>Metadata</code></a>'s name; or create and register |
| a new <a href="../../../../org/eclipse/microprofile/metrics/Meter.html" title="interface in org.eclipse.microprofile.metrics"><code>Meter</code></a> if none is registered. |
| If a <a href="../../../../org/eclipse/microprofile/metrics/Meter.html" title="interface in org.eclipse.microprofile.metrics"><code>Meter</code></a> was created, the provided <a href="../../../../org/eclipse/microprofile/metrics/Metadata.html" title="class in org.eclipse.microprofile.metrics"><code>Metadata</code></a> object will be registered. |
| <p> |
| Note: The <a href="../../../../org/eclipse/microprofile/metrics/Metadata.html" title="class in org.eclipse.microprofile.metrics"><code>Metadata</code></a> will not be updated if the metric is already registered. |
| </p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>metadata</code> - the name of the metric</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a new or pre-existing <a href="../../../../org/eclipse/microprofile/metrics/Meter.html" title="interface in org.eclipse.microprofile.metrics"><code>Meter</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="timer-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>timer</h4> |
| <pre>public abstract <a href="../../../../org/eclipse/microprofile/metrics/Timer.html" title="interface in org.eclipse.microprofile.metrics">Timer</a> timer(java.lang.String name)</pre> |
| <div class="block">Return the <a href="../../../../org/eclipse/microprofile/metrics/Timer.html" title="interface in org.eclipse.microprofile.metrics"><code>Timer</code></a> registered under this name; or create and register |
| a new <a href="../../../../org/eclipse/microprofile/metrics/Timer.html" title="interface in org.eclipse.microprofile.metrics"><code>Timer</code></a> if none is registered. |
| If a <a href="../../../../org/eclipse/microprofile/metrics/Timer.html" title="interface in org.eclipse.microprofile.metrics"><code>Timer</code></a> was created, a <a href="../../../../org/eclipse/microprofile/metrics/Metadata.html" title="class in org.eclipse.microprofile.metrics"><code>Metadata</code></a> object will be registered with the name and type.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - the name of the metric</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a new or pre-existing <a href="../../../../org/eclipse/microprofile/metrics/Timer.html" title="interface in org.eclipse.microprofile.metrics"><code>Timer</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="timer-org.eclipse.microprofile.metrics.Metadata-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>timer</h4> |
| <pre>public abstract <a href="../../../../org/eclipse/microprofile/metrics/Timer.html" title="interface in org.eclipse.microprofile.metrics">Timer</a> timer(<a href="../../../../org/eclipse/microprofile/metrics/Metadata.html" title="class in org.eclipse.microprofile.metrics">Metadata</a> metadata)</pre> |
| <div class="block">Return the <a href="../../../../org/eclipse/microprofile/metrics/Timer.html" title="interface in org.eclipse.microprofile.metrics"><code>Timer</code></a> registered under the <a href="../../../../org/eclipse/microprofile/metrics/Metadata.html" title="class in org.eclipse.microprofile.metrics"><code>Metadata</code></a>'s name; or create and register |
| a new <a href="../../../../org/eclipse/microprofile/metrics/Timer.html" title="interface in org.eclipse.microprofile.metrics"><code>Timer</code></a> if none is registered. |
| If a <a href="../../../../org/eclipse/microprofile/metrics/Timer.html" title="interface in org.eclipse.microprofile.metrics"><code>Timer</code></a> was created, the provided <a href="../../../../org/eclipse/microprofile/metrics/Metadata.html" title="class in org.eclipse.microprofile.metrics"><code>Metadata</code></a> object will be registered. |
| <p> |
| Note: The <a href="../../../../org/eclipse/microprofile/metrics/Metadata.html" title="class in org.eclipse.microprofile.metrics"><code>Metadata</code></a> will not be updated if the metric is already registered. |
| </p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>metadata</code> - the name of the metric</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a new or pre-existing <a href="../../../../org/eclipse/microprofile/metrics/Timer.html" title="interface in org.eclipse.microprofile.metrics"><code>Timer</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="remove-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>remove</h4> |
| <pre>public abstract boolean remove(java.lang.String name)</pre> |
| <div class="block">Removes the metric with the given name.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - the name of the metric</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>whether or not the metric was removed</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="removeMatching-org.eclipse.microprofile.metrics.MetricFilter-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>removeMatching</h4> |
| <pre>public abstract void removeMatching(<a href="../../../../org/eclipse/microprofile/metrics/MetricFilter.html" title="interface in org.eclipse.microprofile.metrics">MetricFilter</a> filter)</pre> |
| <div class="block">Removes all metrics which match the given filter.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>filter</code> - a filter</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getNames--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getNames</h4> |
| <pre>public abstract java.util.SortedSet<java.lang.String> getNames()</pre> |
| <div class="block">Returns a set of the names of all the metrics in the registry.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the names of all the metrics</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getGauges--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getGauges</h4> |
| <pre>public abstract java.util.SortedMap<java.lang.String,<a href="../../../../org/eclipse/microprofile/metrics/Gauge.html" title="interface in org.eclipse.microprofile.metrics">Gauge</a>> getGauges()</pre> |
| <div class="block">Returns a map of all the gauges in the registry and their names.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>all the gauges in the registry</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getGauges-org.eclipse.microprofile.metrics.MetricFilter-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getGauges</h4> |
| <pre>public abstract java.util.SortedMap<java.lang.String,<a href="../../../../org/eclipse/microprofile/metrics/Gauge.html" title="interface in org.eclipse.microprofile.metrics">Gauge</a>> getGauges(<a href="../../../../org/eclipse/microprofile/metrics/MetricFilter.html" title="interface in org.eclipse.microprofile.metrics">MetricFilter</a> filter)</pre> |
| <div class="block">Returns a map of all the gauges in the registry and their names which match the given filter.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>filter</code> - the metric filter to match</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>all the gauges in the registry</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getCounters--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCounters</h4> |
| <pre>public abstract java.util.SortedMap<java.lang.String,<a href="../../../../org/eclipse/microprofile/metrics/Counter.html" title="interface in org.eclipse.microprofile.metrics">Counter</a>> getCounters()</pre> |
| <div class="block">Returns a map of all the counters in the registry and their names.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>all the counters in the registry</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getCounters-org.eclipse.microprofile.metrics.MetricFilter-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCounters</h4> |
| <pre>public abstract java.util.SortedMap<java.lang.String,<a href="../../../../org/eclipse/microprofile/metrics/Counter.html" title="interface in org.eclipse.microprofile.metrics">Counter</a>> getCounters(<a href="../../../../org/eclipse/microprofile/metrics/MetricFilter.html" title="interface in org.eclipse.microprofile.metrics">MetricFilter</a> filter)</pre> |
| <div class="block">Returns a map of all the counters in the registry and their names which match the given |
| filter.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>filter</code> - the metric filter to match</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>all the counters in the registry</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getHistograms--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getHistograms</h4> |
| <pre>public abstract java.util.SortedMap<java.lang.String,<a href="../../../../org/eclipse/microprofile/metrics/Histogram.html" title="interface in org.eclipse.microprofile.metrics">Histogram</a>> getHistograms()</pre> |
| <div class="block">Returns a map of all the histograms in the registry and their names.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>all the histograms in the registry</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getHistograms-org.eclipse.microprofile.metrics.MetricFilter-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getHistograms</h4> |
| <pre>public abstract java.util.SortedMap<java.lang.String,<a href="../../../../org/eclipse/microprofile/metrics/Histogram.html" title="interface in org.eclipse.microprofile.metrics">Histogram</a>> getHistograms(<a href="../../../../org/eclipse/microprofile/metrics/MetricFilter.html" title="interface in org.eclipse.microprofile.metrics">MetricFilter</a> filter)</pre> |
| <div class="block">Returns a map of all the histograms in the registry and their names which match the given |
| filter.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>filter</code> - the metric filter to match</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>all the histograms in the registry</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getMeters--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMeters</h4> |
| <pre>public abstract java.util.SortedMap<java.lang.String,<a href="../../../../org/eclipse/microprofile/metrics/Meter.html" title="interface in org.eclipse.microprofile.metrics">Meter</a>> getMeters()</pre> |
| <div class="block">Returns a map of all the meters in the registry and their names.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>all the meters in the registry</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getMeters-org.eclipse.microprofile.metrics.MetricFilter-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMeters</h4> |
| <pre>public abstract java.util.SortedMap<java.lang.String,<a href="../../../../org/eclipse/microprofile/metrics/Meter.html" title="interface in org.eclipse.microprofile.metrics">Meter</a>> getMeters(<a href="../../../../org/eclipse/microprofile/metrics/MetricFilter.html" title="interface in org.eclipse.microprofile.metrics">MetricFilter</a> filter)</pre> |
| <div class="block">Returns a map of all the meters in the registry and their names which match the given filter.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>filter</code> - the metric filter to match</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>all the meters in the registry</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getTimers--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getTimers</h4> |
| <pre>public abstract java.util.SortedMap<java.lang.String,<a href="../../../../org/eclipse/microprofile/metrics/Timer.html" title="interface in org.eclipse.microprofile.metrics">Timer</a>> getTimers()</pre> |
| <div class="block">Returns a map of all the timers in the registry and their names.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>all the timers in the registry</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getTimers-org.eclipse.microprofile.metrics.MetricFilter-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getTimers</h4> |
| <pre>public abstract java.util.SortedMap<java.lang.String,<a href="../../../../org/eclipse/microprofile/metrics/Timer.html" title="interface in org.eclipse.microprofile.metrics">Timer</a>> getTimers(<a href="../../../../org/eclipse/microprofile/metrics/MetricFilter.html" title="interface in org.eclipse.microprofile.metrics">MetricFilter</a> filter)</pre> |
| <div class="block">Returns a map of all the timers in the registry and their names which match the given filter.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>filter</code> - the metric filter to match</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>all the timers in the registry</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getMetrics--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMetrics</h4> |
| <pre>public abstract java.util.Map<java.lang.String,<a href="../../../../org/eclipse/microprofile/metrics/Metric.html" title="interface in org.eclipse.microprofile.metrics">Metric</a>> getMetrics()</pre> |
| <div class="block">Returns a map of all the metrics in the registry and their names.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>all the metrics in the registry</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getMetadata--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getMetadata</h4> |
| <pre>public abstract java.util.Map<java.lang.String,<a href="../../../../org/eclipse/microprofile/metrics/Metadata.html" title="class in org.eclipse.microprofile.metrics">Metadata</a>> getMetadata()</pre> |
| <div class="block">Returns a map of all the metadata in the registry and their names.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>all the metadata in the registry</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../org/eclipse/microprofile/metrics/MetricFilter.html" title="interface in org.eclipse.microprofile.metrics"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/eclipse/microprofile/metrics/MetricRegistry.Type.html" title="enum in org.eclipse.microprofile.metrics"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/eclipse/microprofile/metrics/MetricRegistry.html" target="_top">Frames</a></li> |
| <li><a href="MetricRegistry.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li><a href="#nested.class.summary">Nested</a> | </li> |
| <li>Field | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |
