blob: fd149127739ec9681693a430ba41cb4adc15b4a1 [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>StringUtf8Coder (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="StringUtf8Coder (Apache Beam 2.20.0-SNAPSHOT)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":9,"i8":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";
</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/StringDelegateCoder.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/StructuralByteArray.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/StringUtf8Coder.html" target="_top">Frames</a></li>
<li><a href="StringUtf8Coder.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>Constr&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>Constr&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 StringUtf8Coder" class="title">Class StringUtf8Coder</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;T&gt;</li>
<li>
<ul class="inheritance">
<li><a href="../../../../../org/apache/beam/sdk/coders/AtomicCoder.html" title="class in org.apache.beam.sdk.coders">org.apache.beam.sdk.coders.AtomicCoder</a>&lt;java.lang.String&gt;</li>
<li>
<ul class="inheritance">
<li>org.apache.beam.sdk.coders.StringUtf8Coder</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>java.io.Serializable</dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">StringUtf8Coder</span>
extends <a href="../../../../../org/apache/beam/sdk/coders/AtomicCoder.html" title="class in org.apache.beam.sdk.coders">AtomicCoder</a>&lt;java.lang.String&gt;</pre>
<div class="block">A <a href="../../../../../org/apache/beam/sdk/coders/Coder.html" title="class in org.apache.beam.sdk.coders"><code>Coder</code></a> that encodes <code>Strings</code> in UTF-8 encoding. If in a nested context,
prefixes the string with an integer length field, encoded via a <a href="../../../../../org/apache/beam/sdk/coders/VarIntCoder.html" title="class in org.apache.beam.sdk.coders"><code>VarIntCoder</code></a>.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../serialized-form.html#org.apache.beam.sdk.coders.StringUtf8Coder">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>
<!-- ========== 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="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></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="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/coders/StringUtf8Coder.html#consistentWithEquals--">consistentWithEquals</a></span>()</code>
<div class="block">Returns <code>true</code> if this <a href="../../../../../org/apache/beam/sdk/coders/Coder.html" title="class in org.apache.beam.sdk.coders"><code>Coder</code></a> is injective with respect to <code>Object.equals(java.lang.Object)</code>.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/coders/StringUtf8Coder.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="i2" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/coders/StringUtf8Coder.html#decode-java.io.InputStream-org.apache.beam.sdk.coders.Coder.Context-">decode</a></span>(java.io.InputStream&nbsp;inStream,
<a href="../../../../../org/apache/beam/sdk/coders/Coder.Context.html" title="class in org.apache.beam.sdk.coders">Coder.Context</a>&nbsp;context)</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="i3" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/coders/StringUtf8Coder.html#encode-java.lang.String-java.io.OutputStream-">encode</a></span>(java.lang.String&nbsp;value,
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="i4" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/coders/StringUtf8Coder.html#encode-java.lang.String-java.io.OutputStream-org.apache.beam.sdk.coders.Coder.Context-">encode</a></span>(java.lang.String&nbsp;value,
java.io.OutputStream&nbsp;outStream,
<a href="../../../../../org/apache/beam/sdk/coders/Coder.Context.html" title="class in org.apache.beam.sdk.coders">Coder.Context</a>&nbsp;context)</code>
<div class="block">Encodes the given value of type <code>T</code> onto the given output stream in the given context.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/coders/StringUtf8Coder.html#getEncodedElementByteSize-java.lang.String-">getEncodedElementByteSize</a></span>(java.lang.String&nbsp;value)</code>
<div class="block">Returns the size in bytes of the encoded value using this coder.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/beam/sdk/values/TypeDescriptor.html" title="class in org.apache.beam.sdk.values">TypeDescriptor</a>&lt;java.lang.String&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/coders/StringUtf8Coder.html#getEncodedTypeDescriptor--">getEncodedTypeDescriptor</a></span>()</code>
<div class="block">Returns the <a href="../../../../../org/apache/beam/sdk/values/TypeDescriptor.html" title="class in org.apache.beam.sdk.values"><code>TypeDescriptor</code></a> for the type encoded.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>static <a href="../../../../../org/apache/beam/sdk/coders/StringUtf8Coder.html" title="class in org.apache.beam.sdk.coders">StringUtf8Coder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/coders/StringUtf8Coder.html#of--">of</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/coders/StringUtf8Coder.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.AtomicCoder">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.beam.sdk.coders.<a href="../../../../../org/apache/beam/sdk/coders/AtomicCoder.html" title="class in org.apache.beam.sdk.coders">AtomicCoder</a></h3>
<code><a href="../../../../../org/apache/beam/sdk/coders/AtomicCoder.html#equals-java.lang.Object-">equals</a>, <a href="../../../../../org/apache/beam/sdk/coders/AtomicCoder.html#getCoderArguments--">getCoderArguments</a>, <a href="../../../../../org/apache/beam/sdk/coders/AtomicCoder.html#getComponents--">getComponents</a>, <a href="../../../../../org/apache/beam/sdk/coders/AtomicCoder.html#hashCode--">hashCode</a></code></li>
</ul>
<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#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#isRegisterByteSizeObserverCheap-T-">isRegisterByteSizeObserverCheap</a>, <a href="../../../../../org/apache/beam/sdk/coders/Coder.html#registerByteSizeObserver-T-org.apache.beam.sdk.util.common.ElementByteSizeObserver-">registerByteSizeObserver</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">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="of--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>of</h4>
<pre>public static&nbsp;<a href="../../../../../org/apache/beam/sdk/coders/StringUtf8Coder.html" title="class in org.apache.beam.sdk.coders">StringUtf8Coder</a>&nbsp;of()</pre>
</li>
</ul>
<a name="encode-java.lang.String-java.io.OutputStream-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>encode</h4>
<pre>public&nbsp;void&nbsp;encode(java.lang.String&nbsp;value,
java.io.OutputStream&nbsp;outStream)
throws java.io.IOException</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;java.lang.String&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="encode-java.lang.String-java.io.OutputStream-org.apache.beam.sdk.coders.Coder.Context-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>encode</h4>
<pre>public&nbsp;void&nbsp;encode(java.lang.String&nbsp;value,
java.io.OutputStream&nbsp;outStream,
<a href="../../../../../org/apache/beam/sdk/coders/Coder.Context.html" title="class in org.apache.beam.sdk.coders">Coder.Context</a>&nbsp;context)
throws java.io.IOException</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-org.apache.beam.sdk.coders.Coder.Context-">Coder</a></code></span></div>
<div class="block">Encodes the given value of type <code>T</code> onto the given output stream in the given context.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/beam/sdk/coders/Coder.html#encode-T-java.io.OutputStream-org.apache.beam.sdk.coders.Coder.Context-">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;java.lang.String&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;java.lang.String&nbsp;decode(java.io.InputStream&nbsp;inStream)
throws java.io.IOException</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;java.lang.String&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="decode-java.io.InputStream-org.apache.beam.sdk.coders.Coder.Context-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>decode</h4>
<pre>public&nbsp;java.lang.String&nbsp;decode(java.io.InputStream&nbsp;inStream,
<a href="../../../../../org/apache/beam/sdk/coders/Coder.Context.html" title="class in org.apache.beam.sdk.coders">Coder.Context</a>&nbsp;context)
throws java.io.IOException</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-org.apache.beam.sdk.coders.Coder.Context-">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">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/beam/sdk/coders/Coder.html#decode-java.io.InputStream-org.apache.beam.sdk.coders.Coder.Context-">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;java.lang.String&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="verifyDeterministic--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>verifyDeterministic</h4>
<pre>public&nbsp;void&nbsp;verifyDeterministic()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/beam/sdk/coders/AtomicCoder.html#verifyDeterministic--">AtomicCoder</a></code></span></div>
<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>.
<p>Unless overridden, does not throw. An <a href="../../../../../org/apache/beam/sdk/coders/AtomicCoder.html" title="class in org.apache.beam.sdk.coders"><code>AtomicCoder</code></a> is presumed to be deterministic</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/beam/sdk/coders/AtomicCoder.html#verifyDeterministic--">verifyDeterministic</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/beam/sdk/coders/AtomicCoder.html" title="class in org.apache.beam.sdk.coders">AtomicCoder</a>&lt;java.lang.String&gt;</code></dd>
</dl>
</li>
</ul>
<a name="consistentWithEquals--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>consistentWithEquals</h4>
<pre>public&nbsp;boolean&nbsp;consistentWithEquals()</pre>
<div class="block">Returns <code>true</code> if this <a href="../../../../../org/apache/beam/sdk/coders/Coder.html" title="class in org.apache.beam.sdk.coders"><code>Coder</code></a> is injective with respect to <code>Object.equals(java.lang.Object)</code>.
<p>Whenever the encoded bytes of two values are equal, then the original values are equal
according to <code>Objects.equals()</code>. Note that this is well-defined for <code>null</code>.
<p>This condition is most notably false for arrays. More generally, this condition is false
whenever <code>equals()</code> compares object identity, rather than performing a
semantic/structural comparison.
<p>By default, returns false.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/beam/sdk/coders/Coder.html#consistentWithEquals--">consistentWithEquals</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;java.lang.String&gt;</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>true</code>. This coder is injective.</dd>
</dl>
</li>
</ul>
<a name="getEncodedTypeDescriptor--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getEncodedTypeDescriptor</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/beam/sdk/values/TypeDescriptor.html" title="class in org.apache.beam.sdk.values">TypeDescriptor</a>&lt;java.lang.String&gt;&nbsp;getEncodedTypeDescriptor()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/beam/sdk/coders/Coder.html#getEncodedTypeDescriptor--">Coder</a></code></span></div>
<div class="block">Returns the <a href="../../../../../org/apache/beam/sdk/values/TypeDescriptor.html" title="class in org.apache.beam.sdk.values"><code>TypeDescriptor</code></a> for the type encoded.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/beam/sdk/coders/Coder.html#getEncodedTypeDescriptor--">getEncodedTypeDescriptor</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;java.lang.String&gt;</code></dd>
</dl>
</li>
</ul>
<a name="getEncodedElementByteSize-java.lang.String-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getEncodedElementByteSize</h4>
<pre>public&nbsp;long&nbsp;getEncodedElementByteSize(java.lang.String&nbsp;value)
throws java.lang.Exception</pre>
<div class="block">Returns the size in bytes of the encoded value using this coder.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/beam/sdk/coders/Coder.html#getEncodedElementByteSize-T-">getEncodedElementByteSize</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;java.lang.String&gt;</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the byte size of the UTF-8 encoding of the a string or, in a nested context, the byte
size of the encoding plus the encoded length prefix.</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/StringDelegateCoder.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/StructuralByteArray.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/StringUtf8Coder.html" target="_top">Frames</a></li>
<li><a href="StringUtf8Coder.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>Constr&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>Constr&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>