| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <title>MetricID</title> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../script.js"></script> |
| |
| <link rel="shortcut icon" href="/img/microprofile-favicon.png"> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="MetricID"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete 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.html" title="interface 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/MetricID.html" target="_top">Frames</a></li> |
| <li><a href="MetricID.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>Nested | </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 MetricID" class="title">Class MetricID</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.eclipse.microprofile.metrics.MetricID</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd>java.lang.Comparable<<a href="../../../../org/eclipse/microprofile/metrics/MetricID.html" title="class in org.eclipse.microprofile.metrics">MetricID</a>></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public class <span class="typeNameLabel">MetricID</span> |
| extends java.lang.Object |
| implements java.lang.Comparable<<a href="../../../../org/eclipse/microprofile/metrics/MetricID.html" title="class in org.eclipse.microprofile.metrics">MetricID</a>></pre> |
| <div class="block">A unique identifier for <a href="../../../../org/eclipse/microprofile/metrics/Metric.html" title="interface in org.eclipse.microprofile.metrics"><code>Metric</code></a> and <a href="../../../../org/eclipse/microprofile/metrics/Metadata.html" title="interface in org.eclipse.microprofile.metrics"><code>Metadata</code></a> that are registered in the <a href="../../../../org/eclipse/microprofile/metrics/MetricRegistry.html" title="interface in org.eclipse.microprofile.metrics"><code>MetricRegistry</code></a> |
| |
| The MetricID contains: |
| <ul> |
| <li><code>Name</code>: (Required) The name of the metric.</li> |
| <li><code>Tags</code>: (Optional) The tags (represented by <a href="../../../../org/eclipse/microprofile/metrics/Tag.html" title="class in org.eclipse.microprofile.metrics"><code>Tag</code></a> objects) of the metric. The tag name must match the |
| regex `[a-zA-Z_][a-zA-Z0-9_]*` (Ascii alphabet, numbers and underscore). The tag value may contain any UTF-8 encoded |
| character.</li> |
| </ul></div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== 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/MetricID.html#MetricID-java.lang.String-">MetricID</a></span>(java.lang.String name)</code> |
| <div class="block">Constructs a MetricID with the given metric name and no tags.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/eclipse/microprofile/metrics/MetricID.html#MetricID-java.lang.String-org.eclipse.microprofile.metrics.Tag...-">MetricID</a></span>(java.lang.String name, |
| <a href="../../../../org/eclipse/microprofile/metrics/Tag.html" title="class in org.eclipse.microprofile.metrics">Tag</a>... tags)</code> |
| <div class="block">Constructs a MetricID with the given metric name and <a href="../../../../org/eclipse/microprofile/metrics/Tag.html" title="class in org.eclipse.microprofile.metrics"><code>Tag</code></a>s.</div> |
| </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="t2" class="tableTab"><span><a href="javascript:show(2);">Instance 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></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>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/microprofile/metrics/MetricID.html#compareTo-org.eclipse.microprofile.metrics.MetricID-">compareTo</a></span>(<a href="../../../../org/eclipse/microprofile/metrics/MetricID.html" title="class in org.eclipse.microprofile.metrics">MetricID</a> other)</code> |
| <div class="block">Compares two MetricID objects through the following steps: <br> |
| |
| Compares the names of the two MetricIDs lexicographically. |
| If the names are equal: Compare the number of tags. |
| If the tag lengths are equal: Compare the Tags (sorted by the Tag's key value) |
| |
| a) Compare the Tag names/keys lexicographically |
| b) If keys are equal, compare the Tag values lexicographically |
| |
| |
| </div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/microprofile/metrics/MetricID.html#equals-java.lang.Object-">equals</a></span>(java.lang.Object o)</code></td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/microprofile/metrics/MetricID.html#getName--">getName</a></span>()</code> |
| <div class="block">Returns the Metric name associated with this MetricID</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>java.util.Map<java.lang.String,java.lang.String></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/microprofile/metrics/MetricID.html#getTags--">getTags</a></span>()</code> |
| <div class="block">Returns the underlying map containing the tags.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/eclipse/microprofile/metrics/Tag.html" title="class in org.eclipse.microprofile.metrics">Tag</a>[]</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/microprofile/metrics/MetricID.html#getTagsAsArray--">getTagsAsArray</a></span>()</code> |
| <div class="block">Gets the list of tags as an array of <a href="../../../../org/eclipse/microprofile/metrics/Tag.html" title="class in org.eclipse.microprofile.metrics"><code>Tag</code></a> objects.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>java.util.List<<a href="../../../../org/eclipse/microprofile/metrics/Tag.html" title="class in org.eclipse.microprofile.metrics">Tag</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/microprofile/metrics/MetricID.html#getTagsAsList--">getTagsAsList</a></span>()</code> |
| <div class="block">Gets the list of tags as a list of <a href="../../../../org/eclipse/microprofile/metrics/Tag.html" title="class in org.eclipse.microprofile.metrics"><code>Tag</code></a> objects</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/microprofile/metrics/MetricID.html#getTagsAsString--">getTagsAsString</a></span>()</code> |
| <div class="block">Gets the list of tags as a single String in the format 'key="value",key2="value2",...'</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/microprofile/metrics/MetricID.html#hashCode--">hashCode</a></span>()</code></td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/microprofile/metrics/MetricID.html#toString--">toString</a></span>()</code> </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, finalize, getClass, notify, notifyAll, 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="MetricID-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>MetricID</h4> |
| <pre>public MetricID(java.lang.String name)</pre> |
| <div class="block">Constructs a MetricID with the given metric name and no tags. If global tags are available then they will be |
| appended to this MetricID.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - the name of the metric</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="MetricID-java.lang.String-org.eclipse.microprofile.metrics.Tag...-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>MetricID</h4> |
| <pre>public MetricID(java.lang.String name, |
| <a href="../../../../org/eclipse/microprofile/metrics/Tag.html" title="class in org.eclipse.microprofile.metrics">Tag</a>... tags)</pre> |
| <div class="block">Constructs a MetricID with the given metric name and <a href="../../../../org/eclipse/microprofile/metrics/Tag.html" title="class in org.eclipse.microprofile.metrics"><code>Tag</code></a>s. If global tags are available then they will be |
| appended to this MetricID</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - the name of the metric</dd> |
| <dd><code>tags</code> - the tags associated with this metric</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="getName--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getName</h4> |
| <pre>public java.lang.String getName()</pre> |
| <div class="block">Returns the Metric name associated with this MetricID</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the Metric name associated with this MetricID</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getTags--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getTags</h4> |
| <pre>public java.util.Map<java.lang.String,java.lang.String> getTags()</pre> |
| <div class="block">Returns the underlying map containing the tags.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a <code>Map</code> of tags</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getTagsAsString--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getTagsAsString</h4> |
| <pre>public java.lang.String getTagsAsString()</pre> |
| <div class="block">Gets the list of tags as a single String in the format 'key="value",key2="value2",...'</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a String containing the tags</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getTagsAsList--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getTagsAsList</h4> |
| <pre>public java.util.List<<a href="../../../../org/eclipse/microprofile/metrics/Tag.html" title="class in org.eclipse.microprofile.metrics">Tag</a>> getTagsAsList()</pre> |
| <div class="block">Gets the list of tags as a list of <a href="../../../../org/eclipse/microprofile/metrics/Tag.html" title="class in org.eclipse.microprofile.metrics"><code>Tag</code></a> objects</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a a list of Tag objects</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getTagsAsArray--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getTagsAsArray</h4> |
| <pre>public <a href="../../../../org/eclipse/microprofile/metrics/Tag.html" title="class in org.eclipse.microprofile.metrics">Tag</a>[] getTagsAsArray()</pre> |
| <div class="block">Gets the list of tags as an array of <a href="../../../../org/eclipse/microprofile/metrics/Tag.html" title="class in org.eclipse.microprofile.metrics"><code>Tag</code></a> objects.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>An array of tags</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="equals-java.lang.Object-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>equals</h4> |
| <pre>public boolean equals(java.lang.Object o)</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code>equals</code> in class <code>java.lang.Object</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="hashCode--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>hashCode</h4> |
| <pre>public int hashCode()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code>hashCode</code> in class <code>java.lang.Object</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="toString--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>toString</h4> |
| <pre>public java.lang.String toString()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code>toString</code> in class <code>java.lang.Object</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="compareTo-org.eclipse.microprofile.metrics.MetricID-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>compareTo</h4> |
| <pre>public int compareTo(<a href="../../../../org/eclipse/microprofile/metrics/MetricID.html" title="class in org.eclipse.microprofile.metrics">MetricID</a> other)</pre> |
| <div class="block">Compares two MetricID objects through the following steps: <br> |
| <ol> |
| <li>Compares the names of the two MetricIDs lexicographically.</li> |
| <li>If the names are equal: Compare the number of tags.</li> |
| <li>If the tag lengths are equal: Compare the Tags (sorted by the Tag's key value) |
| <ul> |
| <li>a) Compare the Tag names/keys lexicographically</li> |
| <li>b) If keys are equal, compare the Tag values lexicographically</li> |
| </ul> |
| </li> |
| </ol></div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code>compareTo</code> in interface <code>java.lang.Comparable<<a href="../../../../org/eclipse/microprofile/metrics/MetricID.html" title="class in org.eclipse.microprofile.metrics">MetricID</a>></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>other</code> - the other MetricID</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.html" title="interface 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/MetricID.html" target="_top">Frames</a></li> |
| <li><a href="MetricID.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>Nested | </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> |