Google Git
Sign in
apache / incubator-nemo-website / ee5ccb31dfe6523e6550f715cbf4913d9db75dcc / . / apidocs / org / apache / nemo / runtime / executor / data / partition / SerializedPartition.html
blob: 2fe4caa8807d4be89f5f54eedefcd4b518dd66bc [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (11.0.9.1) on Fri Sep 09 19:30:40 KST 2022 -->
<title>SerializedPartition (Nemo Project 0.4 API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2022-09-09">
<link rel="stylesheet" type="text/css" href="../../../../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../../../jquery/jquery-ui.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.5.1.js"></script>
<script type="text/javascript" src="../../../../../../../jquery/jquery-ui.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="SerializedPartition (Nemo Project 0.4 API)";
}
}
catch(err) {
}
//-->
var data = {"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";
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="class-use/SerializedPartition.html">Use</a></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>Field&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>Field&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.nemo.runtime.executor.data.partition</a></div>
<h2 title="Class SerializedPartition" class="title">Class SerializedPartition&lt;K&gt;</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.apache.nemo.runtime.executor.data.partition.SerializedPartition&lt;K&gt;</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt><span class="paramLabel">Type Parameters:</span></dt>
<dd><code>K</code> - the key type of its partitions.</dd>
</dl>
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><code><a href="Partition.html" title="interface in org.apache.nemo.runtime.executor.data.partition">Partition</a>&lt;byte[],&#8203;K&gt;</code></dd>
</dl>
<hr>
<pre>public final class <span class="typeNameLabel">SerializedPartition&lt;K&gt;</span>
extends java.lang.Object
implements <a href="Partition.html" title="interface in org.apache.nemo.runtime.executor.data.partition">Partition</a>&lt;byte[],&#8203;K&gt;</pre>
<div class="block">A collection of data elements. The data is stored as an array of bytes.
This is a unit of read / write towards <a href="../block/Block.html" title="interface in org.apache.nemo.runtime.executor.data.block"><code>Block</code></a>s.
Releasing the memory(either off-heap or on-heap) occurs on block deletion.
TODO #396: Refactoring SerializedPartition into multiple classes</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<section role="region">
<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(K,byte%5B%5D,int,org.apache.nemo.runtime.executor.data.MemoryPoolAssigner)">SerializedPartition</a></span>&#8203;(<a href="SerializedPartition.html" title="type parameter in SerializedPartition">K</a>&nbsp;key,
byte[]&nbsp;serializedData,
int&nbsp;length,
<a href="../MemoryPoolAssigner.html" title="class in org.apache.nemo.runtime.executor.data">MemoryPoolAssigner</a>&nbsp;memoryPoolAssigner)</code></th>
<td class="colLast">
<div class="block">Creates a serialized <a href="Partition.html" title="interface in org.apache.nemo.runtime.executor.data.partition"><code>Partition</code></a> with actual data residing in on-heap region.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(K,java.util.List,int,org.apache.nemo.runtime.executor.data.MemoryPoolAssigner)">SerializedPartition</a></span>&#8203;(<a href="SerializedPartition.html" title="type parameter in SerializedPartition">K</a>&nbsp;key,
java.util.List&lt;<a href="../MemoryChunk.html" title="class in org.apache.nemo.runtime.executor.data">MemoryChunk</a>&gt;&nbsp;serializedChunkList,
int&nbsp;length,
<a href="../MemoryPoolAssigner.html" title="class in org.apache.nemo.runtime.executor.data">MemoryPoolAssigner</a>&nbsp;memoryPoolAssigner)</code></th>
<td class="colLast">
<div class="block">Creates a serialized <a href="Partition.html" title="interface in org.apache.nemo.runtime.executor.data.partition"><code>Partition</code></a> with actual data residing in off-heap region.</div>
</td>
</tr>
<tr class="altColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(K,org.apache.nemo.runtime.executor.data.streamchainer.Serializer,org.apache.nemo.runtime.executor.data.MemoryPoolAssigner)">SerializedPartition</a></span>&#8203;(<a href="SerializedPartition.html" title="type parameter in SerializedPartition">K</a>&nbsp;key,
<a href="../streamchainer/Serializer.html" title="class in org.apache.nemo.runtime.executor.data.streamchainer">Serializer</a>&nbsp;serializer,
<a href="../MemoryPoolAssigner.html" title="class in org.apache.nemo.runtime.executor.data">MemoryPoolAssigner</a>&nbsp;memoryPoolAssigner)</code></th>
<td class="colLast">
<div class="block">Creates a serialized <a href="Partition.html" title="interface in org.apache.nemo.runtime.executor.data.partition"><code>Partition</code></a> without actual data.</div>
</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- ========== METHOD SUMMARY =========== -->
<section role="region">
<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>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#commit()">commit</a></span>()</code></th>
<td class="colLast">
<div class="block">Commits a partition to prevent further data write.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>byte[]</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getData()">getData</a></span>()</code></th>
<td class="colLast">
<div class="block">This method should only be used when this partition is residing in on-heap region.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>java.util.List&lt;java.nio.ByteBuffer&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getDirectBufferList()">getDirectBufferList</a></span>()</code></th>
<td class="colLast">
<div class="block">This method is used to emit the output as <a href="SerializedPartition.html" title="class in org.apache.nemo.runtime.executor.data.partition"><code>SerializedPartition</code></a>.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="SerializedPartition.html" title="type parameter in SerializedPartition">K</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getKey()">getKey</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getLength()">getLength</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isOffheap()">isOffheap</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isSerialized()">isSerialized</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#release()">release</a></span>()</code></th>
<td class="colLast">
<div class="block">Releases the off-heap memory that this SerializedPartition holds.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#write(java.lang.Object)">write</a></span>&#8203;(java.lang.Object&nbsp;element)</code></th>
<td class="colLast">
<div class="block">Writes an element to non-committed partition.</div>
</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, 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 role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a id="&lt;init&gt;(java.lang.Object,org.apache.nemo.runtime.executor.data.streamchainer.Serializer,org.apache.nemo.runtime.executor.data.MemoryPoolAssigner)">
<!-- -->
</a><a id="&lt;init&gt;(K,org.apache.nemo.runtime.executor.data.streamchainer.Serializer,org.apache.nemo.runtime.executor.data.MemoryPoolAssigner)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>SerializedPartition</h4>
<pre>public&nbsp;SerializedPartition&#8203;(<a href="SerializedPartition.html" title="type parameter in SerializedPartition">K</a>&nbsp;key,
<a href="../streamchainer/Serializer.html" title="class in org.apache.nemo.runtime.executor.data.streamchainer">Serializer</a>&nbsp;serializer,
<a href="../MemoryPoolAssigner.html" title="class in org.apache.nemo.runtime.executor.data">MemoryPoolAssigner</a>&nbsp;memoryPoolAssigner)
throws java.io.IOException,
<a href="../MemoryAllocationException.html" title="class in org.apache.nemo.runtime.executor.data">MemoryAllocationException</a></pre>
<div class="block">Creates a serialized <a href="Partition.html" title="interface in org.apache.nemo.runtime.executor.data.partition"><code>Partition</code></a> without actual data.
Data can be written to this partition until it is committed.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>key</code> - the key of this partition.</dd>
<dd><code>serializer</code> - the serializer to be used to serialize data.</dd>
<dd><code>memoryPoolAssigner</code> - the memory pool assigner for memory allocation.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.io.IOException</code> - if fail to chain the output stream.</dd>
<dd><code><a href="../MemoryAllocationException.html" title="class in org.apache.nemo.runtime.executor.data">MemoryAllocationException</a></code> - if fail to allocate memory.</dd>
</dl>
</li>
</ul>
<a id="&lt;init&gt;(java.lang.Object,byte[],int,org.apache.nemo.runtime.executor.data.MemoryPoolAssigner)">
<!-- -->
</a><a id="&lt;init&gt;(K,byte[],int,org.apache.nemo.runtime.executor.data.MemoryPoolAssigner)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>SerializedPartition</h4>
<pre>public&nbsp;SerializedPartition&#8203;(<a href="SerializedPartition.html" title="type parameter in SerializedPartition">K</a>&nbsp;key,
byte[]&nbsp;serializedData,
int&nbsp;length,
<a href="../MemoryPoolAssigner.html" title="class in org.apache.nemo.runtime.executor.data">MemoryPoolAssigner</a>&nbsp;memoryPoolAssigner)</pre>
<div class="block">Creates a serialized <a href="Partition.html" title="interface in org.apache.nemo.runtime.executor.data.partition"><code>Partition</code></a> with actual data residing in on-heap region.
Data cannot be written to this partition after the construction.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>key</code> - the key.</dd>
<dd><code>serializedData</code> - the serialized data.</dd>
<dd><code>length</code> - the length of the actual serialized data. (It can be different with serializedData.length)</dd>
<dd><code>memoryPoolAssigner</code> - the memory pool assigner.</dd>
</dl>
</li>
</ul>
<a id="&lt;init&gt;(java.lang.Object,java.util.List,int,org.apache.nemo.runtime.executor.data.MemoryPoolAssigner)">
<!-- -->
</a><a id="&lt;init&gt;(K,java.util.List,int,org.apache.nemo.runtime.executor.data.MemoryPoolAssigner)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>SerializedPartition</h4>
<pre>public&nbsp;SerializedPartition&#8203;(<a href="SerializedPartition.html" title="type parameter in SerializedPartition">K</a>&nbsp;key,
java.util.List&lt;<a href="../MemoryChunk.html" title="class in org.apache.nemo.runtime.executor.data">MemoryChunk</a>&gt;&nbsp;serializedChunkList,
int&nbsp;length,
<a href="../MemoryPoolAssigner.html" title="class in org.apache.nemo.runtime.executor.data">MemoryPoolAssigner</a>&nbsp;memoryPoolAssigner)</pre>
<div class="block">Creates a serialized <a href="Partition.html" title="interface in org.apache.nemo.runtime.executor.data.partition"><code>Partition</code></a> with actual data residing in off-heap region.
Data cannot be written to this partition after the construction.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>key</code> - the key.</dd>
<dd><code>serializedChunkList</code> - the serialized data in list list of <a href="../MemoryChunk.html" title="class in org.apache.nemo.runtime.executor.data"><code>MemoryChunk</code></a>s.</dd>
<dd><code>length</code> - the length of the actual serialized data.(It can be different with serializedData.length)</dd>
<dd><code>memoryPoolAssigner</code> - the memory pool assigner.</dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>
<!-- ============ METHOD DETAIL ========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="write(java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>write</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;write&#8203;(java.lang.Object&nbsp;element)
throws java.io.IOException</pre>
<div class="block">Writes an element to non-committed partition.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="Partition.html#write(java.lang.Object)">write</a></code>&nbsp;in interface&nbsp;<code><a href="Partition.html" title="interface in org.apache.nemo.runtime.executor.data.partition">Partition</a>&lt;byte[],&#8203;<a href="SerializedPartition.html" title="type parameter in SerializedPartition">K</a>&gt;</code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>element</code> - element to write.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.io.IOException</code> - if the partition is already committed.</dd>
</dl>
</li>
</ul>
<a id="commit()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>commit</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;commit()
throws java.io.IOException</pre>
<div class="block">Commits a partition to prevent further data write.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="Partition.html#commit()">commit</a></code>&nbsp;in interface&nbsp;<code><a href="Partition.html" title="interface in org.apache.nemo.runtime.executor.data.partition">Partition</a>&lt;byte[],&#8203;<a href="SerializedPartition.html" title="type parameter in SerializedPartition">K</a>&gt;</code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.io.IOException</code> - if fail to commit partition.</dd>
</dl>
</li>
</ul>
<a id="getKey()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getKey</h4>
<pre class="methodSignature">public&nbsp;<a href="SerializedPartition.html" title="type parameter in SerializedPartition">K</a>&nbsp;getKey()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="Partition.html#getKey()">getKey</a></code>&nbsp;in interface&nbsp;<code><a href="Partition.html" title="interface in org.apache.nemo.runtime.executor.data.partition">Partition</a>&lt;byte[],&#8203;<a href="SerializedPartition.html" title="type parameter in SerializedPartition">K</a>&gt;</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the key value.</dd>
</dl>
</li>
</ul>
<a id="isSerialized()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isSerialized</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;isSerialized()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="Partition.html#isSerialized()">isSerialized</a></code>&nbsp;in interface&nbsp;<code><a href="Partition.html" title="interface in org.apache.nemo.runtime.executor.data.partition">Partition</a>&lt;byte[],&#8203;<a href="SerializedPartition.html" title="type parameter in SerializedPartition">K</a>&gt;</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>whether the data in this <a href="Partition.html" title="interface in org.apache.nemo.runtime.executor.data.partition"><code>Partition</code></a> is serialized or not.</dd>
</dl>
</li>
</ul>
<a id="getData()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getData</h4>
<pre class="methodSignature">public&nbsp;byte[]&nbsp;getData()
throws java.io.IOException</pre>
<div class="block">This method should only be used when this partition is residing in on-heap region.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="Partition.html#getData()">getData</a></code>&nbsp;in interface&nbsp;<code><a href="Partition.html" title="interface in org.apache.nemo.runtime.executor.data.partition">Partition</a>&lt;byte[],&#8203;<a href="SerializedPartition.html" title="type parameter in SerializedPartition">K</a>&gt;</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the serialized data.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.io.IOException</code> - if the partition is not committed yet.</dd>
</dl>
</li>
</ul>
<a id="getDirectBufferList()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDirectBufferList</h4>
<pre class="methodSignature">public&nbsp;java.util.List&lt;java.nio.ByteBuffer&gt;&nbsp;getDirectBufferList()
throws java.io.IOException</pre>
<div class="block">This method is used to emit the output as <a href="SerializedPartition.html" title="class in org.apache.nemo.runtime.executor.data.partition"><code>SerializedPartition</code></a>.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the serialized data in list of <code>ByteBuffer</code>s</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.io.IOException</code> - if the partition is not committed yet.</dd>
</dl>
</li>
</ul>
<a id="getLength()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLength</h4>
<pre class="methodSignature">public&nbsp;int&nbsp;getLength()
throws java.io.IOException</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the length of the actual data.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.io.IOException</code> - if the partition is not committed yet.</dd>
</dl>
</li>
</ul>
<a id="isOffheap()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isOffheap</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;isOffheap()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>whether this <code>SerializedPartition</code> is residing in off-heap region.</dd>
</dl>
</li>
</ul>
<a id="release()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>release</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;release()</pre>
<div class="block">Releases the off-heap memory that this SerializedPartition holds.
TODO #403: Remove 'transient' uses of SerializedPartition.</div>
</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="class-use/SerializedPartition.html">Use</a></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>Field&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>Field&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>
<p class="legalCopy"><small>Copyright &#169; 2020 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</footer>
</body>
</html>