Google Git
Sign in
apache / beam-site / 8066db78465c0d76bfe854be06941aea4657c8d5 / . / javadoc / javadoc / org / apache / beam / sdk / coders / IterableLikeCoder.html
blob: a18252874eae20a192087620cd3c5990d4831547 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_181-google-v7) on Mon Jan 27 16:42:30 PST 2020 -->
<title>IterableLikeCoder (Apache Beam 2.20.0-SNAPSHOT)</title>
<meta name="date" content="2020-01-27">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="IterableLikeCoder (Apache Beam 2.20.0-SNAPSHOT)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":6,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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/apache/beam/sdk/coders/IterableCoder.html" title="class in org.apache.beam.sdk.coders"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/beam/sdk/coders/KvCoder.html" title="class in org.apache.beam.sdk.coders"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/beam/sdk/coders/IterableLikeCoder.html" target="_top">Frames</a></li>
<li><a href="IterableLikeCoder.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li><a href="#nested.classes.inherited.from.class.org.apache.beam.sdk.coders.Coder">Nested</a>&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 name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.beam.sdk.coders</div>
<h2 title="Class IterableLikeCoder" class="title">Class IterableLikeCoder&lt;T,IterableT extends java.lang.Iterable&lt;T&gt;&gt;</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li><a href="../../../../../org/apache/beam/sdk/coders/Coder.html" title="class in org.apache.beam.sdk.coders">org.apache.beam.sdk.coders.Coder</a>&lt;T&gt;</li>
<li>
<ul class="inheritance">
<li><a href="../../../../../org/apache/beam/sdk/coders/StructuredCoder.html" title="class in org.apache.beam.sdk.coders">org.apache.beam.sdk.coders.StructuredCoder</a>&lt;IterableT&gt;</li>
<li>
<ul class="inheritance">
<li>org.apache.beam.sdk.coders.IterableLikeCoder&lt;T,IterableT&gt;</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt><span class="paramLabel">Type Parameters:</span></dt>
<dd><code>T</code> - the type of the elements of the <code>Iterable</code>s being transcoded</dd>
<dd><code>IterableT</code> - the type of the Iterables being transcoded</dd>
</dl>
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>java.io.Serializable</dd>
</dl>
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><a href="../../../../../org/apache/beam/sdk/coders/CollectionCoder.html" title="class in org.apache.beam.sdk.coders">CollectionCoder</a>, <a href="../../../../../org/apache/beam/sdk/coders/IterableCoder.html" title="class in org.apache.beam.sdk.coders">IterableCoder</a>, <a href="../../../../../org/apache/beam/sdk/coders/ListCoder.html" title="class in org.apache.beam.sdk.coders">ListCoder</a>, <a href="../../../../../org/apache/beam/sdk/coders/SetCoder.html" title="class in org.apache.beam.sdk.coders">SetCoder</a></dd>
</dl>
<hr>
<br>
<pre>public abstract class <span class="typeNameLabel">IterableLikeCoder&lt;T,IterableT extends java.lang.Iterable&lt;T&gt;&gt;</span>
extends <a href="../../../../../org/apache/beam/sdk/coders/StructuredCoder.html" title="class in org.apache.beam.sdk.coders">StructuredCoder</a>&lt;IterableT&gt;</pre>
<div class="block">An abstract base class with functionality for assembling a <a href="../../../../../org/apache/beam/sdk/coders/Coder.html" title="class in org.apache.beam.sdk.coders"><code>Coder</code></a> for a class that
implements <code>Iterable</code>.
<p>To complete a subclass, implement the <a href="../../../../../org/apache/beam/sdk/coders/IterableLikeCoder.html#decodeToIterable-java.util.List-"><code>decodeToIterable(java.util.List&lt;T&gt;)</code></a> method. This superclass will
decode the elements in the input stream into a <code>List</code> and then pass them to that method to
be converted into the appropriate iterable type. Note that this means the input iterables must
fit into memory.
<p>The format of this coder is as follows:
<ul>
<li>If the input <code>Iterable</code> has a known and finite size, then the size is written to the
output stream in big endian format, followed by all of the encoded elements.
<li>If the input <code>Iterable</code> is not known to have a finite size, then each element of the
input is preceded by <code>true</code> encoded as a byte (indicating "more data") followed by
the encoded element, and terminated by <code>false</code> encoded as a byte.
</ul></div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../serialized-form.html#org.apache.beam.sdk.coders.IterableLikeCoder">Serialized Form</a></dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="nested.class.summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<ul class="blockList">
<li class="blockList"><a name="nested.classes.inherited.from.class.org.apache.beam.sdk.coders.Coder">
<!-- -->
</a>
<h3>Nested classes/interfaces inherited from class&nbsp;org.apache.beam.sdk.coders.<a href="../../../../../org/apache/beam/sdk/coders/Coder.html" title="class in org.apache.beam.sdk.coders">Coder</a></h3>
<code><a href="../../../../../org/apache/beam/sdk/coders/Coder.Context.html" title="class in org.apache.beam.sdk.coders">Coder.Context</a>, <a href="../../../../../org/apache/beam/sdk/coders/Coder.NonDeterministicException.html" title="class in org.apache.beam.sdk.coders">Coder.NonDeterministicException</a></code></li>
</ul>
</li>
</ul>
<!-- ======== 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">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier</th>
<th class="colLast" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected </code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/coders/IterableLikeCoder.html#IterableLikeCoder-org.apache.beam.sdk.coders.Coder-java.lang.String-">IterableLikeCoder</a></span>(<a href="../../../../../org/apache/beam/sdk/coders/Coder.html" title="class in org.apache.beam.sdk.coders">Coder</a>&lt;<a href="../../../../../org/apache/beam/sdk/coders/IterableLikeCoder.html" title="type parameter in IterableLikeCoder">T</a>&gt;&nbsp;elementCoder,
java.lang.String&nbsp;iterableName)</code>&nbsp;</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">&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="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract 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="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/beam/sdk/coders/IterableLikeCoder.html" title="type parameter in IterableLikeCoder">IterableT</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/coders/IterableLikeCoder.html#decode-java.io.InputStream-">decode</a></span>(java.io.InputStream&nbsp;inStream)</code>
<div class="block">Decodes a value of type <code>T</code> from the given input stream in the given context.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>protected abstract <a href="../../../../../org/apache/beam/sdk/coders/IterableLikeCoder.html" title="type parameter in IterableLikeCoder">IterableT</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/coders/IterableLikeCoder.html#decodeToIterable-java.util.List-">decodeToIterable</a></span>(java.util.List&lt;<a href="../../../../../org/apache/beam/sdk/coders/IterableLikeCoder.html" title="type parameter in IterableLikeCoder">T</a>&gt;&nbsp;decodedElements)</code>
<div class="block">Builds an instance of <code>IterableT</code>, this coder's associated <code>Iterable</code>-like subtype,
from a list of decoded elements.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/coders/IterableLikeCoder.html#encode-IterableT-java.io.OutputStream-">encode</a></span>(<a href="../../../../../org/apache/beam/sdk/coders/IterableLikeCoder.html" title="type parameter in IterableLikeCoder">IterableT</a>&nbsp;iterable,
java.io.OutputStream&nbsp;outStream)</code>
<div class="block">Encodes the given value of type <code>T</code> onto the given output stream.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>java.util.List&lt;? extends <a href="../../../../../org/apache/beam/sdk/coders/Coder.html" title="class in org.apache.beam.sdk.coders">Coder</a>&lt;?&gt;&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/coders/IterableLikeCoder.html#getCoderArguments--">getCoderArguments</a></span>()</code>
<div class="block">If this is a <a href="../../../../../org/apache/beam/sdk/coders/Coder.html" title="class in org.apache.beam.sdk.coders"><code>Coder</code></a> for a parameterized type, returns the list of <a href="../../../../../org/apache/beam/sdk/coders/Coder.html" title="class in org.apache.beam.sdk.coders"><code>Coder</code></a>s being
used for each of the parameters in the same order they appear within the parameterized type's
type signature.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/beam/sdk/coders/Coder.html" title="class in org.apache.beam.sdk.coders">Coder</a>&lt;<a href="../../../../../org/apache/beam/sdk/coders/IterableLikeCoder.html" title="type parameter in IterableLikeCoder">T</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/coders/IterableLikeCoder.html#getElemCoder--">getElemCoder</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/coders/IterableLikeCoder.html#isRegisterByteSizeObserverCheap-IterableT-">isRegisterByteSizeObserverCheap</a></span>(<a href="../../../../../org/apache/beam/sdk/coders/IterableLikeCoder.html" title="type parameter in IterableLikeCoder">IterableT</a>&nbsp;iterable)</code>
<div class="block">Returns whether <a href="../../../../../org/apache/beam/sdk/coders/Coder.html#registerByteSizeObserver-T-org.apache.beam.sdk.util.common.ElementByteSizeObserver-"><code>Coder.registerByteSizeObserver(T, org.apache.beam.sdk.util.common.ElementByteSizeObserver)</code></a> cheap enough to call for every element, that
is, if this <code>Coder</code> can calculate the byte size of the element to be coded in roughly
constant time (or lazily).</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/coders/IterableLikeCoder.html#registerByteSizeObserver-IterableT-org.apache.beam.sdk.util.common.ElementByteSizeObserver-">registerByteSizeObserver</a></span>(<a href="../../../../../org/apache/beam/sdk/coders/IterableLikeCoder.html" title="type parameter in IterableLikeCoder">IterableT</a>&nbsp;iterable,
org.apache.beam.sdk.util.common.ElementByteSizeObserver&nbsp;observer)</code>
<div class="block">Notifies the <code>ElementByteSizeObserver</code> about the byte size of the encoded value using
this <code>Coder</code>.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/coders/IterableLikeCoder.html#verifyDeterministic--">verifyDeterministic</a></span>()</code>
<div class="block">Throw <a href="../../../../../org/apache/beam/sdk/coders/Coder.NonDeterministicException.html" title="class in org.apache.beam.sdk.coders"><code>Coder.NonDeterministicException</code></a> if the coding is not deterministic.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.beam.sdk.coders.StructuredCoder">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.beam.sdk.coders.<a href="../../../../../org/apache/beam/sdk/coders/StructuredCoder.html" title="class in org.apache.beam.sdk.coders">StructuredCoder</a></h3>
<code><a href="../../../../../org/apache/beam/sdk/coders/StructuredCoder.html#equals-java.lang.Object-">equals</a>, <a href="../../../../../org/apache/beam/sdk/coders/StructuredCoder.html#getComponents--">getComponents</a>, <a href="../../../../../org/apache/beam/sdk/coders/StructuredCoder.html#hashCode--">hashCode</a>, <a href="../../../../../org/apache/beam/sdk/coders/StructuredCoder.html#toString--">toString</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.beam.sdk.coders.Coder">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.beam.sdk.coders.<a href="../../../../../org/apache/beam/sdk/coders/Coder.html" title="class in org.apache.beam.sdk.coders">Coder</a></h3>
<code><a href="../../../../../org/apache/beam/sdk/coders/Coder.html#consistentWithEquals--">consistentWithEquals</a>, <a href="../../../../../org/apache/beam/sdk/coders/Coder.html#decode-java.io.InputStream-org.apache.beam.sdk.coders.Coder.Context-">decode</a>, <a href="../../../../../org/apache/beam/sdk/coders/Coder.html#encode-T-java.io.OutputStream-org.apache.beam.sdk.coders.Coder.Context-">encode</a>, <a href="../../../../../org/apache/beam/sdk/coders/Coder.html#getEncodedElementByteSize-T-">getEncodedElementByteSize</a>, <a href="../../../../../org/apache/beam/sdk/coders/Coder.html#getEncodedTypeDescriptor--">getEncodedTypeDescriptor</a>, <a href="../../../../../org/apache/beam/sdk/coders/Coder.html#structuralValue-T-">structuralValue</a>, <a href="../../../../../org/apache/beam/sdk/coders/Coder.html#verifyDeterministic-org.apache.beam.sdk.coders.Coder-java.lang.String-org.apache.beam.sdk.coders.Coder...-">verifyDeterministic</a>, <a href="../../../../../org/apache/beam/sdk/coders/Coder.html#verifyDeterministic-org.apache.beam.sdk.coders.Coder-java.lang.String-java.lang.Iterable-">verifyDeterministic</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="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>
</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="IterableLikeCoder-org.apache.beam.sdk.coders.Coder-java.lang.String-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>IterableLikeCoder</h4>
<pre>protected&nbsp;IterableLikeCoder(<a href="../../../../../org/apache/beam/sdk/coders/Coder.html" title="class in org.apache.beam.sdk.coders">Coder</a>&lt;<a href="../../../../../org/apache/beam/sdk/coders/IterableLikeCoder.html" title="type parameter in IterableLikeCoder">T</a>&gt;&nbsp;elementCoder,
java.lang.String&nbsp;iterableName)</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getElemCoder--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getElemCoder</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/beam/sdk/coders/Coder.html" title="class in org.apache.beam.sdk.coders">Coder</a>&lt;<a href="../../../../../org/apache/beam/sdk/coders/IterableLikeCoder.html" title="type parameter in IterableLikeCoder">T</a>&gt;&nbsp;getElemCoder()</pre>
</li>
</ul>
<a name="decodeToIterable-java.util.List-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>decodeToIterable</h4>
<pre>protected abstract&nbsp;<a href="../../../../../org/apache/beam/sdk/coders/IterableLikeCoder.html" title="type parameter in IterableLikeCoder">IterableT</a>&nbsp;decodeToIterable(java.util.List&lt;<a href="../../../../../org/apache/beam/sdk/coders/IterableLikeCoder.html" title="type parameter in IterableLikeCoder">T</a>&gt;&nbsp;decodedElements)</pre>
<div class="block">Builds an instance of <code>IterableT</code>, this coder's associated <code>Iterable</code>-like subtype,
from a list of decoded elements.</div>
</li>
</ul>
<a name="encode-java.lang.Iterable-java.io.OutputStream-">
<!-- -->
</a><a name="encode-IterableT-java.io.OutputStream-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>encode</h4>
<pre>public&nbsp;void&nbsp;encode(<a href="../../../../../org/apache/beam/sdk/coders/IterableLikeCoder.html" title="type parameter in IterableLikeCoder">IterableT</a>&nbsp;iterable,
java.io.OutputStream&nbsp;outStream)
throws java.io.IOException,
<a href="../../../../../org/apache/beam/sdk/coders/CoderException.html" title="class in org.apache.beam.sdk.coders">CoderException</a></pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/beam/sdk/coders/Coder.html#encode-T-java.io.OutputStream-">Coder</a></code></span></div>
<div class="block">Encodes the given value of type <code>T</code> onto the given output stream.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/beam/sdk/coders/Coder.html#encode-T-java.io.OutputStream-">encode</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/beam/sdk/coders/Coder.html" title="class in org.apache.beam.sdk.coders">Coder</a>&lt;<a href="../../../../../org/apache/beam/sdk/coders/IterableLikeCoder.html" title="type parameter in IterableLikeCoder">IterableT</a> extends java.lang.Iterable&lt;<a href="../../../../../org/apache/beam/sdk/coders/IterableLikeCoder.html" title="type parameter in IterableLikeCoder">T</a>&gt;&gt;</code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.io.IOException</code> - if writing to the <code>OutputStream</code> fails for some reason</dd>
<dd><code><a href="../../../../../org/apache/beam/sdk/coders/CoderException.html" title="class in org.apache.beam.sdk.coders">CoderException</a></code> - if the value could not be encoded for some reason</dd>
</dl>
</li>
</ul>
<a name="decode-java.io.InputStream-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>decode</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/beam/sdk/coders/IterableLikeCoder.html" title="type parameter in IterableLikeCoder">IterableT</a>&nbsp;decode(java.io.InputStream&nbsp;inStream)
throws java.io.IOException,
<a href="../../../../../org/apache/beam/sdk/coders/CoderException.html" title="class in org.apache.beam.sdk.coders">CoderException</a></pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/beam/sdk/coders/Coder.html#decode-java.io.InputStream-">Coder</a></code></span></div>
<div class="block">Decodes a value of type <code>T</code> from the given input stream in the given context. Returns the
decoded value.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/beam/sdk/coders/Coder.html#decode-java.io.InputStream-">decode</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/beam/sdk/coders/Coder.html" title="class in org.apache.beam.sdk.coders">Coder</a>&lt;<a href="../../../../../org/apache/beam/sdk/coders/IterableLikeCoder.html" title="type parameter in IterableLikeCoder">IterableT</a> extends java.lang.Iterable&lt;<a href="../../../../../org/apache/beam/sdk/coders/IterableLikeCoder.html" title="type parameter in IterableLikeCoder">T</a>&gt;&gt;</code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.io.IOException</code> - if reading from the <code>InputStream</code> fails for some reason</dd>
<dd><code><a href="../../../../../org/apache/beam/sdk/coders/CoderException.html" title="class in org.apache.beam.sdk.coders">CoderException</a></code> - if the value could not be decoded for some reason</dd>
</dl>
</li>
</ul>
<a name="getCoderArguments--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCoderArguments</h4>
<pre>public&nbsp;java.util.List&lt;? extends <a href="../../../../../org/apache/beam/sdk/coders/Coder.html" title="class in org.apache.beam.sdk.coders">Coder</a>&lt;?&gt;&gt;&nbsp;getCoderArguments()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/beam/sdk/coders/Coder.html#getCoderArguments--">Coder</a></code></span></div>
<div class="block">If this is a <a href="../../../../../org/apache/beam/sdk/coders/Coder.html" title="class in org.apache.beam.sdk.coders"><code>Coder</code></a> for a parameterized type, returns the list of <a href="../../../../../org/apache/beam/sdk/coders/Coder.html" title="class in org.apache.beam.sdk.coders"><code>Coder</code></a>s being
used for each of the parameters in the same order they appear within the parameterized type's
type signature. If this cannot be done, or this <a href="../../../../../org/apache/beam/sdk/coders/Coder.html" title="class in org.apache.beam.sdk.coders"><code>Coder</code></a> does not encode/decode a
parameterized type, returns the empty list.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/beam/sdk/coders/Coder.html#getCoderArguments--">getCoderArguments</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/beam/sdk/coders/Coder.html" title="class in org.apache.beam.sdk.coders">Coder</a>&lt;<a href="../../../../../org/apache/beam/sdk/coders/IterableLikeCoder.html" title="type parameter in IterableLikeCoder">IterableT</a> extends java.lang.Iterable&lt;<a href="../../../../../org/apache/beam/sdk/coders/IterableLikeCoder.html" title="type parameter in IterableLikeCoder">T</a>&gt;&gt;</code></dd>
</dl>
</li>
</ul>
<a name="verifyDeterministic--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>verifyDeterministic</h4>
<pre>public&nbsp;void&nbsp;verifyDeterministic()
throws <a href="../../../../../org/apache/beam/sdk/coders/Coder.NonDeterministicException.html" title="class in org.apache.beam.sdk.coders">Coder.NonDeterministicException</a></pre>
<div class="block">Throw <a href="../../../../../org/apache/beam/sdk/coders/Coder.NonDeterministicException.html" title="class in org.apache.beam.sdk.coders"><code>Coder.NonDeterministicException</code></a> if the coding is not deterministic.
<p>In order for a <code>Coder</code> to be considered deterministic, the following must be true:
<ul>
<li>two values that compare as equal (via <code>Object.equals()</code> or <code>Comparable.compareTo()</code>, if supported) have the same encoding.
<li>the <code>Coder</code> always produces a canonical encoding, which is the same for an instance
of an object even if produced on different computers at different times.
</ul></div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/beam/sdk/coders/Coder.html#verifyDeterministic--">verifyDeterministic</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/beam/sdk/coders/Coder.html" title="class in org.apache.beam.sdk.coders">Coder</a>&lt;<a href="../../../../../org/apache/beam/sdk/coders/IterableLikeCoder.html" title="type parameter in IterableLikeCoder">IterableT</a> extends java.lang.Iterable&lt;<a href="../../../../../org/apache/beam/sdk/coders/IterableLikeCoder.html" title="type parameter in IterableLikeCoder">T</a>&gt;&gt;</code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>NonDeterministicException</code> - always. Encoding is not deterministic for the general <code>Iterable</code> case, as it depends upon the type of iterable. This may allow two objects to
compare as equal while the encoding differs.</dd>
<dd><code><a href="../../../../../org/apache/beam/sdk/coders/Coder.NonDeterministicException.html" title="class in org.apache.beam.sdk.coders">Coder.NonDeterministicException</a></code> - if this coder is not deterministic.</dd>
</dl>
</li>
</ul>
<a name="isRegisterByteSizeObserverCheap-java.lang.Iterable-">
<!-- -->
</a><a name="isRegisterByteSizeObserverCheap-IterableT-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isRegisterByteSizeObserverCheap</h4>
<pre>public&nbsp;boolean&nbsp;isRegisterByteSizeObserverCheap(<a href="../../../../../org/apache/beam/sdk/coders/IterableLikeCoder.html" title="type parameter in IterableLikeCoder">IterableT</a>&nbsp;iterable)</pre>
<div class="block">Returns whether <a href="../../../../../org/apache/beam/sdk/coders/Coder.html#registerByteSizeObserver-T-org.apache.beam.sdk.util.common.ElementByteSizeObserver-"><code>Coder.registerByteSizeObserver(T, org.apache.beam.sdk.util.common.ElementByteSizeObserver)</code></a> cheap enough to call for every element, that
is, if this <code>Coder</code> can calculate the byte size of the element to be coded in roughly
constant time (or lazily).
<p>Not intended to be called by user code, but instead by <a href="../../../../../org/apache/beam/sdk/PipelineRunner.html" title="class in org.apache.beam.sdk"><code>PipelineRunner</code></a>
implementations.
<p>By default, returns false. The default <a href="../../../../../org/apache/beam/sdk/coders/Coder.html#registerByteSizeObserver-T-org.apache.beam.sdk.util.common.ElementByteSizeObserver-"><code>Coder.registerByteSizeObserver(T, org.apache.beam.sdk.util.common.ElementByteSizeObserver)</code></a> implementation
invokes <a href="../../../../../org/apache/beam/sdk/coders/Coder.html#getEncodedElementByteSize-T-"><code>Coder.getEncodedElementByteSize(T)</code></a> which requires re-encoding an element unless it is
overridden. This is considered expensive.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/beam/sdk/coders/Coder.html#isRegisterByteSizeObserverCheap-T-">isRegisterByteSizeObserverCheap</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/beam/sdk/coders/Coder.html" title="class in org.apache.beam.sdk.coders">Coder</a>&lt;<a href="../../../../../org/apache/beam/sdk/coders/IterableLikeCoder.html" title="type parameter in IterableLikeCoder">IterableT</a> extends java.lang.Iterable&lt;<a href="../../../../../org/apache/beam/sdk/coders/IterableLikeCoder.html" title="type parameter in IterableLikeCoder">T</a>&gt;&gt;</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>true</code> if the iterable is of a known class that supports lazy counting of byte
size, since that requires minimal extra computation.</dd>
</dl>
</li>
</ul>
<a name="registerByteSizeObserver-java.lang.Iterable-org.apache.beam.sdk.util.common.ElementByteSizeObserver-">
<!-- -->
</a><a name="registerByteSizeObserver-IterableT-org.apache.beam.sdk.util.common.ElementByteSizeObserver-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>registerByteSizeObserver</h4>
<pre>public&nbsp;void&nbsp;registerByteSizeObserver(<a href="../../../../../org/apache/beam/sdk/coders/IterableLikeCoder.html" title="type parameter in IterableLikeCoder">IterableT</a>&nbsp;iterable,
org.apache.beam.sdk.util.common.ElementByteSizeObserver&nbsp;observer)
throws java.lang.Exception</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/beam/sdk/coders/Coder.html#registerByteSizeObserver-T-org.apache.beam.sdk.util.common.ElementByteSizeObserver-">Coder</a></code></span></div>
<div class="block">Notifies the <code>ElementByteSizeObserver</code> about the byte size of the encoded value using
this <code>Coder</code>.
<p>Not intended to be called by user code, but instead by <a href="../../../../../org/apache/beam/sdk/PipelineRunner.html" title="class in org.apache.beam.sdk"><code>PipelineRunner</code></a>
implementations.
<p>By default, this notifies <code>observer</code> about the byte size of the encoded value using
this coder as returned by <a href="../../../../../org/apache/beam/sdk/coders/Coder.html#getEncodedElementByteSize-T-"><code>Coder.getEncodedElementByteSize(T)</code></a>.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/beam/sdk/coders/Coder.html#registerByteSizeObserver-T-org.apache.beam.sdk.util.common.ElementByteSizeObserver-">registerByteSizeObserver</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/beam/sdk/coders/Coder.html" title="class in org.apache.beam.sdk.coders">Coder</a>&lt;<a href="../../../../../org/apache/beam/sdk/coders/IterableLikeCoder.html" title="type parameter in IterableLikeCoder">IterableT</a> extends java.lang.Iterable&lt;<a href="../../../../../org/apache/beam/sdk/coders/IterableLikeCoder.html" title="type parameter in IterableLikeCoder">T</a>&gt;&gt;</code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.Exception</code></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/apache/beam/sdk/coders/IterableCoder.html" title="class in org.apache.beam.sdk.coders"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/beam/sdk/coders/KvCoder.html" title="class in org.apache.beam.sdk.coders"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/beam/sdk/coders/IterableLikeCoder.html" target="_top">Frames</a></li>
<li><a href="IterableLikeCoder.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.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>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested.classes.inherited.from.class.org.apache.beam.sdk.coders.Coder">Nested</a>&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 name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>