blob: fe829d3a783f312244b93090425978bc69d611cf [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_201) on Thu Apr 11 20:05:14 EDT 2019 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>org.apache.accumulo.core.client.lexicoder (Apache Accumulo Project 1.9.3 API)</title>
<meta name="date" content="2019-04-11">
<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="org.apache.accumulo.core.client.lexicoder (Apache Accumulo Project 1.9.3 API)";
}
}
catch(err) {
}
//-->
</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 class="navBarCell1Rev">Package</li>
<li>Class</li>
<li><a href="package-use.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../../org/apache/accumulo/core/client/admin/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../../../org/apache/accumulo/core/client/mapred/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/accumulo/core/client/lexicoder/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<div class="header">
<h1 title="Package" class="title">Package&nbsp;org.apache.accumulo.core.client.lexicoder</h1>
</div>
<div class="contentContainer">
<ul class="blockList">
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Interface Summary table, listing interfaces, and an explanation">
<caption><span>Interface Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Interface</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/accumulo/core/client/lexicoder/Encoder.html" title="interface in org.apache.accumulo.core.client.lexicoder">Encoder</a>&lt;T&gt;</td>
<td class="colLast">
<div class="block">An encoder represents a typed object that can be encoded/decoded to/from a byte array.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/accumulo/core/client/lexicoder/Lexicoder.html" title="interface in org.apache.accumulo.core.client.lexicoder">Lexicoder</a>&lt;T&gt;</td>
<td class="colLast">
<div class="block">A lexicoder provides methods to convert to/from byte arrays.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation">
<caption><span>Class Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/accumulo/core/client/lexicoder/AbstractEncoder.html" title="class in org.apache.accumulo.core.client.lexicoder">AbstractEncoder</a>&lt;T&gt;</td>
<td class="colLast">
<div class="block">AbstractEncoder is an <a href="../../../../../../org/apache/accumulo/core/client/lexicoder/Encoder.html" title="interface in org.apache.accumulo.core.client.lexicoder"><code>Encoder</code></a> that implements
all of Encoder's methods validating the input, but has those methods defer logic to to a new
method, <a href="../../../../../../org/apache/accumulo/core/client/lexicoder/AbstractEncoder.html#decodeUnchecked-byte:A-int-int-"><code>AbstractEncoder.decodeUnchecked(byte[], int, int)</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/accumulo/core/client/lexicoder/BigIntegerLexicoder.html" title="class in org.apache.accumulo.core.client.lexicoder">BigIntegerLexicoder</a></td>
<td class="colLast">
<div class="block">A lexicoder to encode/decode a BigInteger to/from bytes that maintain its native Java sort order.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/accumulo/core/client/lexicoder/BytesLexicoder.html" title="class in org.apache.accumulo.core.client.lexicoder">BytesLexicoder</a></td>
<td class="colLast">
<div class="block">For each of the methods, this lexicoder just passes the input through untouched.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/accumulo/core/client/lexicoder/DateLexicoder.html" title="class in org.apache.accumulo.core.client.lexicoder">DateLexicoder</a></td>
<td class="colLast">
<div class="block">A lexicoder for date objects.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/accumulo/core/client/lexicoder/DoubleLexicoder.html" title="class in org.apache.accumulo.core.client.lexicoder">DoubleLexicoder</a></td>
<td class="colLast">
<div class="block">A lexicoder for preserving the native Java sort order of Double values.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/accumulo/core/client/lexicoder/FloatLexicoder.html" title="class in org.apache.accumulo.core.client.lexicoder">FloatLexicoder</a></td>
<td class="colLast">
<div class="block">A lexicoder for preserving the native Java sort order of Float values.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/accumulo/core/client/lexicoder/IntegerLexicoder.html" title="class in org.apache.accumulo.core.client.lexicoder">IntegerLexicoder</a></td>
<td class="colLast">
<div class="block">A lexicoder for signed integers.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/accumulo/core/client/lexicoder/ListLexicoder.html" title="class in org.apache.accumulo.core.client.lexicoder">ListLexicoder</a>&lt;LT&gt;</td>
<td class="colLast">
<div class="block">A lexicoder to encode/decode a Java List to/from a byte array where the concatenation of each
encoded element sorts lexicographically.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/accumulo/core/client/lexicoder/LongLexicoder.html" title="class in org.apache.accumulo.core.client.lexicoder">LongLexicoder</a></td>
<td class="colLast">
<div class="block">Signed long lexicoder.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/accumulo/core/client/lexicoder/PairLexicoder.html" title="class in org.apache.accumulo.core.client.lexicoder">PairLexicoder</a>&lt;A extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang">Comparable</a>&lt;A&gt;,B extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang">Comparable</a>&lt;B&gt;&gt;</td>
<td class="colLast">
<div class="block">This class is a lexicoder that sorts a ComparablePair.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/accumulo/core/client/lexicoder/ReverseLexicoder.html" title="class in org.apache.accumulo.core.client.lexicoder">ReverseLexicoder</a>&lt;T&gt;</td>
<td class="colLast">
<div class="block">A lexicoder that flips the sort order from another lexicoder.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/accumulo/core/client/lexicoder/StringLexicoder.html" title="class in org.apache.accumulo.core.client.lexicoder">StringLexicoder</a></td>
<td class="colLast">
<div class="block">This lexicoder encodes/decodes a given String to/from bytes without further processing.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/accumulo/core/client/lexicoder/TextLexicoder.html" title="class in org.apache.accumulo.core.client.lexicoder">TextLexicoder</a></td>
<td class="colLast">
<div class="block">A lexicoder that preserves a Text's native sort order.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/accumulo/core/client/lexicoder/UIntegerLexicoder.html" title="class in org.apache.accumulo.core.client.lexicoder">UIntegerLexicoder</a></td>
<td class="colLast">
<div class="block">A lexicoder for an unsigned integer.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/accumulo/core/client/lexicoder/ULongLexicoder.html" title="class in org.apache.accumulo.core.client.lexicoder">ULongLexicoder</a></td>
<td class="colLast">
<div class="block">Unsigned long lexicoder.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/accumulo/core/client/lexicoder/UUIDLexicoder.html" title="class in org.apache.accumulo.core.client.lexicoder">UUIDLexicoder</a></td>
<td class="colLast">
<div class="block">A lexicoder for a UUID that maintains its lexicographic sorting order.</div>
</td>
</tr>
</tbody>
</table>
</li>
</ul>
</div>
<!-- ======= 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 class="navBarCell1Rev">Package</li>
<li>Class</li>
<li><a href="package-use.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../../org/apache/accumulo/core/client/admin/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../../../org/apache/accumulo/core/client/mapred/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/accumulo/core/client/lexicoder/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2011&#x2013;2019 <a href="https://www.apache.org">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>