<!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_45) on Thu Jan 09 22:45:26 GMT 2014 --> <title>UtfOps</title> <meta name="date" content="2014-01-09"> <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="UtfOps"; } //--> </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="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="../../../com/sleepycat/util/RuntimeExceptionWrapper.html" title="class in com.sleepycat.util"><span class="strong">Prev Class</span></a></li> <li>Next 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 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><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">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="strong">UtfOps</span> extends java.lang.Object</pre> <div class="block">UTF operations with more flexibility than is provided by DataInput and DataOutput.</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"> </span></caption> <tr> <th class="colOne" scope="col">Constructor and Description</th> </tr> <tr class="altColor"> <td class="colOne"><code><strong><a href="../../../com/sleepycat/util/UtfOps.html#UtfOps()">UtfOps</a></strong>()</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="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> <caption><span>Methods</span><span class="tabEnd"> </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>static int</code></td> <td class="colLast"><code><strong><a href="../../../com/sleepycat/util/UtfOps.html#bytesToChars(byte[], int, char[], int, int, boolean)">bytesToChars</a></strong>(byte[] bytes, int byteOffset, char[] chars, int charOffset, int len, boolean isByteLen)</code> <div class="block">Converts byte arrays into character arrays.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>static java.lang.String</code></td> <td class="colLast"><code><strong><a href="../../../com/sleepycat/util/UtfOps.html#bytesToString(byte[], int, int)">bytesToString</a></strong>(byte[] bytes, int offset, int length)</code> <div class="block">Converts byte arrays into strings.</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>static void</code></td> <td class="colLast"><code><strong><a href="../../../com/sleepycat/util/UtfOps.html#charsToBytes(char[], int, byte[], int, int)">charsToBytes</a></strong>(char[] chars, int charOffset, byte[] bytes, int byteOffset, int charLength)</code> <div class="block">Converts character arrays into byte arrays.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>static int</code></td> <td class="colLast"><code><strong><a href="../../../com/sleepycat/util/UtfOps.html#getByteLength(char[])">getByteLength</a></strong>(char[] 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 class="altColor"> <td class="colFirst"><code>static int</code></td> <td class="colLast"><code><strong><a href="../../../com/sleepycat/util/UtfOps.html#getByteLength(char[], int, int)">getByteLength</a></strong>(char[] chars, int offset, int 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 class="rowColor"> <td class="colFirst"><code>static int</code></td> <td class="colLast"><code><strong><a href="../../../com/sleepycat/util/UtfOps.html#getCharLength(byte[])">getCharLength</a></strong>(byte[] bytes)</code> <div class="block">Returns the number of characters represented by the given UTF string.</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>static int</code></td> <td class="colLast"><code><strong><a href="../../../com/sleepycat/util/UtfOps.html#getCharLength(byte[], int, int)">getCharLength</a></strong>(byte[] bytes, int offset, int length)</code> <div class="block">Returns the number of characters represented by the given UTF string.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>static int</code></td> <td class="colLast"><code><strong><a href="../../../com/sleepycat/util/UtfOps.html#getZeroTerminatedByteLength(byte[], int)">getZeroTerminatedByteLength</a></strong>(byte[] bytes, int offset)</code> <div class="block">Returns the byte length of a null terminated UTF string, not including the terminator.</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>static byte[]</code></td> <td class="colLast"><code><strong><a href="../../../com/sleepycat/util/UtfOps.html#stringToBytes(java.lang.String)">stringToBytes</a></strong>(java.lang.String 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 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 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[], int)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getZeroTerminatedByteLength</h4> <pre>public static int getZeroTerminatedByteLength(byte[] bytes, int 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="strong">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="strong">Returns:</span></dt><dd>the number of bytes.</dd> <dt><span class="strong">Throws:</span></dt> <dd><code>java.lang.IndexOutOfBoundsException</code> - if no zero terminator is found.</dd></dl> </li> </ul> <a name="getByteLength(char[])"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getByteLength</h4> <pre>public static int getByteLength(char[] 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="strong">Parameters:</span></dt><dd><code>chars</code> - the characters that would be converted.</dd> <dt><span class="strong">Returns:</span></dt><dd>the byte length of the equivalent UTF data.</dd></dl> </li> </ul> <a name="getByteLength(char[], int, int)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getByteLength</h4> <pre>public static int getByteLength(char[] chars, int offset, int 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="strong">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="strong">Returns:</span></dt><dd>the byte length of the equivalent UTF data.</dd></dl> </li> </ul> <a name="getCharLength(byte[])"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getCharLength</h4> <pre>public static int getCharLength(byte[] 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="strong">Parameters:</span></dt><dd><code>bytes</code> - the UTF string.</dd> <dt><span class="strong">Returns:</span></dt><dd>the number of characters.</dd> <dt><span class="strong">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[], int, int)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getCharLength</h4> <pre>public static int getCharLength(byte[] bytes, int offset, int 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="strong">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="strong">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[], int, char[], int, int, boolean)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>bytesToChars</h4> <pre>public static int bytesToChars(byte[] bytes, int byteOffset, char[] chars, int charOffset, int len, boolean isByteLen) throws java.lang.IllegalArgumentException, java.lang.IndexOutOfBoundsException</pre> <div class="block">Converts byte arrays into character arrays.</div> <dl><dt><span class="strong">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="strong">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[], int, byte[], int, int)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>charsToBytes</h4> <pre>public static void charsToBytes(char[] chars, int charOffset, byte[] bytes, int byteOffset, int charLength)</pre> <div class="block">Converts character arrays into byte arrays.</div> <dl><dt><span class="strong">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[], int, int)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>bytesToString</h4> <pre>public static java.lang.String bytesToString(byte[] bytes, int offset, int length) throws java.lang.IllegalArgumentException, java.lang.IndexOutOfBoundsException</pre> <div class="block">Converts byte arrays into strings.</div> <dl><dt><span class="strong">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="strong">Returns:</span></dt><dd>the string.</dd> <dt><span class="strong">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 byte[] stringToBytes(java.lang.String string)</pre> <div class="block">Converts strings to byte arrays.</div> <dl><dt><span class="strong">Parameters:</span></dt><dd><code>string</code> - the string to convert.</dd> <dt><span class="strong">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><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="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="../../../com/sleepycat/util/RuntimeExceptionWrapper.html" title="class in com.sleepycat.util"><span class="strong">Prev Class</span></a></li> <li>Next 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 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><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>