http://git-wip-us.apache.org/repos/asf/beam-site/blob/c196579f/content/documentation/sdks/javadoc/2.0.0/org/apache/beam/runners/dataflow/util/RandomAccessData.RandomAccessDataCoder.html ---------------------------------------------------------------------- diff --git a/content/documentation/sdks/javadoc/2.0.0/org/apache/beam/runners/dataflow/util/RandomAccessData.RandomAccessDataCoder.html b/content/documentation/sdks/javadoc/2.0.0/org/apache/beam/runners/dataflow/util/RandomAccessData.RandomAccessDataCoder.html new file mode 100644 index 0000000..7f90737 --- /dev/null +++ b/content/documentation/sdks/javadoc/2.0.0/org/apache/beam/runners/dataflow/util/RandomAccessData.RandomAccessDataCoder.html @@ -0,0 +1,584 @@ +<!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_112-google-v7) on Fri May 12 16:50:04 PDT 2017 --> +<title>RandomAccessData.RandomAccessDataCoder</title> +<meta name="date" content="2017-05-12"> +<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="RandomAccessData.RandomAccessDataCoder"; + } + } + 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/runners/dataflow/util/RandomAccessData.html" title="class in org.apache.beam.runners.dataflow.util"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../../org/apache/beam/runners/dataflow/util/RandomAccessData.UnsignedLexicographicalComparator.html" title="class in org.apache.beam.runners.dataflow.util"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/beam/runners/dataflow/util/RandomAccessData.RandomAccessDataCoder.html" target="_top">Frames</a></li> +<li><a href="RandomAccessData.RandomAccessDataCoder.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../../../allclasses-noframe.html">All 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: </li> +<li><a href="#nested.classes.inherited.from.class.org.apache.beam.sdk.coders.Coder">Nested</a> | </li> +<li>Field | </li> +<li><a href="#constructor.summary">Constr</a> | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor.detail">Constr</a> | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">org.apache.beam.runners.dataflow.util</div> +<h2 title="Class RandomAccessData.RandomAccessDataCoder" class="title">Class RandomAccessData.RandomAccessDataCoder</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><T></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><T></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><<a href="../../../../../../org/apache/beam/runners/dataflow/util/RandomAccessData.html" title="class in org.apache.beam.runners.dataflow.util">RandomAccessData</a>></li> +<li> +<ul class="inheritance"> +<li>org.apache.beam.runners.dataflow.util.RandomAccessData.RandomAccessDataCoder</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> +<dl> +<dt>Enclosing class:</dt> +<dd><a href="../../../../../../org/apache/beam/runners/dataflow/util/RandomAccessData.html" title="class in org.apache.beam.runners.dataflow.util">RandomAccessData</a></dd> +</dl> +<hr> +<br> +<pre>public static class <span class="typeNameLabel">RandomAccessData.RandomAccessDataCoder</span> +extends <a href="../../../../../../org/apache/beam/sdk/coders/AtomicCoder.html" title="class in org.apache.beam.sdk.coders">AtomicCoder</a><<a href="../../../../../../org/apache/beam/runners/dataflow/util/RandomAccessData.html" title="class in org.apache.beam.runners.dataflow.util">RandomAccessData</a>></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> which encodes the valid parts of this stream. + This follows the same encoding scheme as <a href="../../../../../../org/apache/beam/sdk/coders/ByteArrayCoder.html" title="class in org.apache.beam.sdk.coders"><code>ByteArrayCoder</code></a>. + This coder is deterministic and consistent with equals. + + <p>This coder does not support encoding positive infinity.</div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../../../serialized-form.html#org.apache.beam.runners.dataflow.util.RandomAccessData.RandomAccessDataCoder">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 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"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/dataflow/util/RandomAccessData.RandomAccessDataCoder.html#RandomAccessDataCoder--">RandomAccessDataCoder</a></span>()</code> </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"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="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/runners/dataflow/util/RandomAccessData.RandomAccessDataCoder.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><a href="../../../../../../org/apache/beam/runners/dataflow/util/RandomAccessData.html" title="class in org.apache.beam.runners.dataflow.util">RandomAccessData</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/dataflow/util/RandomAccessData.RandomAccessDataCoder.html#decode-java.io.InputStream-">decode</a></span>(java.io.InputStream 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><a href="../../../../../../org/apache/beam/runners/dataflow/util/RandomAccessData.html" title="class in org.apache.beam.runners.dataflow.util">RandomAccessData</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/dataflow/util/RandomAccessData.RandomAccessDataCoder.html#decode-java.io.InputStream-org.apache.beam.sdk.coders.Coder.Context-">decode</a></span>(java.io.InputStream inStream, + <a href="../../../../../../org/apache/beam/sdk/coders/Coder.Context.html" title="class in org.apache.beam.sdk.coders">Coder.Context</a> 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/runners/dataflow/util/RandomAccessData.RandomAccessDataCoder.html#encode-org.apache.beam.runners.dataflow.util.RandomAccessData-java.io.OutputStream-">encode</a></span>(<a href="../../../../../../org/apache/beam/runners/dataflow/util/RandomAccessData.html" title="class in org.apache.beam.runners.dataflow.util">RandomAccessData</a> value, + java.io.OutputStream 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/runners/dataflow/util/RandomAccessData.RandomAccessDataCoder.html#encode-org.apache.beam.runners.dataflow.util.RandomAccessData-java.io.OutputStream-org.apache.beam.sdk.coders.Coder.Context-">encode</a></span>(<a href="../../../../../../org/apache/beam/runners/dataflow/util/RandomAccessData.html" title="class in org.apache.beam.runners.dataflow.util">RandomAccessData</a> value, + java.io.OutputStream outStream, + <a href="../../../../../../org/apache/beam/sdk/coders/Coder.Context.html" title="class in org.apache.beam.sdk.coders">Coder.Context</a> 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>protected long</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/dataflow/util/RandomAccessData.RandomAccessDataCoder.html#getEncodedElementByteSize-org.apache.beam.runners.dataflow.util.RandomAccessData-">getEncodedElementByteSize</a></span>(<a href="../../../../../../org/apache/beam/runners/dataflow/util/RandomAccessData.html" title="class in org.apache.beam.runners.dataflow.util">RandomAccessData</a> 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>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/dataflow/util/RandomAccessData.RandomAccessDataCoder.html#isRegisterByteSizeObserverCheap-org.apache.beam.runners.dataflow.util.RandomAccessData-">isRegisterByteSizeObserverCheap</a></span>(<a href="../../../../../../org/apache/beam/runners/dataflow/util/RandomAccessData.html" title="class in org.apache.beam.runners.dataflow.util">RandomAccessData</a> value)</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="i7" class="rowColor"> +<td class="colFirst"><code>static <a href="../../../../../../org/apache/beam/runners/dataflow/util/RandomAccessData.RandomAccessDataCoder.html" title="class in org.apache.beam.runners.dataflow.util">RandomAccessData.RandomAccessDataCoder</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/dataflow/util/RandomAccessData.RandomAccessDataCoder.html#of--">of</a></span>()</code> </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/runners/dataflow/util/RandomAccessData.RandomAccessDataCoder.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 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 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#getEncodedTypeDescriptor--">getEncodedTypeDescriptor</a>, <a href="../../../../../../org/apache/beam/sdk/coders/StructuredCoder.html#structuralValue-T-">structuralValue</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 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#registerByteSizeObserver-T-org.apache.beam.sdk.util.common.ElementByteSizeObserver-">registerByteSizeObserver</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 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="RandomAccessDataCoder--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>RandomAccessDataCoder</h4> +<pre>public RandomAccessDataCoder()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ 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 <a href="../../../../../../org/apache/beam/runners/dataflow/util/RandomAccessData.RandomAccessDataCoder.html" title="class in org.apache.beam.runners.dataflow.util">RandomAccessData.RandomAccessDataCoder</a> of()</pre> +</li> +</ul> +<a name="encode-org.apache.beam.runners.dataflow.util.RandomAccessData-java.io.OutputStream-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>encode</h4> +<pre>public void encode(<a href="../../../../../../org/apache/beam/runners/dataflow/util/RandomAccessData.html" title="class in org.apache.beam.runners.dataflow.util">RandomAccessData</a> value, + java.io.OutputStream outStream) + throws <a href="../../../../../../org/apache/beam/sdk/coders/CoderException.html" title="class in org.apache.beam.sdk.coders">CoderException</a>, + java.io.IOException</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from class: <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> in class <code><a href="../../../../../../org/apache/beam/sdk/coders/Coder.html" title="class in org.apache.beam.sdk.coders">Coder</a><<a href="../../../../../../org/apache/beam/runners/dataflow/util/RandomAccessData.html" title="class in org.apache.beam.runners.dataflow.util">RandomAccessData</a>></code></dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<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> +<dd><code>java.io.IOException</code> - if writing to the <code>OutputStream</code> fails + for some reason</dd> +</dl> +</li> +</ul> +<a name="encode-org.apache.beam.runners.dataflow.util.RandomAccessData-java.io.OutputStream-org.apache.beam.sdk.coders.Coder.Context-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>encode</h4> +<pre>public void encode(<a href="../../../../../../org/apache/beam/runners/dataflow/util/RandomAccessData.html" title="class in org.apache.beam.runners.dataflow.util">RandomAccessData</a> value, + java.io.OutputStream outStream, + <a href="../../../../../../org/apache/beam/sdk/coders/Coder.Context.html" title="class in org.apache.beam.sdk.coders">Coder.Context</a> context) + throws <a href="../../../../../../org/apache/beam/sdk/coders/CoderException.html" title="class in org.apache.beam.sdk.coders">CoderException</a>, + java.io.IOException</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from class: <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> in class <code><a href="../../../../../../org/apache/beam/sdk/coders/Coder.html" title="class in org.apache.beam.sdk.coders">Coder</a><<a href="../../../../../../org/apache/beam/runners/dataflow/util/RandomAccessData.html" title="class in org.apache.beam.runners.dataflow.util">RandomAccessData</a>></code></dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<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> +<dd><code>java.io.IOException</code> - if writing to the <code>OutputStream</code> fails + 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 <a href="../../../../../../org/apache/beam/runners/dataflow/util/RandomAccessData.html" title="class in org.apache.beam.runners.dataflow.util">RandomAccessData</a> decode(java.io.InputStream inStream) + throws <a href="../../../../../../org/apache/beam/sdk/coders/CoderException.html" title="class in org.apache.beam.sdk.coders">CoderException</a>, + java.io.IOException</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from class: <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> in class <code><a href="../../../../../../org/apache/beam/sdk/coders/Coder.html" title="class in org.apache.beam.sdk.coders">Coder</a><<a href="../../../../../../org/apache/beam/runners/dataflow/util/RandomAccessData.html" title="class in org.apache.beam.runners.dataflow.util">RandomAccessData</a>></code></dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<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> +<dd><code>java.io.IOException</code> - if reading from the <code>InputStream</code> fails + 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 <a href="../../../../../../org/apache/beam/runners/dataflow/util/RandomAccessData.html" title="class in org.apache.beam.runners.dataflow.util">RandomAccessData</a> decode(java.io.InputStream inStream, + <a href="../../../../../../org/apache/beam/sdk/coders/Coder.Context.html" title="class in org.apache.beam.sdk.coders">Coder.Context</a> context) + throws <a href="../../../../../../org/apache/beam/sdk/coders/CoderException.html" title="class in org.apache.beam.sdk.coders">CoderException</a>, + java.io.IOException</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from class: <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> in class <code><a href="../../../../../../org/apache/beam/sdk/coders/Coder.html" title="class in org.apache.beam.sdk.coders">Coder</a><<a href="../../../../../../org/apache/beam/runners/dataflow/util/RandomAccessData.html" title="class in org.apache.beam.runners.dataflow.util">RandomAccessData</a>></code></dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<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> +<dd><code>java.io.IOException</code> - if reading from the <code>InputStream</code> fails + for some reason</dd> +</dl> +</li> +</ul> +<a name="verifyDeterministic--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>verifyDeterministic</h4> +<pre>public void verifyDeterministic()</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from class: <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> in class <code><a href="../../../../../../org/apache/beam/sdk/coders/AtomicCoder.html" title="class in org.apache.beam.sdk.coders">AtomicCoder</a><<a href="../../../../../../org/apache/beam/runners/dataflow/util/RandomAccessData.html" title="class in org.apache.beam.runners.dataflow.util">RandomAccessData</a>></code></dd> +</dl> +</li> +</ul> +<a name="consistentWithEquals--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>consistentWithEquals</h4> +<pre>public boolean consistentWithEquals()</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../../org/apache/beam/sdk/coders/StructuredCoder.html#consistentWithEquals--">StructuredCoder</a></code></span></div> +<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/StructuredCoder.html#consistentWithEquals--">consistentWithEquals</a></code> in class <code><a href="../../../../../../org/apache/beam/sdk/coders/StructuredCoder.html" title="class in org.apache.beam.sdk.coders">StructuredCoder</a><<a href="../../../../../../org/apache/beam/runners/dataflow/util/RandomAccessData.html" title="class in org.apache.beam.runners.dataflow.util">RandomAccessData</a>></code></dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd><code>false</code> for <a href="../../../../../../org/apache/beam/sdk/coders/StructuredCoder.html" title="class in org.apache.beam.sdk.coders"><code>StructuredCoder</code></a> unless overridden.</dd> +</dl> +</li> +</ul> +<a name="isRegisterByteSizeObserverCheap-org.apache.beam.runners.dataflow.util.RandomAccessData-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isRegisterByteSizeObserverCheap</h4> +<pre>public boolean isRegisterByteSizeObserverCheap(<a href="../../../../../../org/apache/beam/runners/dataflow/util/RandomAccessData.html" title="class in org.apache.beam.runners.dataflow.util">RandomAccessData</a> value)</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../../org/apache/beam/sdk/coders/Coder.html#isRegisterByteSizeObserverCheap-T-">Coder</a></code></span></div> +<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> in class <code><a href="../../../../../../org/apache/beam/sdk/coders/Coder.html" title="class in org.apache.beam.sdk.coders">Coder</a><<a href="../../../../../../org/apache/beam/runners/dataflow/util/RandomAccessData.html" title="class in org.apache.beam.runners.dataflow.util">RandomAccessData</a>></code></dd> +</dl> +</li> +</ul> +<a name="getEncodedElementByteSize-org.apache.beam.runners.dataflow.util.RandomAccessData-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getEncodedElementByteSize</h4> +<pre>protected long getEncodedElementByteSize(<a href="../../../../../../org/apache/beam/runners/dataflow/util/RandomAccessData.html" title="class in org.apache.beam.runners.dataflow.util">RandomAccessData</a> value) + throws java.lang.Exception</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../../org/apache/beam/sdk/coders/Coder.html#getEncodedElementByteSize-T-">Coder</a></code></span></div> +<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> in class <code><a href="../../../../../../org/apache/beam/sdk/coders/Coder.html" title="class in org.apache.beam.sdk.coders">Coder</a><<a href="../../../../../../org/apache/beam/runners/dataflow/util/RandomAccessData.html" title="class in org.apache.beam.runners.dataflow.util">RandomAccessData</a>></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/runners/dataflow/util/RandomAccessData.html" title="class in org.apache.beam.runners.dataflow.util"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../../org/apache/beam/runners/dataflow/util/RandomAccessData.UnsignedLexicographicalComparator.html" title="class in org.apache.beam.runners.dataflow.util"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/beam/runners/dataflow/util/RandomAccessData.RandomAccessDataCoder.html" target="_top">Frames</a></li> +<li><a href="RandomAccessData.RandomAccessDataCoder.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li><a href="#nested.classes.inherited.from.class.org.apache.beam.sdk.coders.Coder">Nested</a> | </li> +<li>Field | </li> +<li><a href="#constructor.summary">Constr</a> | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor.detail">Constr</a> | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html>
http://git-wip-us.apache.org/repos/asf/beam-site/blob/c196579f/content/documentation/sdks/javadoc/2.0.0/org/apache/beam/runners/dataflow/util/RandomAccessData.UnsignedLexicographicalComparator.html ---------------------------------------------------------------------- diff --git a/content/documentation/sdks/javadoc/2.0.0/org/apache/beam/runners/dataflow/util/RandomAccessData.UnsignedLexicographicalComparator.html b/content/documentation/sdks/javadoc/2.0.0/org/apache/beam/runners/dataflow/util/RandomAccessData.UnsignedLexicographicalComparator.html new file mode 100644 index 0000000..c292d25 --- /dev/null +++ b/content/documentation/sdks/javadoc/2.0.0/org/apache/beam/runners/dataflow/util/RandomAccessData.UnsignedLexicographicalComparator.html @@ -0,0 +1,302 @@ +<!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_112-google-v7) on Fri May 12 16:50:04 PDT 2017 --> +<title>RandomAccessData.UnsignedLexicographicalComparator</title> +<meta name="date" content="2017-05-12"> +<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="RandomAccessData.UnsignedLexicographicalComparator"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10,"i1":10,"i2":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"; +</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/runners/dataflow/util/RandomAccessData.RandomAccessDataCoder.html" title="class in org.apache.beam.runners.dataflow.util"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../../org/apache/beam/runners/dataflow/util/Stager.html" title="interface in org.apache.beam.runners.dataflow.util"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/beam/runners/dataflow/util/RandomAccessData.UnsignedLexicographicalComparator.html" target="_top">Frames</a></li> +<li><a href="RandomAccessData.UnsignedLexicographicalComparator.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../../../allclasses-noframe.html">All 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: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </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.runners.dataflow.util</div> +<h2 title="Class RandomAccessData.UnsignedLexicographicalComparator" class="title">Class RandomAccessData.UnsignedLexicographicalComparator</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>org.apache.beam.runners.dataflow.util.RandomAccessData.UnsignedLexicographicalComparator</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd>java.util.Comparator<<a href="../../../../../../org/apache/beam/runners/dataflow/util/RandomAccessData.html" title="class in org.apache.beam.runners.dataflow.util">RandomAccessData</a>></dd> +</dl> +<dl> +<dt>Enclosing class:</dt> +<dd><a href="../../../../../../org/apache/beam/runners/dataflow/util/RandomAccessData.html" title="class in org.apache.beam.runners.dataflow.util">RandomAccessData</a></dd> +</dl> +<hr> +<br> +<pre>public static final class <span class="typeNameLabel">RandomAccessData.UnsignedLexicographicalComparator</span> +extends java.lang.Object +implements java.util.Comparator<<a href="../../../../../../org/apache/beam/runners/dataflow/util/RandomAccessData.html" title="class in org.apache.beam.runners.dataflow.util">RandomAccessData</a>></pre> +<div class="block">A <code>Comparator</code> that compares two byte arrays lexicographically. It compares + values as a list of unsigned bytes. The first pair of values that follow any common prefix, + or when one array is a prefix of the other, treats the shorter array as the lesser. + For example, <code>[] < [0x01] < [0x01, 0x7F] < [0x01, 0x80] < [0x02] < POSITIVE INFINITY</code>. + + <p>Note that a token type of positive infinity is supported and is greater than + all other <a href="../../../../../../org/apache/beam/runners/dataflow/util/RandomAccessData.html" title="class in org.apache.beam.runners.dataflow.util"><code>RandomAccessData</code></a>.</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========== 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"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr id="i0" class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/dataflow/util/RandomAccessData.UnsignedLexicographicalComparator.html#commonPrefixLength-org.apache.beam.runners.dataflow.util.RandomAccessData-org.apache.beam.runners.dataflow.util.RandomAccessData-">commonPrefixLength</a></span>(<a href="../../../../../../org/apache/beam/runners/dataflow/util/RandomAccessData.html" title="class in org.apache.beam.runners.dataflow.util">RandomAccessData</a> o1, + <a href="../../../../../../org/apache/beam/runners/dataflow/util/RandomAccessData.html" title="class in org.apache.beam.runners.dataflow.util">RandomAccessData</a> o2)</code> +<div class="block">Compute the length of the common prefix of the two provided sets of bytes.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/dataflow/util/RandomAccessData.UnsignedLexicographicalComparator.html#compare-org.apache.beam.runners.dataflow.util.RandomAccessData-org.apache.beam.runners.dataflow.util.RandomAccessData-">compare</a></span>(<a href="../../../../../../org/apache/beam/runners/dataflow/util/RandomAccessData.html" title="class in org.apache.beam.runners.dataflow.util">RandomAccessData</a> o1, + <a href="../../../../../../org/apache/beam/runners/dataflow/util/RandomAccessData.html" title="class in org.apache.beam.runners.dataflow.util">RandomAccessData</a> o2)</code> </td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/dataflow/util/RandomAccessData.UnsignedLexicographicalComparator.html#compare-org.apache.beam.runners.dataflow.util.RandomAccessData-org.apache.beam.runners.dataflow.util.RandomAccessData-int-">compare</a></span>(<a href="../../../../../../org/apache/beam/runners/dataflow/util/RandomAccessData.html" title="class in org.apache.beam.runners.dataflow.util">RandomAccessData</a> o1, + <a href="../../../../../../org/apache/beam/runners/dataflow/util/RandomAccessData.html" title="class in org.apache.beam.runners.dataflow.util">RandomAccessData</a> o2, + int startOffset)</code> +<div class="block">Compare the two sets of bytes starting at the given offset.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.Object</h3> +<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.java.util.Comparator"> +<!-- --> +</a> +<h3>Methods inherited from interface java.util.Comparator</h3> +<code>comparing, comparing, comparingDouble, comparingInt, comparingLong, equals, naturalOrder, nullsFirst, nullsLast, reversed, reverseOrder, thenComparing, thenComparing, thenComparing, thenComparingDouble, thenComparingInt, thenComparingLong</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="compare-org.apache.beam.runners.dataflow.util.RandomAccessData-org.apache.beam.runners.dataflow.util.RandomAccessData-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>compare</h4> +<pre>public int compare(<a href="../../../../../../org/apache/beam/runners/dataflow/util/RandomAccessData.html" title="class in org.apache.beam.runners.dataflow.util">RandomAccessData</a> o1, + <a href="../../../../../../org/apache/beam/runners/dataflow/util/RandomAccessData.html" title="class in org.apache.beam.runners.dataflow.util">RandomAccessData</a> o2)</pre> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code>compare</code> in interface <code>java.util.Comparator<<a href="../../../../../../org/apache/beam/runners/dataflow/util/RandomAccessData.html" title="class in org.apache.beam.runners.dataflow.util">RandomAccessData</a>></code></dd> +</dl> +</li> +</ul> +<a name="compare-org.apache.beam.runners.dataflow.util.RandomAccessData-org.apache.beam.runners.dataflow.util.RandomAccessData-int-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>compare</h4> +<pre>public int compare(<a href="../../../../../../org/apache/beam/runners/dataflow/util/RandomAccessData.html" title="class in org.apache.beam.runners.dataflow.util">RandomAccessData</a> o1, + <a href="../../../../../../org/apache/beam/runners/dataflow/util/RandomAccessData.html" title="class in org.apache.beam.runners.dataflow.util">RandomAccessData</a> o2, + int startOffset)</pre> +<div class="block">Compare the two sets of bytes starting at the given offset.</div> +</li> +</ul> +<a name="commonPrefixLength-org.apache.beam.runners.dataflow.util.RandomAccessData-org.apache.beam.runners.dataflow.util.RandomAccessData-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>commonPrefixLength</h4> +<pre>public int commonPrefixLength(<a href="../../../../../../org/apache/beam/runners/dataflow/util/RandomAccessData.html" title="class in org.apache.beam.runners.dataflow.util">RandomAccessData</a> o1, + <a href="../../../../../../org/apache/beam/runners/dataflow/util/RandomAccessData.html" title="class in org.apache.beam.runners.dataflow.util">RandomAccessData</a> o2)</pre> +<div class="block">Compute the length of the common prefix of the two provided sets of bytes.</div> +</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/runners/dataflow/util/RandomAccessData.RandomAccessDataCoder.html" title="class in org.apache.beam.runners.dataflow.util"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../../org/apache/beam/runners/dataflow/util/Stager.html" title="interface in org.apache.beam.runners.dataflow.util"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/beam/runners/dataflow/util/RandomAccessData.UnsignedLexicographicalComparator.html" target="_top">Frames</a></li> +<li><a href="RandomAccessData.UnsignedLexicographicalComparator.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html> http://git-wip-us.apache.org/repos/asf/beam-site/blob/c196579f/content/documentation/sdks/javadoc/2.0.0/org/apache/beam/runners/dataflow/util/RandomAccessData.html ---------------------------------------------------------------------- diff --git a/content/documentation/sdks/javadoc/2.0.0/org/apache/beam/runners/dataflow/util/RandomAccessData.html b/content/documentation/sdks/javadoc/2.0.0/org/apache/beam/runners/dataflow/util/RandomAccessData.html new file mode 100644 index 0000000..82724fb --- /dev/null +++ b/content/documentation/sdks/javadoc/2.0.0/org/apache/beam/runners/dataflow/util/RandomAccessData.html @@ -0,0 +1,603 @@ +<!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_112-google-v7) on Fri May 12 16:50:04 PDT 2017 --> +<title>RandomAccessData</title> +<meta name="date" content="2017-05-12"> +<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="RandomAccessData"; + } + } + catch(err) { + } +//--> +var methods = {"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"; +</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/runners/dataflow/util/PropertyNames.html" title="class in org.apache.beam.runners.dataflow.util"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../../org/apache/beam/runners/dataflow/util/RandomAccessData.RandomAccessDataCoder.html" title="class in org.apache.beam.runners.dataflow.util"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/beam/runners/dataflow/util/RandomAccessData.html" target="_top">Frames</a></li> +<li><a href="RandomAccessData.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../../../allclasses-noframe.html">All 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: </li> +<li><a href="#nested.class.summary">Nested</a> | </li> +<li><a href="#field.summary">Field</a> | </li> +<li><a href="#constructor.summary">Constr</a> | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#field.detail">Field</a> | </li> +<li><a href="#constructor.detail">Constr</a> | </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.runners.dataflow.util</div> +<h2 title="Class RandomAccessData" class="title">Class RandomAccessData</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>org.apache.beam.runners.dataflow.util.RandomAccessData</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>@NotThreadSafe +public class <span class="typeNameLabel">RandomAccessData</span> +extends java.lang.Object</pre> +<div class="block">An elastic-sized byte array which allows you to manipulate it as a stream, or access + it directly. This allows for a quick succession of moving bytes from an <code>InputStream</code> + to this wrapper to be used as an <code>OutputStream</code> and vice versa. This wrapper + also provides random access to bytes stored within. This wrapper allows users to finely + control the number of byte copies that occur. + + <p>Anything stored within the in-memory buffer from offset <a href="../../../../../../org/apache/beam/runners/dataflow/util/RandomAccessData.html#size--"><code>size()</code></a> is considered + temporary unused storage.</div> +</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> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> +<caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Class and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static class </code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/dataflow/util/RandomAccessData.RandomAccessDataCoder.html" title="class in org.apache.beam.runners.dataflow.util">RandomAccessData.RandomAccessDataCoder</a></span></code> +<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> which encodes the valid parts of this stream.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static class </code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/dataflow/util/RandomAccessData.UnsignedLexicographicalComparator.html" title="class in org.apache.beam.runners.dataflow.util">RandomAccessData.UnsignedLexicographicalComparator</a></span></code> +<div class="block">A <code>Comparator</code> that compares two byte arrays lexicographically.</div> +</td> +</tr> +</table> +</li> +</ul> +<!-- =========== FIELD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field.summary"> +<!-- --> +</a> +<h3>Field Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> +<caption><span>Fields</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Field and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <a href="../../../../../../org/apache/beam/runners/dataflow/util/RandomAccessData.UnsignedLexicographicalComparator.html" title="class in org.apache.beam.runners.dataflow.util">RandomAccessData.UnsignedLexicographicalComparator</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/dataflow/util/RandomAccessData.html#UNSIGNED_LEXICOGRAPHICAL_COMPARATOR">UNSIGNED_LEXICOGRAPHICAL_COMPARATOR</a></span></code> </td> +</tr> +</table> +</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"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/dataflow/util/RandomAccessData.html#RandomAccessData--">RandomAccessData</a></span>()</code> +<div class="block">Constructs a RandomAccessData with a default buffer size.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/dataflow/util/RandomAccessData.html#RandomAccessData-byte:A-">RandomAccessData</a></span>(byte[] initialBuffer)</code> +<div class="block">Constructs a RandomAccessData with the initial buffer.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/dataflow/util/RandomAccessData.html#RandomAccessData-int-">RandomAccessData</a></span>(int initialBufferSize)</code> +<div class="block">Constructs a RandomAccessData with the given buffer size.</div> +</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"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr id="i0" class="altColor"> +<td class="colFirst"><code>byte[]</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/dataflow/util/RandomAccessData.html#array--">array</a></span>()</code> +<div class="block">Returns the backing array.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>java.io.InputStream</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/dataflow/util/RandomAccessData.html#asInputStream-int-int-">asInputStream</a></span>(int offset, + int length)</code> +<div class="block">Returns an <code>InputStream</code> wrapper which supplies the portion of this backing byte buffer + starting at <code>offset</code> and up to <code>length</code> bytes.</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code>java.io.OutputStream</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/dataflow/util/RandomAccessData.html#asOutputStream--">asOutputStream</a></span>()</code> +<div class="block">Returns an output stream which writes to the backing buffer from the current position.</div> +</td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code><a href="../../../../../../org/apache/beam/runners/dataflow/util/RandomAccessData.html" title="class in org.apache.beam.runners.dataflow.util">RandomAccessData</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/dataflow/util/RandomAccessData.html#copy--">copy</a></span>()</code> +<div class="block">Returns a copy of this RandomAccessData.</div> +</td> +</tr> +<tr id="i4" class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/dataflow/util/RandomAccessData.html#equals-java.lang.Object-">equals</a></span>(java.lang.Object other)</code> </td> +</tr> +<tr id="i5" class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/dataflow/util/RandomAccessData.html#hashCode--">hashCode</a></span>()</code> </td> +</tr> +<tr id="i6" class="altColor"> +<td class="colFirst"><code><a href="../../../../../../org/apache/beam/runners/dataflow/util/RandomAccessData.html" title="class in org.apache.beam.runners.dataflow.util">RandomAccessData</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/dataflow/util/RandomAccessData.html#increment--">increment</a></span>()</code> +<div class="block">Returns a RandomAccessData that is the smallest value of same length which + is strictly greater than this.</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/runners/dataflow/util/RandomAccessData.html#readFrom-java.io.InputStream-int-int-">readFrom</a></span>(java.io.InputStream inStream, + int offset, + int length)</code> +<div class="block">Reads <code>length</code> bytes from the specified input stream writing them into the backing + data store starting at <code>offset</code>.</div> +</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/runners/dataflow/util/RandomAccessData.html#resetTo-int-">resetTo</a></span>(int position)</code> +<div class="block">Resets the end of the stream to the specified position.</div> +</td> +</tr> +<tr id="i9" class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/dataflow/util/RandomAccessData.html#size--">size</a></span>()</code> +<div class="block">Returns the number of bytes in the backing array that are valid.</div> +</td> +</tr> +<tr id="i10" class="altColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/dataflow/util/RandomAccessData.html#toString--">toString</a></span>()</code> </td> +</tr> +<tr id="i11" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/dataflow/util/RandomAccessData.html#writeTo-java.io.OutputStream-int-int-">writeTo</a></span>(java.io.OutputStream out, + int offset, + int length)</code> +<div class="block">Writes <code>length</code> bytes starting at <code>offset</code> from the backing data store to the + specified output stream.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class 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"> +<!-- ============ FIELD DETAIL =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field.detail"> +<!-- --> +</a> +<h3>Field Detail</h3> +<a name="UNSIGNED_LEXICOGRAPHICAL_COMPARATOR"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>UNSIGNED_LEXICOGRAPHICAL_COMPARATOR</h4> +<pre>public static final <a href="../../../../../../org/apache/beam/runners/dataflow/util/RandomAccessData.UnsignedLexicographicalComparator.html" title="class in org.apache.beam.runners.dataflow.util">RandomAccessData.UnsignedLexicographicalComparator</a> UNSIGNED_LEXICOGRAPHICAL_COMPARATOR</pre> +</li> +</ul> +</li> +</ul> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="RandomAccessData--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>RandomAccessData</h4> +<pre>public RandomAccessData()</pre> +<div class="block">Constructs a RandomAccessData with a default buffer size.</div> +</li> +</ul> +<a name="RandomAccessData-byte:A-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>RandomAccessData</h4> +<pre>public RandomAccessData(byte[] initialBuffer)</pre> +<div class="block">Constructs a RandomAccessData with the initial buffer.</div> +</li> +</ul> +<a name="RandomAccessData-int-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>RandomAccessData</h4> +<pre>public RandomAccessData(int initialBufferSize)</pre> +<div class="block">Constructs a RandomAccessData with the given buffer size.</div> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="increment--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>increment</h4> +<pre>public <a href="../../../../../../org/apache/beam/runners/dataflow/util/RandomAccessData.html" title="class in org.apache.beam.runners.dataflow.util">RandomAccessData</a> increment() + throws java.io.IOException</pre> +<div class="block">Returns a RandomAccessData that is the smallest value of same length which + is strictly greater than this. Note that if this is empty or is all 0xFF then + a token value of positive infinity is returned. + + <p>The <a href="../../../../../../org/apache/beam/runners/dataflow/util/RandomAccessData.UnsignedLexicographicalComparator.html" title="class in org.apache.beam.runners.dataflow.util"><code>RandomAccessData.UnsignedLexicographicalComparator</code></a> supports comparing <a href="../../../../../../org/apache/beam/runners/dataflow/util/RandomAccessData.html" title="class in org.apache.beam.runners.dataflow.util"><code>RandomAccessData</code></a> + with support for positive infinitiy.</div> +<dl> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>java.io.IOException</code></dd> +</dl> +</li> +</ul> +<a name="array--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>array</h4> +<pre>public byte[] array()</pre> +<div class="block">Returns the backing array.</div> +</li> +</ul> +<a name="size--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>size</h4> +<pre>public int size()</pre> +<div class="block">Returns the number of bytes in the backing array that are valid.</div> +</li> +</ul> +<a name="resetTo-int-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>resetTo</h4> +<pre>public void resetTo(int position)</pre> +<div class="block">Resets the end of the stream to the specified position.</div> +</li> +</ul> +<a name="asOutputStream--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>asOutputStream</h4> +<pre>public java.io.OutputStream asOutputStream()</pre> +<div class="block">Returns an output stream which writes to the backing buffer from the current position. + Note that the internal buffer will grow as required to accomodate all data written.</div> +</li> +</ul> +<a name="asInputStream-int-int-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>asInputStream</h4> +<pre>public java.io.InputStream asInputStream(int offset, + int length)</pre> +<div class="block">Returns an <code>InputStream</code> wrapper which supplies the portion of this backing byte buffer + starting at <code>offset</code> and up to <code>length</code> bytes. Note that the returned + <code>InputStream</code> is only a wrapper and any modifications to the underlying + <a href="../../../../../../org/apache/beam/runners/dataflow/util/RandomAccessData.html" title="class in org.apache.beam.runners.dataflow.util"><code>RandomAccessData</code></a> will be visible by the <code>InputStream</code>.</div> +</li> +</ul> +<a name="writeTo-java.io.OutputStream-int-int-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>writeTo</h4> +<pre>public void writeTo(java.io.OutputStream out, + int offset, + int length) + throws java.io.IOException</pre> +<div class="block">Writes <code>length</code> bytes starting at <code>offset</code> from the backing data store to the + specified output stream.</div> +<dl> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>java.io.IOException</code></dd> +</dl> +</li> +</ul> +<a name="readFrom-java.io.InputStream-int-int-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>readFrom</h4> +<pre>public void readFrom(java.io.InputStream inStream, + int offset, + int length) + throws java.io.IOException</pre> +<div class="block">Reads <code>length</code> bytes from the specified input stream writing them into the backing + data store starting at <code>offset</code>. + + <p>Note that the in memory stream will be grown to ensure there is enough capacity.</div> +<dl> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>java.io.IOException</code></dd> +</dl> +</li> +</ul> +<a name="copy--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>copy</h4> +<pre>public <a href="../../../../../../org/apache/beam/runners/dataflow/util/RandomAccessData.html" title="class in org.apache.beam.runners.dataflow.util">RandomAccessData</a> copy() + throws java.io.IOException</pre> +<div class="block">Returns a copy of this RandomAccessData.</div> +<dl> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>java.io.IOException</code></dd> +</dl> +</li> +</ul> +<a name="equals-java.lang.Object-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>equals</h4> +<pre>public boolean equals(java.lang.Object other)</pre> +<dl> +<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> +<dd><code>equals</code> in class <code>java.lang.Object</code></dd> +</dl> +</li> +</ul> +<a name="hashCode--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>hashCode</h4> +<pre>public int hashCode()</pre> +<dl> +<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> +<dd><code>hashCode</code> in class <code>java.lang.Object</code></dd> +</dl> +</li> +</ul> +<a name="toString--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>toString</h4> +<pre>public java.lang.String toString()</pre> +<dl> +<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> +<dd><code>toString</code> in class <code>java.lang.Object</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/runners/dataflow/util/PropertyNames.html" title="class in org.apache.beam.runners.dataflow.util"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../../org/apache/beam/runners/dataflow/util/RandomAccessData.RandomAccessDataCoder.html" title="class in org.apache.beam.runners.dataflow.util"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/beam/runners/dataflow/util/RandomAccessData.html" target="_top">Frames</a></li> +<li><a href="RandomAccessData.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li><a href="#nested.class.summary">Nested</a> | </li> +<li><a href="#field.summary">Field</a> | </li> +<li><a href="#constructor.summary">Constr</a> | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#field.detail">Field</a> | </li> +<li><a href="#constructor.detail">Constr</a> | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html>
