stasis/je-7.5.11/docs/java/com/sleepycat/util/UtfOps.html
2019-06-25 16:12:40 -04:00

554 lines
21 KiB
HTML

<!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_151) on Tue Oct 31 17:36:47 EDT 2017 -->
<title>UtfOps (Oracle - Berkeley DB Java Edition API)</title>
<meta name="date" content="2017-10-31">
<link rel="stylesheet" type="text/css" href="../../../style.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="UtfOps (Oracle - Berkeley DB Java Edition API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":9,"i1":9,"i2":9,"i3":9,"i4":9,"i5":9,"i6":9,"i7":9,"i8":9};
var tabs = {65535:["t0","All Methods"],1:["t1","Static 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="class-use/UtfOps.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 class="aboutLanguage"><b>Berkeley DB Java Edition</b><br><font size=\"-1\"> version 7.5.11</font>
</div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../com/sleepycat/util/RuntimeExceptionWrapper.html" title="class in com.sleepycat.util"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li>Next&nbsp;Class</li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?com/sleepycat/util/UtfOps.html" target="_top">Frames</a></li>
<li><a href="UtfOps.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>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">com.sleepycat.util</div>
<h2 title="Class UtfOps" class="title">Class UtfOps</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>com.sleepycat.util.UtfOps</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="typeNameLabel">UtfOps</span>
extends java.lang.Object</pre>
<div class="block">UTF operations with more flexibility than is provided by DataInput and
DataOutput.</div>
<dl>
<dt><span class="simpleTagLabel">Author:</span></dt>
<dd>Mark Hayes</dd>
</dl>
</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="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../com/sleepycat/util/UtfOps.html#UtfOps--">UtfOps</a></span>()</code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/sleepycat/util/UtfOps.html#bytesToChars-byte:A-int-char:A-int-int-boolean-">bytesToChars</a></span>(byte[]&nbsp;bytes,
int&nbsp;byteOffset,
char[]&nbsp;chars,
int&nbsp;charOffset,
int&nbsp;len,
boolean&nbsp;isByteLen)</code>
<div class="block">Converts byte arrays into character arrays.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/sleepycat/util/UtfOps.html#bytesToString-byte:A-int-int-">bytesToString</a></span>(byte[]&nbsp;bytes,
int&nbsp;offset,
int&nbsp;length)</code>
<div class="block">Converts byte arrays into strings.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/sleepycat/util/UtfOps.html#charsToBytes-char:A-int-byte:A-int-int-">charsToBytes</a></span>(char[]&nbsp;chars,
int&nbsp;charOffset,
byte[]&nbsp;bytes,
int&nbsp;byteOffset,
int&nbsp;charLength)</code>
<div class="block">Converts character arrays into byte arrays.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/sleepycat/util/UtfOps.html#getByteLength-char:A-">getByteLength</a></span>(char[]&nbsp;chars)</code>
<div class="block">Returns the byte length of the UTF string that would be created by
converting the given characters to UTF.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/sleepycat/util/UtfOps.html#getByteLength-char:A-int-int-">getByteLength</a></span>(char[]&nbsp;chars,
int&nbsp;offset,
int&nbsp;length)</code>
<div class="block">Returns the byte length of the UTF string that would be created by
converting the given characters to UTF.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/sleepycat/util/UtfOps.html#getCharLength-byte:A-">getCharLength</a></span>(byte[]&nbsp;bytes)</code>
<div class="block">Returns the number of characters represented by the given UTF string.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/sleepycat/util/UtfOps.html#getCharLength-byte:A-int-int-">getCharLength</a></span>(byte[]&nbsp;bytes,
int&nbsp;offset,
int&nbsp;length)</code>
<div class="block">Returns the number of characters represented by the given UTF string.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/sleepycat/util/UtfOps.html#getZeroTerminatedByteLength-byte:A-int-">getZeroTerminatedByteLength</a></span>(byte[]&nbsp;bytes,
int&nbsp;offset)</code>
<div class="block">Returns the byte length of a null terminated UTF string, not including
the terminator.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>static byte[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/sleepycat/util/UtfOps.html#stringToBytes-java.lang.String-">stringToBytes</a></span>(java.lang.String&nbsp;string)</code>
<div class="block">Converts strings to byte arrays.</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&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, 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="UtfOps--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>UtfOps</h4>
<pre>public&nbsp;UtfOps()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getZeroTerminatedByteLength-byte:A-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getZeroTerminatedByteLength</h4>
<pre>public static&nbsp;int&nbsp;getZeroTerminatedByteLength(byte[]&nbsp;bytes,
int&nbsp;offset)
throws java.lang.IndexOutOfBoundsException</pre>
<div class="block">Returns the byte length of a null terminated UTF string, not including
the terminator.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>bytes</code> - the data containing the UTF string.</dd>
<dd><code>offset</code> - the beginning of the string the measure.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the number of bytes.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IndexOutOfBoundsException</code> - if no zero terminator is found.</dd>
</dl>
</li>
</ul>
<a name="getByteLength-char:A-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getByteLength</h4>
<pre>public static&nbsp;int&nbsp;getByteLength(char[]&nbsp;chars)</pre>
<div class="block">Returns the byte length of the UTF string that would be created by
converting the given characters to UTF.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>chars</code> - the characters that would be converted.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the byte length of the equivalent UTF data.</dd>
</dl>
</li>
</ul>
<a name="getByteLength-char:A-int-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getByteLength</h4>
<pre>public static&nbsp;int&nbsp;getByteLength(char[]&nbsp;chars,
int&nbsp;offset,
int&nbsp;length)</pre>
<div class="block">Returns the byte length of the UTF string that would be created by
converting the given characters to UTF.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>chars</code> - the characters that would be converted.</dd>
<dd><code>offset</code> - the first character to be converted.</dd>
<dd><code>length</code> - the number of characters to be converted.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the byte length of the equivalent UTF data.</dd>
</dl>
</li>
</ul>
<a name="getCharLength-byte:A-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCharLength</h4>
<pre>public static&nbsp;int&nbsp;getCharLength(byte[]&nbsp;bytes)
throws java.lang.IllegalArgumentException,
java.lang.IndexOutOfBoundsException</pre>
<div class="block">Returns the number of characters represented by the given UTF string.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>bytes</code> - the UTF string.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the number of characters.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IndexOutOfBoundsException</code> - if a UTF character sequence at the end
of the data is not complete.</dd>
<dd><code>java.lang.IllegalArgumentException</code> - if an illegal UTF sequence is
encountered.</dd>
</dl>
</li>
</ul>
<a name="getCharLength-byte:A-int-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCharLength</h4>
<pre>public static&nbsp;int&nbsp;getCharLength(byte[]&nbsp;bytes,
int&nbsp;offset,
int&nbsp;length)
throws java.lang.IllegalArgumentException,
java.lang.IndexOutOfBoundsException</pre>
<div class="block">Returns the number of characters represented by the given UTF string.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>bytes</code> - the data containing the UTF string.</dd>
<dd><code>offset</code> - the first byte to be converted.</dd>
<dd><code>length</code> - the number of byte to be converted.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the number of characters.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IndexOutOfBoundsException</code> - if a UTF character sequence at the end
of the data is not complete.</dd>
<dd><code>java.lang.IllegalArgumentException</code> - if an illegal UTF sequence is
encountered.</dd>
</dl>
</li>
</ul>
<a name="bytesToChars-byte:A-int-char:A-int-int-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>bytesToChars</h4>
<pre>public static&nbsp;int&nbsp;bytesToChars(byte[]&nbsp;bytes,
int&nbsp;byteOffset,
char[]&nbsp;chars,
int&nbsp;charOffset,
int&nbsp;len,
boolean&nbsp;isByteLen)
throws java.lang.IllegalArgumentException,
java.lang.IndexOutOfBoundsException</pre>
<div class="block">Converts byte arrays into character arrays.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>bytes</code> - the source byte data to convert</dd>
<dd><code>byteOffset</code> - the offset into the byte array at which
to start the conversion</dd>
<dd><code>chars</code> - the destination array</dd>
<dd><code>charOffset</code> - the offset into chars at which to begin the copy</dd>
<dd><code>len</code> - the amount of information to copy into chars</dd>
<dd><code>isByteLen</code> - if true then len is a measure of bytes, otherwise
len is a measure of characters</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the byte offset after converting the bytes.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IndexOutOfBoundsException</code> - if a UTF character sequence at the end
of the data is not complete.</dd>
<dd><code>java.lang.IllegalArgumentException</code> - if an illegal UTF sequence is
encountered.</dd>
</dl>
</li>
</ul>
<a name="charsToBytes-char:A-int-byte:A-int-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>charsToBytes</h4>
<pre>public static&nbsp;void&nbsp;charsToBytes(char[]&nbsp;chars,
int&nbsp;charOffset,
byte[]&nbsp;bytes,
int&nbsp;byteOffset,
int&nbsp;charLength)</pre>
<div class="block">Converts character arrays into byte arrays.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>chars</code> - the source character data to convert</dd>
<dd><code>charOffset</code> - the offset into the character array at which
to start the conversion</dd>
<dd><code>bytes</code> - the destination array</dd>
<dd><code>byteOffset</code> - the offset into bytes at which to begin the copy</dd>
<dd><code>charLength</code> - the length of characters to copy into bytes</dd>
</dl>
</li>
</ul>
<a name="bytesToString-byte:A-int-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>bytesToString</h4>
<pre>public static&nbsp;java.lang.String&nbsp;bytesToString(byte[]&nbsp;bytes,
int&nbsp;offset,
int&nbsp;length)
throws java.lang.IllegalArgumentException,
java.lang.IndexOutOfBoundsException</pre>
<div class="block">Converts byte arrays into strings.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>bytes</code> - the source byte data to convert</dd>
<dd><code>offset</code> - the offset into the byte array at which
to start the conversion</dd>
<dd><code>length</code> - the number of bytes to be converted.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the string.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IndexOutOfBoundsException</code> - if a UTF character sequence at the end
of the data is not complete.</dd>
<dd><code>java.lang.IllegalArgumentException</code> - if an illegal UTF sequence is
encountered.</dd>
</dl>
</li>
</ul>
<a name="stringToBytes-java.lang.String-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>stringToBytes</h4>
<pre>public static&nbsp;byte[]&nbsp;stringToBytes(java.lang.String&nbsp;string)</pre>
<div class="block">Converts strings to byte arrays.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>string</code> - the string to convert.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the UTF byte array.</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="class-use/UtfOps.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 class="aboutLanguage"><b>Berkeley DB Java Edition</b><br><font size=\"-1\"> version 7.5.11</font>
</div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../com/sleepycat/util/RuntimeExceptionWrapper.html" title="class in com.sleepycat.util"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li>Next&nbsp;Class</li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?com/sleepycat/util/UtfOps.html" target="_top">Frames</a></li>
<li><a href="UtfOps.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>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 ======= -->
<p class="legalCopy"><small><font size=1>Copyright (c) 2002, 2017 Oracle and/or its affiliates. All rights reserved.</font> </small></p>
</body>
</html>