| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (11.0.18) on Wed Mar 01 02:01:42 GMT 2023 --> |
| <title>FormatterUtils (Heron Java API)</title> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="dc.created" content="2023-03-01"> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../jquery/jquery-ui.min.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> |
| <script type="text/javascript" src="../../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../../jquery/jszip/dist/jszip.min.js"></script> |
| <script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script> |
| <!--[if IE]> |
| <script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script> |
| <![endif]--> |
| <script type="text/javascript" src="../../../../../jquery/jquery-3.6.0.min.js"></script> |
| <script type="text/javascript" src="../../../../../jquery/jquery-ui.min.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="FormatterUtils (Heron Java API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":9,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10}; |
| var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| var pathtoroot = "../../../../../"; |
| var useModuleDirectories = true; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <header role="banner"> |
| <nav role="navigation"> |
| <div class="fixedNav"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a id="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../index.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" id="allclasses_navbar_top"> |
| <li><a href="../../../../../allclasses.html">All Classes</a></li> |
| </ul> |
| <ul class="navListSearch"> |
| <li><label for="search">SEARCH:</label> |
| <input type="text" id="search" value="search" disabled="disabled"> |
| <input type="reset" id="reset" value="reset" disabled="disabled"> |
| </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> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </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 id="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| </div> |
| <div class="navPadding"> </div> |
| <script type="text/javascript"><!-- |
| $('.navPadding').css('padding-top', $('.fixedNav').css("height")); |
| //--> |
| </script> |
| </nav> |
| </header> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <main role="main"> |
| <div class="header"> |
| <div class="subTitle"><span class="packageLabelInType">Package</span> <a href="package-summary.html">org.apache.heron.scheduler.dryrun</a></div> |
| <h2 title="Class FormatterUtils" class="title">Class FormatterUtils</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.heron.scheduler.dryrun.FormatterUtils</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <pre>public final class <span class="typeNameLabel">FormatterUtils</span> |
| extends java.lang.Object</pre> |
| <div class="block">Formatter utilities</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <section> |
| <ul class="blockList"> |
| <li class="blockList"><a id="nested.class.summary"> |
| <!-- --> |
| </a> |
| <h3>Nested Class Summary</h3> |
| <table class="memberSummary"> |
| <caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Class</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="FormatterUtils.Cell.html" title="class in org.apache.heron.scheduler.dryrun">FormatterUtils.Cell</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">Cell is the smallest unit in a tabulate.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="FormatterUtils.ContainerChange.html" title="enum in org.apache.heron.scheduler.dryrun">FormatterUtils.ContainerChange</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="FormatterUtils.Row.html" title="class in org.apache.heron.scheduler.dryrun">FormatterUtils.Row</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">Row, which consists a list of cells.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="FormatterUtils.Table.html" title="class in org.apache.heron.scheduler.dryrun">FormatterUtils.Table</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">Table, which consists of a title and a list of rows below the title</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="FormatterUtils.TextColor.html" title="enum in org.apache.heron.scheduler.dryrun">FormatterUtils.TextColor</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="FormatterUtils.TextStyle.html" title="enum in org.apache.heron.scheduler.dryrun">FormatterUtils.TextStyle</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </section> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <section> |
| <ul class="blockList"> |
| <li class="blockList"><a id="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Constructor</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr class="altColor"> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(boolean)">FormatterUtils</a></span>​(boolean rich)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </section> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <section> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary"> |
| <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="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="colSecond" scope="col">Method</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>static com.google.common.base.Optional<<a href="FormatterUtils.Cell.html" title="class in org.apache.heron.scheduler.dryrun">FormatterUtils.Cell</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#percentageChange(double,double)">percentageChange</a></span>​(double oldAmount, |
| double newAmount)</code></th> |
| <td class="colLast"> |
| <div class="block">Format new amount associated with change in percentage |
| For example, with <code>oldAmount = 2</code> and <code>newAmount = 1</code> |
| the result Cell is " -50.00%" (in red color)</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#renderContainerChange(org.apache.heron.scheduler.dryrun.FormatterUtils.ContainerChange)">renderContainerChange</a></span>​(<a href="FormatterUtils.ContainerChange.html" title="enum in org.apache.heron.scheduler.dryrun">FormatterUtils.ContainerChange</a> change)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#renderContainerName(java.lang.Integer)">renderContainerName</a></span>​(java.lang.Integer containerId)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#renderOneContainer(java.util.List)">renderOneContainer</a></span>​(java.util.List<<a href="FormatterUtils.Row.html" title="class in org.apache.heron.scheduler.dryrun">FormatterUtils.Row</a>> rows)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#renderResourceUsage(org.apache.heron.spi.packing.Resource)">renderResourceUsage</a></span>​(<a href="../../spi/packing/Resource.html" title="class in org.apache.heron.spi.packing">Resource</a> resource)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#renderResourceUsageChange(org.apache.heron.spi.packing.Resource,org.apache.heron.spi.packing.Resource)">renderResourceUsageChange</a></span>​(<a href="../../spi/packing/Resource.html" title="class in org.apache.heron.spi.packing">Resource</a> oldResource, |
| <a href="../../spi/packing/Resource.html" title="class in org.apache.heron.spi.packing">Resource</a> newResource)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code><a href="FormatterUtils.Row.html" title="class in org.apache.heron.scheduler.dryrun">FormatterUtils.Row</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#rowOfInstancePlan(org.apache.heron.spi.packing.PackingPlan.InstancePlan,org.apache.heron.scheduler.dryrun.FormatterUtils.TextColor,org.apache.heron.scheduler.dryrun.FormatterUtils.TextStyle)">rowOfInstancePlan</a></span>​(<a href="../../spi/packing/PackingPlan.InstancePlan.html" title="class in org.apache.heron.spi.packing">PackingPlan.InstancePlan</a> plan, |
| <a href="FormatterUtils.TextColor.html" title="enum in org.apache.heron.scheduler.dryrun">FormatterUtils.TextColor</a> color, |
| <a href="FormatterUtils.TextStyle.html" title="enum in org.apache.heron.scheduler.dryrun">FormatterUtils.TextStyle</a> style)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a id="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> |
| </section> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <section> |
| <ul class="blockList"> |
| <li class="blockList"><a id="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a id="<init>(boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>FormatterUtils</h4> |
| <pre>public FormatterUtils​(boolean rich)</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| <!-- ============ METHOD DETAIL ========== --> |
| <section> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a id="percentageChange(double,double)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>percentageChange</h4> |
| <pre class="methodSignature">public static com.google.common.base.Optional<<a href="FormatterUtils.Cell.html" title="class in org.apache.heron.scheduler.dryrun">FormatterUtils.Cell</a>> percentageChange​(double oldAmount, |
| double newAmount)</pre> |
| <div class="block">Format new amount associated with change in percentage |
| For example, with <code>oldAmount = 2</code> and <code>newAmount = 1</code> |
| the result Cell is " -50.00%" (in red color)</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>oldAmount</code> - old resource usage</dd> |
| <dd><code>newAmount</code> - new resource usage</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>formatted chagne in percentage if oldAmount and newAmount differ</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="renderContainerName(java.lang.Integer)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>renderContainerName</h4> |
| <pre class="methodSignature">public java.lang.String renderContainerName​(java.lang.Integer containerId)</pre> |
| </li> |
| </ul> |
| <a id="renderContainerChange(org.apache.heron.scheduler.dryrun.FormatterUtils.ContainerChange)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>renderContainerChange</h4> |
| <pre class="methodSignature">public java.lang.String renderContainerChange​(<a href="FormatterUtils.ContainerChange.html" title="enum in org.apache.heron.scheduler.dryrun">FormatterUtils.ContainerChange</a> change)</pre> |
| </li> |
| </ul> |
| <a id="rowOfInstancePlan(org.apache.heron.spi.packing.PackingPlan.InstancePlan,org.apache.heron.scheduler.dryrun.FormatterUtils.TextColor,org.apache.heron.scheduler.dryrun.FormatterUtils.TextStyle)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>rowOfInstancePlan</h4> |
| <pre class="methodSignature">public <a href="FormatterUtils.Row.html" title="class in org.apache.heron.scheduler.dryrun">FormatterUtils.Row</a> rowOfInstancePlan​(<a href="../../spi/packing/PackingPlan.InstancePlan.html" title="class in org.apache.heron.spi.packing">PackingPlan.InstancePlan</a> plan, |
| <a href="FormatterUtils.TextColor.html" title="enum in org.apache.heron.scheduler.dryrun">FormatterUtils.TextColor</a> color, |
| <a href="FormatterUtils.TextStyle.html" title="enum in org.apache.heron.scheduler.dryrun">FormatterUtils.TextStyle</a> style)</pre> |
| </li> |
| </ul> |
| <a id="renderOneContainer(java.util.List)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>renderOneContainer</h4> |
| <pre class="methodSignature">public java.lang.String renderOneContainer​(java.util.List<<a href="FormatterUtils.Row.html" title="class in org.apache.heron.scheduler.dryrun">FormatterUtils.Row</a>> rows)</pre> |
| </li> |
| </ul> |
| <a id="renderResourceUsage(org.apache.heron.spi.packing.Resource)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>renderResourceUsage</h4> |
| <pre class="methodSignature">public java.lang.String renderResourceUsage​(<a href="../../spi/packing/Resource.html" title="class in org.apache.heron.spi.packing">Resource</a> resource)</pre> |
| </li> |
| </ul> |
| <a id="renderResourceUsageChange(org.apache.heron.spi.packing.Resource,org.apache.heron.spi.packing.Resource)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>renderResourceUsageChange</h4> |
| <pre class="methodSignature">public java.lang.String renderResourceUsageChange​(<a href="../../spi/packing/Resource.html" title="class in org.apache.heron.spi.packing">Resource</a> oldResource, |
| <a href="../../spi/packing/Resource.html" title="class in org.apache.heron.spi.packing">Resource</a> newResource)</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </main> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <footer role="contentinfo"> |
| <nav role="navigation"> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a id="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../index.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" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../allclasses.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> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </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 id="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </nav> |
| </footer> |
| </body> |
| </html> |
