blob: 9109b364b753b3336e6768b060b2cf8e7b0975cf [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 (version 1.7.0_80) on Tue Aug 30 09:57:31 EDT 2016 -->
<title>BytesArrayWritable</title>
<meta name="date" content="2016-08-30">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="BytesArrayWritable";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><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="class-use/BytesArrayWritable.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-files/index-1.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/pirk/inputformat/hadoop/BaseInputFormat.html" title="class in org.apache.pirk.inputformat.hadoop"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../org/apache/pirk/inputformat/hadoop/InputFormatConst.html" title="class in org.apache.pirk.inputformat.hadoop"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/pirk/inputformat/hadoop/BytesArrayWritable.html" target="_top">Frames</a></li>
<li><a href="BytesArrayWritable.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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.pirk.inputformat.hadoop</div>
<h2 title="Class BytesArrayWritable" class="title">Class BytesArrayWritable</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.apache.hadoop.io.ArrayWritable</li>
<li>
<ul class="inheritance">
<li>org.apache.pirk.inputformat.hadoop.BytesArrayWritable</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>org.apache.hadoop.io.Writable</dd>
</dl>
<hr>
<br>
<pre>public class <span class="strong">BytesArrayWritable</span>
extends org.apache.hadoop.io.ArrayWritable</pre>
<div class="block">ArrayWritable class with ByteWritable entries</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../../../org/apache/pirk/inputformat/hadoop/BytesArrayWritable.html#BytesArrayWritable()">BytesArrayWritable</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../../../../org/apache/pirk/inputformat/hadoop/BytesArrayWritable.html#BytesArrayWritable(byte[][])">BytesArrayWritable</a></strong>(byte[][]&nbsp;elements)</code>
<div class="block">Constructor for use when underlying array will be BytesWritable representations of byte[]</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../../../org/apache/pirk/inputformat/hadoop/BytesArrayWritable.html#BytesArrayWritable(java.util.List)">BytesArrayWritable</a></strong>(java.util.List&lt;java.math.BigInteger&gt;&nbsp;elements)</code>
<div class="block">Constructor for use when underlying array will be ByteWritable representations of BigInteger objects</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="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>org.apache.hadoop.io.BytesWritable</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/pirk/inputformat/hadoop/BytesArrayWritable.html#get(int)">get</a></strong>(int&nbsp;i)</code>
<div class="block">Return the ith element as a BytesWritable</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.math.BigInteger</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/pirk/inputformat/hadoop/BytesArrayWritable.html#getBigInteger(int)">getBigInteger</a></strong>(int&nbsp;i)</code>
<div class="block">Return the ith element from the underlying array</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/pirk/inputformat/hadoop/BytesArrayWritable.html#getByteAsInt(int)">getByteAsInt</a></strong>(int&nbsp;i)</code>
<div class="block">Return the ith element as an int</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>byte[]</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/pirk/inputformat/hadoop/BytesArrayWritable.html#getBytes(int)">getBytes</a></strong>(int&nbsp;i)</code>
<div class="block">Return the ith element as a byte array</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/pirk/inputformat/hadoop/BytesArrayWritable.html#size()">size</a></strong>()</code>
<div class="block">Returns the number of elements in the underlying array</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_org.apache.hadoop.io.ArrayWritable">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.hadoop.io.ArrayWritable</h3>
<code>get, getValueClass, readFields, set, toArray, toStrings, write</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>equals, getClass, hashCode, notify, notifyAll, toString, 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="BytesArrayWritable()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>BytesArrayWritable</h4>
<pre>public&nbsp;BytesArrayWritable()</pre>
</li>
</ul>
<a name="BytesArrayWritable(byte[][])">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>BytesArrayWritable</h4>
<pre>public&nbsp;BytesArrayWritable(byte[][]&nbsp;elements)</pre>
<div class="block">Constructor for use when underlying array will be BytesWritable representations of byte[]</div>
</li>
</ul>
<a name="BytesArrayWritable(java.util.List)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>BytesArrayWritable</h4>
<pre>public&nbsp;BytesArrayWritable(java.util.List&lt;java.math.BigInteger&gt;&nbsp;elements)</pre>
<div class="block">Constructor for use when underlying array will be ByteWritable representations of BigInteger objects</div>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="size()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>size</h4>
<pre>public&nbsp;int&nbsp;size()</pre>
<div class="block">Returns the number of elements in the underlying array</div>
</li>
</ul>
<a name="getBigInteger(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBigInteger</h4>
<pre>public&nbsp;java.math.BigInteger&nbsp;getBigInteger(int&nbsp;i)
throws java.io.IOException</pre>
<div class="block">Return the ith element from the underlying array
<p>
Assumes that the underlying array consists of BytesWritable representations of BigInteger objects
<p>
Assumes that the underlying BigIntegers are unsigned, but have been stripped of zero padding (and hence the sign bit) -- must add it back in</div>
<dl><dt><span class="strong">Throws:</span></dt>
<dd><code>java.io.IOException</code></dd></dl>
</li>
</ul>
<a name="get(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>get</h4>
<pre>public&nbsp;org.apache.hadoop.io.BytesWritable&nbsp;get(int&nbsp;i)</pre>
<div class="block">Return the ith element as a BytesWritable</div>
</li>
</ul>
<a name="getBytes(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBytes</h4>
<pre>public&nbsp;byte[]&nbsp;getBytes(int&nbsp;i)</pre>
<div class="block">Return the ith element as a byte array</div>
</li>
</ul>
<a name="getByteAsInt(int)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getByteAsInt</h4>
<pre>public&nbsp;int&nbsp;getByteAsInt(int&nbsp;i)</pre>
<div class="block">Return the ith element as an int</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><a href="#skip-navbar_bottom" title="Skip navigation links"></a><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="class-use/BytesArrayWritable.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-files/index-1.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/pirk/inputformat/hadoop/BaseInputFormat.html" title="class in org.apache.pirk.inputformat.hadoop"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../org/apache/pirk/inputformat/hadoop/InputFormatConst.html" title="class in org.apache.pirk.inputformat.hadoop"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/pirk/inputformat/hadoop/BytesArrayWritable.html" target="_top">Frames</a></li>
<li><a href="BytesArrayWritable.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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>