blob: 3dfb111d97a66bbe3d31cb19411b985fc08c6c06 [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (11.0.18) on Wed Mar 01 02:01:42 GMT 2023 -->
<title>Resource (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="Resource (Heron Java API)";
}
}
catch(err) {
}
//-->
var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":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";
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&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</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">&nbsp;</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>&nbsp;<a href="package-summary.html">org.apache.heron.spi.packing</a></div>
<h2 title="Class Resource" class="title">Class Resource</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.apache.heron.spi.packing.Resource</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<pre>public class <span class="typeNameLabel">Resource</span>
extends java.lang.Object</pre>
<div class="block">Definition of Resources. Used to form packing structure output.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<section>
<ul class="blockList">
<li class="blockList"><a id="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Field</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="Resource.html" title="class in org.apache.heron.spi.packing">Resource</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#EMPTY_RESOURCE">EMPTY_RESOURCE</a></span></code></th>
<td class="colLast">&nbsp;</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">&nbsp;</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(double,org.apache.heron.common.basics.ByteAmount,org.apache.heron.common.basics.ByteAmount)">Resource</a></span>&#8203;(double&nbsp;cpu,
<a href="../../common/basics/ByteAmount.html" title="class in org.apache.heron.common.basics">ByteAmount</a>&nbsp;ram,
<a href="../../common/basics/ByteAmount.html" title="class in org.apache.heron.common.basics">ByteAmount</a>&nbsp;disk)</code></th>
<td class="colLast">&nbsp;</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">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</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><a href="Resource.html" title="class in org.apache.heron.spi.packing">Resource</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#cloneWithCpu(double)">cloneWithCpu</a></span>&#8203;(double&nbsp;newCpu)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="Resource.html" title="class in org.apache.heron.spi.packing">Resource</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#cloneWithDisk(org.apache.heron.common.basics.ByteAmount)">cloneWithDisk</a></span>&#8203;(<a href="../../common/basics/ByteAmount.html" title="class in org.apache.heron.common.basics">ByteAmount</a>&nbsp;newDisk)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="Resource.html" title="class in org.apache.heron.spi.packing">Resource</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#cloneWithRam(org.apache.heron.common.basics.ByteAmount)">cloneWithRam</a></span>&#8203;(<a href="../../common/basics/ByteAmount.html" title="class in org.apache.heron.common.basics">ByteAmount</a>&nbsp;newRam)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>double</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#divideBy(org.apache.heron.spi.packing.Resource)">divideBy</a></span>&#8203;(<a href="Resource.html" title="class in org.apache.heron.spi.packing">Resource</a>&nbsp;other)</code></th>
<td class="colLast">
<div class="block">Divides a resource by another resource by dividing the CPU, memory and disk values of the resources.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#equals(java.lang.Object)">equals</a></span>&#8203;(java.lang.Object&nbsp;obj)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>double</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getCpu()">getCpu</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="../../common/basics/ByteAmount.html" title="class in org.apache.heron.common.basics">ByteAmount</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getDisk()">getDisk</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code><a href="../../common/basics/ByteAmount.html" title="class in org.apache.heron.common.basics">ByteAmount</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getRam()">getRam</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#hashCode()">hashCode</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code><a href="Resource.html" title="class in org.apache.heron.spi.packing">Resource</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#plus(org.apache.heron.spi.packing.Resource)">plus</a></span>&#8203;(<a href="Resource.html" title="class in org.apache.heron.spi.packing">Resource</a>&nbsp;other)</code></th>
<td class="colLast">
<div class="block">Adds a given resource from the current resource.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code><a href="Resource.html" title="class in org.apache.heron.spi.packing">Resource</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#subtractAbsolute(org.apache.heron.spi.packing.Resource)">subtractAbsolute</a></span>&#8203;(<a href="Resource.html" title="class in org.apache.heron.spi.packing">Resource</a>&nbsp;other)</code></th>
<td class="colLast">
<div class="block">Subtracts a given resource from the current resource.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toString()">toString</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, finalize, getClass, notify, notifyAll, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<section>
<ul class="blockList">
<li class="blockList"><a id="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a id="EMPTY_RESOURCE">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>EMPTY_RESOURCE</h4>
<pre>public static final&nbsp;<a href="Resource.html" title="class in org.apache.heron.spi.packing">Resource</a> EMPTY_RESOURCE</pre>
</li>
</ul>
</li>
</ul>
</section>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<section>
<ul class="blockList">
<li class="blockList"><a id="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a id="&lt;init&gt;(double,org.apache.heron.common.basics.ByteAmount,org.apache.heron.common.basics.ByteAmount)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>Resource</h4>
<pre>public&nbsp;Resource&#8203;(double&nbsp;cpu,
<a href="../../common/basics/ByteAmount.html" title="class in org.apache.heron.common.basics">ByteAmount</a>&nbsp;ram,
<a href="../../common/basics/ByteAmount.html" title="class in org.apache.heron.common.basics">ByteAmount</a>&nbsp;disk)</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="equals(java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>equals</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;equals&#8203;(java.lang.Object&nbsp;obj)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>equals</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
</dl>
</li>
</ul>
<a id="getCpu()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCpu</h4>
<pre class="methodSignature">public&nbsp;double&nbsp;getCpu()</pre>
</li>
</ul>
<a id="getRam()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRam</h4>
<pre class="methodSignature">public&nbsp;<a href="../../common/basics/ByteAmount.html" title="class in org.apache.heron.common.basics">ByteAmount</a>&nbsp;getRam()</pre>
</li>
</ul>
<a id="getDisk()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDisk</h4>
<pre class="methodSignature">public&nbsp;<a href="../../common/basics/ByteAmount.html" title="class in org.apache.heron.common.basics">ByteAmount</a>&nbsp;getDisk()</pre>
</li>
</ul>
<a id="cloneWithRam(org.apache.heron.common.basics.ByteAmount)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>cloneWithRam</h4>
<pre class="methodSignature">public&nbsp;<a href="Resource.html" title="class in org.apache.heron.spi.packing">Resource</a>&nbsp;cloneWithRam&#8203;(<a href="../../common/basics/ByteAmount.html" title="class in org.apache.heron.common.basics">ByteAmount</a>&nbsp;newRam)</pre>
</li>
</ul>
<a id="cloneWithCpu(double)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>cloneWithCpu</h4>
<pre class="methodSignature">public&nbsp;<a href="Resource.html" title="class in org.apache.heron.spi.packing">Resource</a>&nbsp;cloneWithCpu&#8203;(double&nbsp;newCpu)</pre>
</li>
</ul>
<a id="cloneWithDisk(org.apache.heron.common.basics.ByteAmount)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>cloneWithDisk</h4>
<pre class="methodSignature">public&nbsp;<a href="Resource.html" title="class in org.apache.heron.spi.packing">Resource</a>&nbsp;cloneWithDisk&#8203;(<a href="../../common/basics/ByteAmount.html" title="class in org.apache.heron.common.basics">ByteAmount</a>&nbsp;newDisk)</pre>
</li>
</ul>
<a id="subtractAbsolute(org.apache.heron.spi.packing.Resource)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>subtractAbsolute</h4>
<pre class="methodSignature">public&nbsp;<a href="Resource.html" title="class in org.apache.heron.spi.packing">Resource</a>&nbsp;subtractAbsolute&#8203;(<a href="Resource.html" title="class in org.apache.heron.spi.packing">Resource</a>&nbsp;other)</pre>
<div class="block">Subtracts a given resource from the current resource. The results is never negative.</div>
</li>
</ul>
<a id="plus(org.apache.heron.spi.packing.Resource)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>plus</h4>
<pre class="methodSignature">public&nbsp;<a href="Resource.html" title="class in org.apache.heron.spi.packing">Resource</a>&nbsp;plus&#8203;(<a href="Resource.html" title="class in org.apache.heron.spi.packing">Resource</a>&nbsp;other)</pre>
<div class="block">Adds a given resource from the current resource.</div>
</li>
</ul>
<a id="divideBy(org.apache.heron.spi.packing.Resource)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>divideBy</h4>
<pre class="methodSignature">public&nbsp;double&nbsp;divideBy&#8203;(<a href="Resource.html" title="class in org.apache.heron.spi.packing">Resource</a>&nbsp;other)
throws java.lang.RuntimeException</pre>
<div class="block">Divides a resource by another resource by dividing the CPU, memory and disk values of the resources.
It returns the maximum of the three results.</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.RuntimeException</code></dd>
</dl>
</li>
</ul>
<a id="hashCode()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hashCode</h4>
<pre class="methodSignature">public&nbsp;int&nbsp;hashCode()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>hashCode</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
</dl>
</li>
</ul>
<a id="toString()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>toString</h4>
<pre class="methodSignature">public&nbsp;java.lang.String&nbsp;toString()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>toString</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
</dl>
</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&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</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>