| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <title>MetadataBuilder</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="MetadataBuilder"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":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/Metadata.html" title="interface in org.eclipse.microprofile.metrics"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/eclipse/microprofile/metrics/Meter.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/MetadataBuilder.html" target="_top">Frames</a></li> |
| <li><a href="MetadataBuilder.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 MetadataBuilder" class="title">Class MetadataBuilder</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.eclipse.microprofile.metrics.MetadataBuilder</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre>public class <span class="typeNameLabel">MetadataBuilder</span> |
| extends java.lang.Object</pre> |
| <div class="block">The <a href="../../../../org/eclipse/microprofile/metrics/Metadata.html" title="interface in org.eclipse.microprofile.metrics"><code>Metadata</code></a> builder. |
| |
| All values are considered "not present" by default. Name must be set before <a href="../../../../org/eclipse/microprofile/metrics/MetadataBuilder.html#build--"><code>build()</code></a> is called.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Examples (en):</span></dt> |
| <dd><a href="../../../../../../../tomee-9.0/examples/mp-metrics-histogram.html">mp-metrics-histogram</a></dd> |
| <dt><span class="simpleTagLabel">Examples (es):</span></dt> |
| <dd><a href="../../../../../../../tomee-9.0/es/examples/mp-metrics-histogram.html">mp-metrics-histogram</a></dd> |
| <dt><span class="simpleTagLabel">Examples (pt):</span></dt> |
| <dd><a href="../../../../../../../tomee-9.0/pt/examples/mp-metrics-histogram.html">mp-metrics-histogram</a></dd> |
| </dl> |
| </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/MetadataBuilder.html#MetadataBuilder--">MetadataBuilder</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="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><a href="../../../../org/eclipse/microprofile/metrics/Metadata.html" title="interface in org.eclipse.microprofile.metrics">Metadata</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/microprofile/metrics/MetadataBuilder.html#build--">build</a></span>()</code> </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/eclipse/microprofile/metrics/MetadataBuilder.html" title="class in org.eclipse.microprofile.metrics">MetadataBuilder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/microprofile/metrics/MetadataBuilder.html#withDescription-java.lang.String-">withDescription</a></span>(java.lang.String description)</code> |
| <div class="block">Sets the description.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/eclipse/microprofile/metrics/MetadataBuilder.html" title="class in org.eclipse.microprofile.metrics">MetadataBuilder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/microprofile/metrics/MetadataBuilder.html#withDisplayName-java.lang.String-">withDisplayName</a></span>(java.lang.String displayName)</code> |
| <div class="block">Sets the displayName.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/eclipse/microprofile/metrics/MetadataBuilder.html" title="class in org.eclipse.microprofile.metrics">MetadataBuilder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/microprofile/metrics/MetadataBuilder.html#withName-java.lang.String-">withName</a></span>(java.lang.String name)</code> |
| <div class="block">Sets the name.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/eclipse/microprofile/metrics/MetadataBuilder.html" title="class in org.eclipse.microprofile.metrics">MetadataBuilder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/microprofile/metrics/MetadataBuilder.html#withType-org.eclipse.microprofile.metrics.MetricType-">withType</a></span>(<a href="../../../../org/eclipse/microprofile/metrics/MetricType.html" title="enum in org.eclipse.microprofile.metrics">MetricType</a> type)</code> |
| <div class="block">Sets the type.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/eclipse/microprofile/metrics/MetadataBuilder.html" title="class in org.eclipse.microprofile.metrics">MetadataBuilder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/microprofile/metrics/MetadataBuilder.html#withUnit-java.lang.String-">withUnit</a></span>(java.lang.String unit)</code> |
| <div class="block">Sets the unit.</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="MetadataBuilder--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>MetadataBuilder</h4> |
| <pre>public MetadataBuilder()</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="withName-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withName</h4> |
| <pre>public <a href="../../../../org/eclipse/microprofile/metrics/MetadataBuilder.html" title="class in org.eclipse.microprofile.metrics">MetadataBuilder</a> withName(java.lang.String name)</pre> |
| <div class="block">Sets the name. Does not accept null.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - the name</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the builder instance</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.NullPointerException</code> - when name is null</dd> |
| <dd><code>java.lang.IllegalArgumentException</code> - when name is empty</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="withDisplayName-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withDisplayName</h4> |
| <pre>public <a href="../../../../org/eclipse/microprofile/metrics/MetadataBuilder.html" title="class in org.eclipse.microprofile.metrics">MetadataBuilder</a> withDisplayName(java.lang.String displayName)</pre> |
| <div class="block">Sets the displayName.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>displayName</code> - the displayName, empty string is considered as "not present" (null)</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the builder instance</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="withDescription-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withDescription</h4> |
| <pre>public <a href="../../../../org/eclipse/microprofile/metrics/MetadataBuilder.html" title="class in org.eclipse.microprofile.metrics">MetadataBuilder</a> withDescription(java.lang.String description)</pre> |
| <div class="block">Sets the description.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>description</code> - the name, empty string is considered as "not present" (null)</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the builder instance</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="withType-org.eclipse.microprofile.metrics.MetricType-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withType</h4> |
| <pre>public <a href="../../../../org/eclipse/microprofile/metrics/MetadataBuilder.html" title="class in org.eclipse.microprofile.metrics">MetadataBuilder</a> withType(<a href="../../../../org/eclipse/microprofile/metrics/MetricType.html" title="enum in org.eclipse.microprofile.metrics">MetricType</a> type)</pre> |
| <div class="block">Sets the type.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>type</code> - the type, <a href="../../../../org/eclipse/microprofile/metrics/MetricType.html#INVALID"><code>MetricType.INVALID</code></a> is considered as "not present" (null)</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the builder instance</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="withUnit-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withUnit</h4> |
| <pre>public <a href="../../../../org/eclipse/microprofile/metrics/MetadataBuilder.html" title="class in org.eclipse.microprofile.metrics">MetadataBuilder</a> withUnit(java.lang.String unit)</pre> |
| <div class="block">Sets the unit.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>unit</code> - the unit, <a href="../../../../org/eclipse/microprofile/metrics/MetricUnits.html#NONE"><code>MetricUnits.NONE</code></a> is considered as "not present" (null)</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the builder instance</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="build--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>build</h4> |
| <pre>public <a href="../../../../org/eclipse/microprofile/metrics/Metadata.html" title="interface in org.eclipse.microprofile.metrics">Metadata</a> build()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>An object implementing <a href="../../../../org/eclipse/microprofile/metrics/Metadata.html" title="interface in org.eclipse.microprofile.metrics"><code>Metadata</code></a> from the provided properties</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.IllegalStateException</code> - when either name is null</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/Metadata.html" title="interface in org.eclipse.microprofile.metrics"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/eclipse/microprofile/metrics/Meter.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/MetadataBuilder.html" target="_top">Frames</a></li> |
| <li><a href="MetadataBuilder.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> |
