| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (16) --> |
| <title>DecimalData (OpenJ9 JDK 16)</title> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="description" content="declaration: module: openj9.dataaccess, package: com.ibm.dataaccess, class: DecimalData"> |
| <meta name="generator" content="javadoc/ClassWriterImpl"> |
| <meta name="keywords" content="com.ibm.dataaccess.DecimalData class"> |
| <meta name="keywords" content="EBCDIC_SIGN_EMBEDDED_TRAILING"> |
| <meta name="keywords" content="EBCDIC_SIGN_EMBEDDED_LEADING"> |
| <meta name="keywords" content="EBCDIC_SIGN_SEPARATE_TRAILING"> |
| <meta name="keywords" content="EBCDIC_SIGN_SEPARATE_LEADING"> |
| <meta name="keywords" content="UNICODE_UNSIGNED"> |
| <meta name="keywords" content="UNICODE_SIGN_SEPARATE_LEADING"> |
| <meta name="keywords" content="UNICODE_SIGN_SEPARATE_TRAILING"> |
| <meta name="keywords" content="convertIntegerToPackedDecimal()"> |
| <meta name="keywords" content="convertIntegerToExternalDecimal()"> |
| <meta name="keywords" content="convertIntegerToUnicodeDecimal()"> |
| <meta name="keywords" content="convertLongToPackedDecimal()"> |
| <meta name="keywords" content="convertLongToExternalDecimal()"> |
| <meta name="keywords" content="convertLongToUnicodeDecimal()"> |
| <meta name="keywords" content="convertPackedDecimalToInteger()"> |
| <meta name="keywords" content="convertPackedDecimalToLong()"> |
| <meta name="keywords" content="convertPackedDecimalToExternalDecimal()"> |
| <meta name="keywords" content="convertPackedDecimalToUnicodeDecimal()"> |
| <meta name="keywords" content="convertPackedDecimalToBigInteger()"> |
| <meta name="keywords" content="convertPackedDecimalToBigDecimal()"> |
| <meta name="keywords" content="convertExternalDecimalToInteger()"> |
| <meta name="keywords" content="convertExternalDecimalToLong()"> |
| <meta name="keywords" content="convertExternalDecimalToPackedDecimal()"> |
| <meta name="keywords" content="convertExternalDecimalToBigInteger()"> |
| <meta name="keywords" content="convertExternalDecimalToBigDecimal()"> |
| <meta name="keywords" content="convertUnicodeDecimalToInteger()"> |
| <meta name="keywords" content="convertUnicodeDecimalToLong()"> |
| <meta name="keywords" content="convertUnicodeDecimalToPackedDecimal()"> |
| <meta name="keywords" content="convertUnicodeDecimalToBigInteger()"> |
| <meta name="keywords" content="convertUnicodeDecimalToBigDecimal()"> |
| <meta name="keywords" content="convertBigIntegerToPackedDecimal()"> |
| <meta name="keywords" content="convertBigIntegerToExternalDecimal()"> |
| <meta name="keywords" content="convertBigIntegerToUnicodeDecimal()"> |
| <meta name="keywords" content="convertBigDecimalToPackedDecimal()"> |
| <meta name="keywords" content="convertBigDecimalToExternalDecimal()"> |
| <meta name="keywords" content="convertBigDecimalToUnicodeDecimal()"> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> |
| <script type="text/javascript" src="../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../script-dir/jquery-3.5.1.min.js"></script> |
| <script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> |
| </head> |
| <body class="class-declaration-page"> |
| <script type="text/javascript">var evenRowColor = "even-row-color"; |
| var oddRowColor = "odd-row-color"; |
| var tableTab = "table-tab"; |
| var activeTableTab = "active-table-tab"; |
| var pathtoroot = "../../../../"; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <div class="flex-box"> |
| <header role="banner" class="flex-header"> |
| <nav role="navigation"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="top-nav" id="navbar.top"> |
| <div class="skip-nav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <div class="about-language"><div style="margin-top: 9px;"><strong>OpenJ9 JDK 16</strong></div></div> |
| <ul id="navbar.top.firstrow" class="nav-list" title="Navigation"> |
| <li><a href="../../../../index.html">Overview</a></li> |
| <li><a href="../../../module-summary.html">Module</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="nav-bar-cell1-rev">Class</li> |
| <li><a href="class-use/DecimalData.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="sub-nav"> |
| <div> |
| <ul class="sub-nav-list"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <div class="nav-list-search"><label for="search">SEARCH:</label> |
| <input type="text" id="search" value="search" disabled="disabled"> |
| <input type="reset" id="reset" value="reset" disabled="disabled"> |
| </div> |
| </div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <span class="skip-nav" id="skip.navbar.top"> |
| <!-- --> |
| </span></nav> |
| </header> |
| <div class="flex-content"> |
| <main role="main"> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="sub-title"><span class="module-label-in-type">Module</span> <a href="../../../module-summary.html">openj9.dataaccess</a></div> |
| <div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">com.ibm.dataaccess</a></div> |
| <h1 title="Class DecimalData" class="title">Class DecimalData</h1> |
| </div> |
| <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link" target="_blank">java.lang.Object</a> |
| <div class="inheritance">com.ibm.dataaccess.DecimalData</div> |
| </div> |
| <section class="description"> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public final class </span><span class="element-name type-name-label">DecimalData</span> |
| <span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link" target="_blank">Object</a></span></div> |
| <div class="block">Routines to convert between decimal data types stored in byte arrays and Java binary types. |
| |
| <p> |
| All the converter routines require the precision of the decimal value to convert, which represents the number of |
| decimal digits in the decimal value, not including the sign. |
| </p> |
| |
| <p> |
| Unicode Decimal values can be represented as either a char array or as a byte array where every Unicode character is |
| represented by a pair of adjacent bytes. |
| </p> |
| |
| <p> |
| For embedded sign nibbles (4 bit integers representing values between <code>0x0</code> and <code>0xF</code> |
| inclusive) in External Decimal or Packed Decimal data, <code>0xB</code> and <code>0xD</code> represent a negative |
| sign. All other sign nibble values represent a positive sign. For operations that produce an External Decimal or |
| Packed Decimal result, the Data Access Accelerator library inserts the preferred positive sign code of |
| <code>0xC</code> if the result is positive, and a preferred negative sign code of <code>0xD</code> if the result is |
| negative. All values between <code>0x0</code> and <code>0xF</code> inclusive are interpreted as valid sign codes. |
| </p> |
| |
| <p> |
| This library has full support for signed integers but only limited support for scale points (decimals). Scale points |
| and other unrecognized characters found in input External, Unicode, or Packed Decimal byte arrays are not supported, |
| and may cause IllegalArgumentExceptions or undefined results. BigDecimal <i>inputs</i> will have scale ignored (i.e. |
| -1.23 will be interpreted as -123). When converting to BigDecimal (as <i>output</i>), a scale value may be explicitly |
| specified as a separate parameter. |
| </p></div> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <li> |
| <section class="field-summary" id="field.summary"> |
| <h2>Field Summary</h2> |
| <div class="caption"><span>Fields</span></div> |
| <div class="summary-table three-column-summary"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Field</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code>static int</code></div> |
| <div class="col-second even-row-color"><code><span class="member-name-link"><a href="#EBCDIC_SIGN_EMBEDDED_LEADING">EBCDIC_SIGN_EMBEDDED_LEADING</a></span></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">External Decimal data format where each byte is an EBCDIC character representing a decimal digit, the sign is |
| encoded in the top nibble of the first byte.</div> |
| </div> |
| <div class="col-first odd-row-color"><code>static int</code></div> |
| <div class="col-second odd-row-color"><code><span class="member-name-link"><a href="#EBCDIC_SIGN_EMBEDDED_TRAILING">EBCDIC_SIGN_EMBEDDED_TRAILING</a></span></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">External Decimal data format where each byte is an EBCDIC character representing a decimal digit, the sign is |
| encoded in the top nibble of the last byte.</div> |
| </div> |
| <div class="col-first even-row-color"><code>static int</code></div> |
| <div class="col-second even-row-color"><code><span class="member-name-link"><a href="#EBCDIC_SIGN_SEPARATE_LEADING">EBCDIC_SIGN_SEPARATE_LEADING</a></span></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">External Decimal data format where each byte is an EBCDIC character representing a decimal digit, the sign is |
| encoded in a separate byte that comes before the first byte of the number.</div> |
| </div> |
| <div class="col-first odd-row-color"><code>static int</code></div> |
| <div class="col-second odd-row-color"><code><span class="member-name-link"><a href="#EBCDIC_SIGN_SEPARATE_TRAILING">EBCDIC_SIGN_SEPARATE_TRAILING</a></span></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">External Decimal data format where each byte is an EBCDIC character representing a decimal digit, the sign is |
| encoded in a separate byte that comes after the last byte of the number.</div> |
| </div> |
| <div class="col-first even-row-color"><code>static int</code></div> |
| <div class="col-second even-row-color"><code><span class="member-name-link"><a href="#UNICODE_SIGN_SEPARATE_LEADING">UNICODE_SIGN_SEPARATE_LEADING</a></span></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Unicode Decimal data format where each digit is a Unicode character, the sign is stored in the first character.</div> |
| </div> |
| <div class="col-first odd-row-color"><code>static int</code></div> |
| <div class="col-second odd-row-color"><code><span class="member-name-link"><a href="#UNICODE_SIGN_SEPARATE_TRAILING">UNICODE_SIGN_SEPARATE_TRAILING</a></span></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Unicode Decimal data format where each digit is a Unicode character, the sign is stored in the last character.</div> |
| </div> |
| <div class="col-first even-row-color"><code>static int</code></div> |
| <div class="col-second even-row-color"><code><span class="member-name-link"><a href="#UNICODE_UNSIGNED">UNICODE_UNSIGNED</a></span></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Unicode Decimal data format where each digit is a Unicode character, there is no sign.</div> |
| </div> |
| </div> |
| </section> |
| </li> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <li> |
| <section class="method-summary" id="method.summary"> |
| <h2>Method Summary</h2> |
| <div id="method-summary-table"> |
| <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> |
| <div id="method-summary-table.tabpanel" role="tabpanel"> |
| <div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Method</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code>static void</code></div> |
| <div class="col-second even-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#convertBigDecimalToExternalDecimal(java.math.BigDecimal,byte%5B%5D,int,int,boolean,int)">convertBigDecimalToExternalDecimal</a></span>​(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/math/BigDecimal.html" title="class or interface in java.math" class="external-link" target="_blank">BigDecimal</a> bigDecimalValue, |
| byte[] externalDecimal, |
| int offset, |
| int precision, |
| boolean checkOverflow, |
| int decimalType)</code></div> |
| <div class="col-last even-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"> |
| <div class="block">Converts a BigDecimal value to an External Decimal in a byte array |
| |
| Overflow can happen if the BigDecimal does not fit into the result byte array.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code>static void</code></div> |
| <div class="col-second odd-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#convertBigDecimalToPackedDecimal(java.math.BigDecimal,byte%5B%5D,int,int,boolean)">convertBigDecimalToPackedDecimal</a></span>​(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/math/BigDecimal.html" title="class or interface in java.math" class="external-link" target="_blank">BigDecimal</a> bigDecimalValue, |
| byte[] packedDecimal, |
| int offset, |
| int precision, |
| boolean checkOverflow)</code></div> |
| <div class="col-last odd-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"> |
| <div class="block">Converts a BigDecimal into a Packed Decimal in a byte array |
| |
| Overflow can happen if the BigDecimal does not fit into the result byte array.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code>static void</code></div> |
| <div class="col-second even-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#convertBigDecimalToUnicodeDecimal(java.math.BigDecimal,char%5B%5D,int,int,boolean,int)">convertBigDecimalToUnicodeDecimal</a></span>​(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/math/BigDecimal.html" title="class or interface in java.math" class="external-link" target="_blank">BigDecimal</a> bigDecimalValue, |
| char[] unicodeDecimal, |
| int offset, |
| int precision, |
| boolean checkOverflow, |
| int decimalType)</code></div> |
| <div class="col-last even-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"> |
| <div class="block">Converts a BigDecimal value to a Unicode Decimal in a char array |
| |
| Overflow can happen if the BigDecimal does not fit into the result char array.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code>static void</code></div> |
| <div class="col-second odd-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#convertBigIntegerToExternalDecimal(java.math.BigInteger,byte%5B%5D,int,int,boolean,int)">convertBigIntegerToExternalDecimal</a></span>​(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/math/BigInteger.html" title="class or interface in java.math" class="external-link" target="_blank">BigInteger</a> bigIntegerValue, |
| byte[] externalDecimal, |
| int offset, |
| int precision, |
| boolean checkOverflow, |
| int decimalType)</code></div> |
| <div class="col-last odd-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"> |
| <div class="block">Converts a BigInteger value into an External Decimal in a byte array |
| |
| Overflow can happen if the BigInteger does not fit into the byte array.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code>static void</code></div> |
| <div class="col-second even-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#convertBigIntegerToPackedDecimal(java.math.BigInteger,byte%5B%5D,int,int,boolean)">convertBigIntegerToPackedDecimal</a></span>​(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/math/BigInteger.html" title="class or interface in java.math" class="external-link" target="_blank">BigInteger</a> bigIntegerValue, |
| byte[] packedDecimal, |
| int offset, |
| int precision, |
| boolean checkOverflow)</code></div> |
| <div class="col-last even-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"> |
| <div class="block">Converts a BigInteger value into a Packed Decimal in a byte array |
| |
| Overflow can happen if the BigInteger does not fit into the byte array.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code>static void</code></div> |
| <div class="col-second odd-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#convertBigIntegerToUnicodeDecimal(java.math.BigInteger,char%5B%5D,int,int,boolean,int)">convertBigIntegerToUnicodeDecimal</a></span>​(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/math/BigInteger.html" title="class or interface in java.math" class="external-link" target="_blank">BigInteger</a> bigIntegerValue, |
| char[] unicodeDecimal, |
| int offset, |
| int precision, |
| boolean checkOverflow, |
| int decimalType)</code></div> |
| <div class="col-last odd-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"> |
| <div class="block">Converts a BigInteger value to a Unicode Decimal in a char array |
| |
| Overflow can happen if the BigInteger does not fit into the char array.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code>static <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/math/BigDecimal.html" title="class or interface in java.math" class="external-link" target="_blank">BigDecimal</a></code></div> |
| <div class="col-second even-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#convertExternalDecimalToBigDecimal(byte%5B%5D,int,int,int,boolean,int)">convertExternalDecimalToBigDecimal</a></span>​(byte[] externalDecimal, |
| int offset, |
| int precision, |
| int scale, |
| boolean checkOverflow, |
| int decimalType)</code></div> |
| <div class="col-last even-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"> |
| <div class="block">Converts an External Decimal in a byte array to a BigDecimal.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code>static <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/math/BigInteger.html" title="class or interface in java.math" class="external-link" target="_blank">BigInteger</a></code></div> |
| <div class="col-second odd-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#convertExternalDecimalToBigInteger(byte%5B%5D,int,int,boolean,int)">convertExternalDecimalToBigInteger</a></span>​(byte[] externalDecimal, |
| int offset, |
| int precision, |
| boolean checkOverflow, |
| int decimalType)</code></div> |
| <div class="col-last odd-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"> |
| <div class="block">Convert an External Decimal in a byte array to a BigInteger.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code>static int</code></div> |
| <div class="col-second even-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#convertExternalDecimalToInteger(byte%5B%5D,int,int,boolean,int)">convertExternalDecimalToInteger</a></span>​(byte[] externalDecimal, |
| int offset, |
| int precision, |
| boolean checkOverflow, |
| int decimalType)</code></div> |
| <div class="col-last even-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"> |
| <div class="block">Converts an External Decimal value in a byte array into a binary integer.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code>static long</code></div> |
| <div class="col-second odd-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#convertExternalDecimalToLong(byte%5B%5D,int,int,boolean,int)">convertExternalDecimalToLong</a></span>​(byte[] externalDecimal, |
| int offset, |
| int precision, |
| boolean checkOverflow, |
| int decimalType)</code></div> |
| <div class="col-last odd-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"> |
| <div class="block">Converts an External Decimal value in a byte array into a long.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code>static void</code></div> |
| <div class="col-second even-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#convertExternalDecimalToPackedDecimal(byte%5B%5D,int,byte%5B%5D,int,int,int)">convertExternalDecimalToPackedDecimal</a></span>​(byte[] externalDecimal, |
| int externalOffset, |
| byte[] packedDecimal, |
| int packedOffset, |
| int precision, |
| int decimalType)</code></div> |
| <div class="col-last even-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"> |
| <div class="block">Converts an External Decimal in a byte array to a Packed Decimal in another byte array.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code>static void</code></div> |
| <div class="col-second odd-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#convertIntegerToExternalDecimal(int,byte%5B%5D,int,int,boolean,int)">convertIntegerToExternalDecimal</a></span>​(int integerValue, |
| byte[] externalDecimal, |
| int offset, |
| int precision, |
| boolean checkOverflow, |
| int decimalType)</code></div> |
| <div class="col-last odd-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"> |
| <div class="block">Converts an integer to an External Decimal in a byte array.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code>static void</code></div> |
| <div class="col-second even-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#convertIntegerToPackedDecimal(int,byte%5B%5D,int,int,boolean)">convertIntegerToPackedDecimal</a></span>​(int integerValue, |
| byte[] packedDecimal, |
| int offset, |
| int precision, |
| boolean checkOverflow)</code></div> |
| <div class="col-last even-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"> |
| <div class="block">Converts a binary integer value into a signed Packed Decimal format.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code>static void</code></div> |
| <div class="col-second odd-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#convertIntegerToUnicodeDecimal(int,char%5B%5D,int,int,boolean,int)">convertIntegerToUnicodeDecimal</a></span>​(int integerValue, |
| char[] unicodeDecimal, |
| int offset, |
| int precision, |
| boolean checkoverflow, |
| int unicodeType)</code></div> |
| <div class="col-last odd-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"> |
| <div class="block">Converts an integer to a Unicode Decimal in a char array |
| |
| Overflow can happen if the resulting External Decimal value does not fit into the char array, given the offset and |
| precision.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code>static void</code></div> |
| <div class="col-second even-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#convertLongToExternalDecimal(long,byte%5B%5D,int,int,boolean,int)">convertLongToExternalDecimal</a></span>​(long longValue, |
| byte[] externalDecimal, |
| int offset, |
| int precision, |
| boolean checkOverflow, |
| int decimalType)</code></div> |
| <div class="col-last even-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"> |
| <div class="block">Converts a long into an External Decimal in a byte array.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code>static void</code></div> |
| <div class="col-second odd-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#convertLongToPackedDecimal(long,byte%5B%5D,int,int,boolean)">convertLongToPackedDecimal</a></span>​(long longValue, |
| byte[] packedDecimal, |
| int offset, |
| int precision, |
| boolean checkOverflow)</code></div> |
| <div class="col-last odd-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"> |
| <div class="block">Converts a binary long value into signed Packed Decimal format.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code>static void</code></div> |
| <div class="col-second even-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#convertLongToUnicodeDecimal(long,char%5B%5D,int,int,boolean,int)">convertLongToUnicodeDecimal</a></span>​(long longValue, |
| char[] unicodeDecimal, |
| int offset, |
| int precision, |
| boolean checkOverflow, |
| int decimalType)</code></div> |
| <div class="col-last even-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"> |
| <div class="block">Converts a long to a Unicode Decimal in a char array |
| |
| Overflow can happen if the resulting Unicode Decimal value does not fit into the char array, given its precision |
| and offset .</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code>static <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/math/BigDecimal.html" title="class or interface in java.math" class="external-link" target="_blank">BigDecimal</a></code></div> |
| <div class="col-second odd-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#convertPackedDecimalToBigDecimal(byte%5B%5D,int,int,int,boolean)">convertPackedDecimalToBigDecimal</a></span>​(byte[] packedDecimal, |
| int offset, |
| int precision, |
| int scale, |
| boolean checkOverflow)</code></div> |
| <div class="col-last odd-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"> |
| <div class="block">Convert a Packed Decimal in a byte array to a BigDecimal.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code>static <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/math/BigInteger.html" title="class or interface in java.math" class="external-link" target="_blank">BigInteger</a></code></div> |
| <div class="col-second even-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#convertPackedDecimalToBigInteger(byte%5B%5D,int,int,boolean)">convertPackedDecimalToBigInteger</a></span>​(byte[] packedDecimal, |
| int offset, |
| int precision, |
| boolean checkOverflow)</code></div> |
| <div class="col-last even-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"> |
| <div class="block">Convert a Packed Decimal in a byte array to a BigInteger.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code>static void</code></div> |
| <div class="col-second odd-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#convertPackedDecimalToExternalDecimal(byte%5B%5D,int,byte%5B%5D,int,int,int)">convertPackedDecimalToExternalDecimal</a></span>​(byte[] packedDecimal, |
| int packedOffset, |
| byte[] externalDecimal, |
| int externalOffset, |
| int precision, |
| int decimalType)</code></div> |
| <div class="col-last odd-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"> |
| <div class="block">Converts a Packed Decimal in a byte array into an External Decimal in another byte array.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code>static int</code></div> |
| <div class="col-second even-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#convertPackedDecimalToInteger(byte%5B%5D,int,int,boolean)">convertPackedDecimalToInteger</a></span>​(byte[] packedDecimal, |
| int offset, |
| int precision, |
| boolean checkOverflow)</code></div> |
| <div class="col-last even-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"> |
| <div class="block">Converts a Packed Decimal value in a byte array into a binary integer.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code>static long</code></div> |
| <div class="col-second odd-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#convertPackedDecimalToLong(byte%5B%5D,int,int,boolean)">convertPackedDecimalToLong</a></span>​(byte[] packedDecimal, |
| int offset, |
| int precision, |
| boolean checkOverflow)</code></div> |
| <div class="col-last odd-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"> |
| <div class="block">Converts a Packed Decimal value in a byte array into a binary long.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code>static void</code></div> |
| <div class="col-second even-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#convertPackedDecimalToUnicodeDecimal(byte%5B%5D,int,char%5B%5D,int,int,int)">convertPackedDecimalToUnicodeDecimal</a></span>​(byte[] packedDecimal, |
| int packedOffset, |
| char[] unicodeDecimal, |
| int unicodeOffset, |
| int precision, |
| int decimalType)</code></div> |
| <div class="col-last even-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"> |
| <div class="block">Convert a Packed Decimal in a byte array to a Unicode Decimal in a char array.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code>static <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/math/BigDecimal.html" title="class or interface in java.math" class="external-link" target="_blank">BigDecimal</a></code></div> |
| <div class="col-second odd-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#convertUnicodeDecimalToBigDecimal(char%5B%5D,int,int,int,boolean,int)">convertUnicodeDecimalToBigDecimal</a></span>​(char[] unicodeDecimal, |
| int offset, |
| int precision, |
| int scale, |
| boolean checkOverflow, |
| int decimalType)</code></div> |
| <div class="col-last odd-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"> |
| <div class="block">Converts a Unicode Decimal in a char array to a BigDecimal.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code>static <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/math/BigInteger.html" title="class or interface in java.math" class="external-link" target="_blank">BigInteger</a></code></div> |
| <div class="col-second even-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#convertUnicodeDecimalToBigInteger(char%5B%5D,int,int,boolean,int)">convertUnicodeDecimalToBigInteger</a></span>​(char[] unicodeDecimal, |
| int offset, |
| int precision, |
| boolean checkOverflow, |
| int decimalType)</code></div> |
| <div class="col-last even-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"> |
| <div class="block">Convert a Unicode Decimal in a char array to a BigInteger.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code>static int</code></div> |
| <div class="col-second odd-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#convertUnicodeDecimalToInteger(char%5B%5D,int,int,boolean,int)">convertUnicodeDecimalToInteger</a></span>​(char[] unicodeDecimal, |
| int offset, |
| int precision, |
| boolean checkOverflow, |
| int unicodeType)</code></div> |
| <div class="col-last odd-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"> |
| <div class="block">Converts a Unicode Decimal value in a char array into a binary integer.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code>static long</code></div> |
| <div class="col-second even-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#convertUnicodeDecimalToLong(char%5B%5D,int,int,boolean,int)">convertUnicodeDecimalToLong</a></span>​(char[] unicodeDecimal, |
| int offset, |
| int precision, |
| boolean checkOverflow, |
| int unicodeType)</code></div> |
| <div class="col-last even-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"> |
| <div class="block">Converts a Unicode Decimal value in a char array into a binary long.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code>static void</code></div> |
| <div class="col-second odd-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#convertUnicodeDecimalToPackedDecimal(char%5B%5D,int,byte%5B%5D,int,int,int)">convertUnicodeDecimalToPackedDecimal</a></span>​(char[] unicodeDecimal, |
| int unicodeOffset, |
| byte[] packedDecimal, |
| int packedOffset, |
| int precision, |
| int decimalType)</code></div> |
| <div class="col-last odd-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"> |
| <div class="block">Converts an Unicode Decimal in a char array to a Packed Decimal in a byte array.</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods.inherited.from.class.java.lang.Object">Methods declared in class java.lang.<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link" target="_blank">Object</a></h3> |
| <code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link" target="_blank">clone</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link" target="_blank">equals</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link" target="_blank">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link" target="_blank">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link" target="_blank">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link" target="_blank">notify</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link" target="_blank">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link" target="_blank">toString</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link" target="_blank">wait</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link" target="_blank">wait</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link" target="_blank">wait</a></code></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <li> |
| <section class="field-details" id="field.detail"> |
| <h2>Field Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="EBCDIC_SIGN_EMBEDDED_TRAILING"> |
| <h3>EBCDIC_SIGN_EMBEDDED_TRAILING</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type">int</span> <span class="element-name">EBCDIC_SIGN_EMBEDDED_TRAILING</span></div> |
| <div class="block">External Decimal data format where each byte is an EBCDIC character representing a decimal digit, the sign is |
| encoded in the top nibble of the last byte.</div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd><a href="../../../../constant-values.html#com.ibm.dataaccess.DecimalData.EBCDIC_SIGN_EMBEDDED_TRAILING">Constant Field Values</a></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="EBCDIC_SIGN_EMBEDDED_LEADING"> |
| <h3>EBCDIC_SIGN_EMBEDDED_LEADING</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type">int</span> <span class="element-name">EBCDIC_SIGN_EMBEDDED_LEADING</span></div> |
| <div class="block">External Decimal data format where each byte is an EBCDIC character representing a decimal digit, the sign is |
| encoded in the top nibble of the first byte.</div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd><a href="../../../../constant-values.html#com.ibm.dataaccess.DecimalData.EBCDIC_SIGN_EMBEDDED_LEADING">Constant Field Values</a></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="EBCDIC_SIGN_SEPARATE_TRAILING"> |
| <h3>EBCDIC_SIGN_SEPARATE_TRAILING</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type">int</span> <span class="element-name">EBCDIC_SIGN_SEPARATE_TRAILING</span></div> |
| <div class="block">External Decimal data format where each byte is an EBCDIC character representing a decimal digit, the sign is |
| encoded in a separate byte that comes after the last byte of the number.</div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd><a href="../../../../constant-values.html#com.ibm.dataaccess.DecimalData.EBCDIC_SIGN_SEPARATE_TRAILING">Constant Field Values</a></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="EBCDIC_SIGN_SEPARATE_LEADING"> |
| <h3>EBCDIC_SIGN_SEPARATE_LEADING</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type">int</span> <span class="element-name">EBCDIC_SIGN_SEPARATE_LEADING</span></div> |
| <div class="block">External Decimal data format where each byte is an EBCDIC character representing a decimal digit, the sign is |
| encoded in a separate byte that comes before the first byte of the number.</div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd><a href="../../../../constant-values.html#com.ibm.dataaccess.DecimalData.EBCDIC_SIGN_SEPARATE_LEADING">Constant Field Values</a></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="UNICODE_UNSIGNED"> |
| <h3>UNICODE_UNSIGNED</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type">int</span> <span class="element-name">UNICODE_UNSIGNED</span></div> |
| <div class="block">Unicode Decimal data format where each digit is a Unicode character, there is no sign.</div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd><a href="../../../../constant-values.html#com.ibm.dataaccess.DecimalData.UNICODE_UNSIGNED">Constant Field Values</a></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="UNICODE_SIGN_SEPARATE_LEADING"> |
| <h3>UNICODE_SIGN_SEPARATE_LEADING</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type">int</span> <span class="element-name">UNICODE_SIGN_SEPARATE_LEADING</span></div> |
| <div class="block">Unicode Decimal data format where each digit is a Unicode character, the sign is stored in the first character.</div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd><a href="../../../../constant-values.html#com.ibm.dataaccess.DecimalData.UNICODE_SIGN_SEPARATE_LEADING">Constant Field Values</a></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="UNICODE_SIGN_SEPARATE_TRAILING"> |
| <h3>UNICODE_SIGN_SEPARATE_TRAILING</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type">int</span> <span class="element-name">UNICODE_SIGN_SEPARATE_TRAILING</span></div> |
| <div class="block">Unicode Decimal data format where each digit is a Unicode character, the sign is stored in the last character.</div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd><a href="../../../../constant-values.html#com.ibm.dataaccess.DecimalData.UNICODE_SIGN_SEPARATE_TRAILING">Constant Field Values</a></dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method.detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="convertIntegerToPackedDecimal(int,byte[],int,int,boolean)"> |
| <h3>convertIntegerToPackedDecimal</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">void</span> <span class="element-name">convertIntegerToPackedDecimal</span>​<span class="parameters">(int integerValue, |
| byte[] packedDecimal, |
| int offset, |
| int precision, |
| boolean checkOverflow)</span></div> |
| <div class="block">Converts a binary integer value into a signed Packed Decimal format. The Packed Decimal will be padded with zeros |
| on the left if necessary. |
| |
| Overflow can happen if the resulting Packed Decimal does not fit into the result byte array, given the offset and |
| precision. In this case, when <code>checkOverflow</code> is true an <code>ArithmeticException</code> is thrown, |
| when false a truncated or invalid result is returned.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>integerValue</code> - the binary integer value to convert</dd> |
| <dd><code>packedDecimal</code> - byte array that will store the resulting Packed Decimal value</dd> |
| <dd><code>offset</code> - offset of the first byte of the Packed Decimal in <code>packedDecimal</code></dd> |
| <dd><code>precision</code> - number of Packed Decimal digits. Maximum valid precision is 253</dd> |
| <dd><code>checkOverflow</code> - if true an <code>ArithmeticException</code> will be thrown if the decimal value does not fit in the |
| specified precision (overflow)</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/ArrayIndexOutOfBoundsException.html" title="class or interface in java.lang" class="external-link" target="_blank">ArrayIndexOutOfBoundsException</a></code> - if an invalid array access occurs</dd> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/NullPointerException.html" title="class or interface in java.lang" class="external-link" target="_blank">NullPointerException</a></code> - if <code>packedDecimal</code> is null</dd> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/ArithmeticException.html" title="class or interface in java.lang" class="external-link" target="_blank">ArithmeticException</a></code> - if the <code>checkOverflow</code> parameter is true and overflow occurs</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="convertIntegerToExternalDecimal(int,byte[],int,int,boolean,int)"> |
| <h3>convertIntegerToExternalDecimal</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">void</span> <span class="element-name">convertIntegerToExternalDecimal</span>​<span class="parameters">(int integerValue, |
| byte[] externalDecimal, |
| int offset, |
| int precision, |
| boolean checkOverflow, |
| int decimalType)</span></div> |
| <div class="block">Converts an integer to an External Decimal in a byte array. The External Decimal will be padded with zeros on the |
| left if necessary. |
| |
| Overflow can happen if the resulting External Decimal value does not fit into the byte array, given the precision |
| and offset. In this case, when <code>checkOverflow</code> is true an <code>ArithmeticException</code> is thrown, |
| when false a truncated or invalid result is returned.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>integerValue</code> - the value to convert</dd> |
| <dd><code>externalDecimal</code> - the byte array which will hold the External Decimal on a successful return</dd> |
| <dd><code>offset</code> - the offset in the byte array at which the External Decimal should be located</dd> |
| <dd><code>precision</code> - the number of decimal digits. Maximum valid precision is 253</dd> |
| <dd><code>checkOverflow</code> - if true an <code>ArithmeticException</code>will be thrown if the designated array cannot hold the |
| External Decimal.</dd> |
| <dd><code>decimalType</code> - constant value indicating the type of External Decimal</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/NullPointerException.html" title="class or interface in java.lang" class="external-link" target="_blank">NullPointerException</a></code> - if <code>externalDecimal</code> is null</dd> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/ArrayIndexOutOfBoundsException.html" title="class or interface in java.lang" class="external-link" target="_blank">ArrayIndexOutOfBoundsException</a></code> - if an invalid array access occurs</dd> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/ArithmeticException.html" title="class or interface in java.lang" class="external-link" target="_blank">ArithmeticException</a></code> - if the <code>checkOverflow</code> parameter is true and overflow occurs</dd> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link" target="_blank">IllegalArgumentException</a></code> - if <code>decimalType</code> or <code>precision</code> is invalid</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="convertIntegerToUnicodeDecimal(int,char[],int,int,boolean,int)"> |
| <h3>convertIntegerToUnicodeDecimal</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">void</span> <span class="element-name">convertIntegerToUnicodeDecimal</span>​<span class="parameters">(int integerValue, |
| char[] unicodeDecimal, |
| int offset, |
| int precision, |
| boolean checkoverflow, |
| int unicodeType)</span></div> |
| <div class="block">Converts an integer to a Unicode Decimal in a char array |
| |
| Overflow can happen if the resulting External Decimal value does not fit into the char array, given the offset and |
| precision. In this case, when <code>checkOverflow</code> is true an <code>ArithmeticException</code> is thrown, |
| when false a truncated or invalid result is returned.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>integerValue</code> - the long value to convert</dd> |
| <dd><code>unicodeDecimal</code> - the char array which will hold the Unicode Decimal on a successful return</dd> |
| <dd><code>offset</code> - the offset in the char array where the Unicode Decimal would be located</dd> |
| <dd><code>precision</code> - the number of decimal digits. Maximum valid precision is 253</dd> |
| <dd><code>checkoverflow</code> - if true, when the designated an <code>ArithmeticException</code></dd> |
| <dd><code>unicodeType</code> - constant value indicating the type of Unicode Decimal</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/NullPointerException.html" title="class or interface in java.lang" class="external-link" target="_blank">NullPointerException</a></code> - if <code>unicodeDecimal</code> is null</dd> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/ArrayIndexOutOfBoundsException.html" title="class or interface in java.lang" class="external-link" target="_blank">ArrayIndexOutOfBoundsException</a></code> - if an invalid array access occurs</dd> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/ArithmeticException.html" title="class or interface in java.lang" class="external-link" target="_blank">ArithmeticException</a></code> - if the <code>checkOverflow</code> parameter is true and overflow occurs</dd> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link" target="_blank">IllegalArgumentException</a></code> - if the <code>decimalType</code> or <code>precision</code> is invalid</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="convertLongToPackedDecimal(long,byte[],int,int,boolean)"> |
| <h3>convertLongToPackedDecimal</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">void</span> <span class="element-name">convertLongToPackedDecimal</span>​<span class="parameters">(long longValue, |
| byte[] packedDecimal, |
| int offset, |
| int precision, |
| boolean checkOverflow)</span></div> |
| <div class="block">Converts a binary long value into signed Packed Decimal format. The Packed Decimal will be padded with zeros on |
| the left if necessary. |
| |
| Overflow can happen if the resulting Packed Decimal does not fit into the result byte array, given the offset and |
| precision . In this case, when <code>checkOverflow</code> is true an <code>ArithmeticException</code> is thrown, |
| when false a truncated or invalid result is returned.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>longValue</code> - the binary long value to convert</dd> |
| <dd><code>packedDecimal</code> - byte array that will store the resulting Packed Decimal value</dd> |
| <dd><code>offset</code> - offset of the first byte of the Packed Decimal in <code>packedDecimal</code></dd> |
| <dd><code>precision</code> - number of Packed Decimal digits. Maximum valid precision is 253</dd> |
| <dd><code>checkOverflow</code> - if true an <code>ArithmeticException</code> will be thrown if the decimal value does not fit in the |
| specified precision (overflow), otherwise a truncated value is returned</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/ArrayIndexOutOfBoundsException.html" title="class or interface in java.lang" class="external-link" target="_blank">ArrayIndexOutOfBoundsException</a></code> - if an invalid array access occurs</dd> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/NullPointerException.html" title="class or interface in java.lang" class="external-link" target="_blank">NullPointerException</a></code> - if <code>packedDecimal</code> is null</dd> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/ArithmeticException.html" title="class or interface in java.lang" class="external-link" target="_blank">ArithmeticException</a></code> - the <code>checkOverflow</code> parameter is true and overflow occurs</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="convertLongToExternalDecimal(long,byte[],int,int,boolean,int)"> |
| <h3>convertLongToExternalDecimal</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">void</span> <span class="element-name">convertLongToExternalDecimal</span>​<span class="parameters">(long longValue, |
| byte[] externalDecimal, |
| int offset, |
| int precision, |
| boolean checkOverflow, |
| int decimalType)</span></div> |
| <div class="block">Converts a long into an External Decimal in a byte array. The External Decimal will be padded with zeros on the |
| left if necessary. |
| |
| Overflow can happen if the External Decimal value does not fit into the byte array, given its precision and offset. |
| In this case, when <code>checkOverflow</code> is true an <code>ArithmeticException</code> is thrown, when false a |
| truncated or invalid result is returned.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>longValue</code> - the value to convert</dd> |
| <dd><code>externalDecimal</code> - the byte array which will hold the External Decimal on a successful return</dd> |
| <dd><code>offset</code> - the offset into <code>externalDecimal</code> where External Decimal should be located</dd> |
| <dd><code>precision</code> - the number of decimal digits to convert. Maximum valid precision is 253</dd> |
| <dd><code>checkOverflow</code> - if true an <code>ArithmeticException</code> or <code>IllegalArgumentException</code> may be thrown</dd> |
| <dd><code>decimalType</code> - constant value indicating the type of External Decimal</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/NullPointerException.html" title="class or interface in java.lang" class="external-link" target="_blank">NullPointerException</a></code> - if <code>externalDecimal</code> is null</dd> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/ArrayIndexOutOfBoundsException.html" title="class or interface in java.lang" class="external-link" target="_blank">ArrayIndexOutOfBoundsException</a></code> - if an invalid array access occurs</dd> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/ArithmeticException.html" title="class or interface in java.lang" class="external-link" target="_blank">ArithmeticException</a></code> - if the <code>checkOverflow</code> parameter is true and overflow occurs</dd> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link" target="_blank">IllegalArgumentException</a></code> - if the <code>decimalType</code> or <code>precision</code> is invalid</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="convertLongToUnicodeDecimal(long,char[],int,int,boolean,int)"> |
| <h3>convertLongToUnicodeDecimal</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">void</span> <span class="element-name">convertLongToUnicodeDecimal</span>​<span class="parameters">(long longValue, |
| char[] unicodeDecimal, |
| int offset, |
| int precision, |
| boolean checkOverflow, |
| int decimalType)</span></div> |
| <div class="block">Converts a long to a Unicode Decimal in a char array |
| |
| Overflow can happen if the resulting Unicode Decimal value does not fit into the char array, given its precision |
| and offset . In this case, when <code>checkOverflow</code> is true an <code>ArithmeticException</code> is thrown, |
| when false a truncated or invalid result is returned.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>longValue</code> - the long value to convert</dd> |
| <dd><code>unicodeDecimal</code> - the char array which will hold the Unicode Decimal on a successful return</dd> |
| <dd><code>offset</code> - the offset in the char array where the Unicode Decimal would be located</dd> |
| <dd><code>precision</code> - the number of Unicode Decimal digits. Maximum valid precision is 253</dd> |
| <dd><code>checkOverflow</code> - if true an <code>ArithmeticException</code> or <code>IllegalArgumentException</code> may be thrown</dd> |
| <dd><code>decimalType</code> - constant value indicating the type of External Decimal</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/NullPointerException.html" title="class or interface in java.lang" class="external-link" target="_blank">NullPointerException</a></code> - if <code>unicodeDecimal</code> is null</dd> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/ArrayIndexOutOfBoundsException.html" title="class or interface in java.lang" class="external-link" target="_blank">ArrayIndexOutOfBoundsException</a></code> - if an invalid array access occurs</dd> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/ArithmeticException.html" title="class or interface in java.lang" class="external-link" target="_blank">ArithmeticException</a></code> - if the <code>checkOverflow</code> parameter is true and overflow occurs</dd> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link" target="_blank">IllegalArgumentException</a></code> - if <code>decimalType</code> or <code>precision</code> is invalid</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="convertPackedDecimalToInteger(byte[],int,int,boolean)"> |
| <h3>convertPackedDecimalToInteger</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">int</span> <span class="element-name">convertPackedDecimalToInteger</span>​<span class="parameters">(byte[] packedDecimal, |
| int offset, |
| int precision, |
| boolean checkOverflow)</span></div> |
| <div class="block">Converts a Packed Decimal value in a byte array into a binary integer. If the digital part of the input Packed |
| Decimal is not valid then the digital part of the output will not be valid. The sign of the input Packed Decimal |
| is assumed to be positive unless the sign nibble contains one of the negative sign codes, in which case the |
| sign of the input Packed Decimal is interpreted as negative. |
| |
| Overflow can happen if the Packed Decimal value does not fit into a binary integer. When |
| <code>checkOverflow</code> is true overflow results in an <code>ArithmeticException</code>, when false a |
| truncated or invalid result is returned.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>packedDecimal</code> - byte array which contains the Packed Decimal value</dd> |
| <dd><code>offset</code> - offset of the first byte of the Packed Decimal in <code>packedDecimal</code></dd> |
| <dd><code>precision</code> - number of Packed Decimal digits. Maximum valid precision is 253</dd> |
| <dd><code>checkOverflow</code> - if true an <code>ArithmeticException</code> may be thrown</dd> |
| <dt>Returns:</dt> |
| <dd>int the resulting binary integer value</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/NullPointerException.html" title="class or interface in java.lang" class="external-link" target="_blank">NullPointerException</a></code> - if <code>packedDecimal</code> is null</dd> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/ArrayIndexOutOfBoundsException.html" title="class or interface in java.lang" class="external-link" target="_blank">ArrayIndexOutOfBoundsException</a></code> - if an invalid array access occurs</dd> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/ArithmeticException.html" title="class or interface in java.lang" class="external-link" target="_blank">ArithmeticException</a></code> - if <code>checkOverflow</code> is true and the result does not fit into an int (overflow)</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="convertPackedDecimalToLong(byte[],int,int,boolean)"> |
| <h3>convertPackedDecimalToLong</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">long</span> <span class="element-name">convertPackedDecimalToLong</span>​<span class="parameters">(byte[] packedDecimal, |
| int offset, |
| int precision, |
| boolean checkOverflow)</span></div> |
| <div class="block">Converts a Packed Decimal value in a byte array into a binary long. If the digital part of the input Packed |
| Decimal is not valid then the digital part of the output will not be valid. The sign of the input Packed Decimal |
| is assumed to be positive unless the sign nibble contains one of the negative sign codes, in which case the |
| sign of the input Packed Decimal is interpreted as negative. |
| |
| Overflow can happen if the Packed Decimal value does not fit into a binary long. In this case, when |
| <code>checkOverflow</code> is true an <code>ArithmeticException</code> is thrown, when false a truncated or |
| invalid result is returned.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>packedDecimal</code> - byte array which contains the Packed Decimal value</dd> |
| <dd><code>offset</code> - offset of the first byte of the Packed Decimal in <code>packedDecimal</code></dd> |
| <dd><code>precision</code> - number of decimal digits. Maximum valid precision is 253</dd> |
| <dd><code>checkOverflow</code> - if true an <code>ArithmeticException</code> may be thrown</dd> |
| <dt>Returns:</dt> |
| <dd>long the resulting binary long value</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/NullPointerException.html" title="class or interface in java.lang" class="external-link" target="_blank">NullPointerException</a></code> - if <code>packedDecimal</code> is null</dd> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/ArrayIndexOutOfBoundsException.html" title="class or interface in java.lang" class="external-link" target="_blank">ArrayIndexOutOfBoundsException</a></code> - if an invalid array access occurs</dd> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/ArithmeticException.html" title="class or interface in java.lang" class="external-link" target="_blank">ArithmeticException</a></code> - if <code>checkOverflow</code> is true and the result does not fit into a long (overflow)</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="convertPackedDecimalToExternalDecimal(byte[],int,byte[],int,int,int)"> |
| <h3>convertPackedDecimalToExternalDecimal</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">void</span> <span class="element-name">convertPackedDecimalToExternalDecimal</span>​<span class="parameters">(byte[] packedDecimal, |
| int packedOffset, |
| byte[] externalDecimal, |
| int externalOffset, |
| int precision, |
| int decimalType)</span></div> |
| <div class="block">Converts a Packed Decimal in a byte array into an External Decimal in another byte array. If the digital part of |
| the input Packed Decimal is not valid then the digital part of the output will not be valid. The sign of the |
| input Packed Decimal is assumed to be positive unless the sign nibble contains one of the negative sign codes, |
| in which case the sign of the input Packed Decimal is interpreted as negative.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>packedDecimal</code> - byte array that holds the Packed Decimal to be converted</dd> |
| <dd><code>packedOffset</code> - offset in <code>packedDecimal</code> where the Packed Decimal is located</dd> |
| <dd><code>externalDecimal</code> - byte array that will hold the External Decimal on a successful return</dd> |
| <dd><code>externalOffset</code> - offset in <code>externalOffset</code> where the External Decimal is expected to be located</dd> |
| <dd><code>precision</code> - number of decimal digits</dd> |
| <dd><code>decimalType</code> - constant indicating the type of the decimal</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/ArrayIndexOutOfBoundsException.html" title="class or interface in java.lang" class="external-link" target="_blank">ArrayIndexOutOfBoundsException</a></code> - if an invalid array access occurs</dd> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/NullPointerException.html" title="class or interface in java.lang" class="external-link" target="_blank">NullPointerException</a></code> - if <code>packedDecimal</code> or <code>externalDecimal</code> are null</dd> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link" target="_blank">IllegalArgumentException</a></code> - if <code>precision</code> or <code>decimalType</code> is invalid</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="convertPackedDecimalToUnicodeDecimal(byte[],int,char[],int,int,int)"> |
| <h3>convertPackedDecimalToUnicodeDecimal</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">void</span> <span class="element-name">convertPackedDecimalToUnicodeDecimal</span>​<span class="parameters">(byte[] packedDecimal, |
| int packedOffset, |
| char[] unicodeDecimal, |
| int unicodeOffset, |
| int precision, |
| int decimalType)</span></div> |
| <div class="block">Convert a Packed Decimal in a byte array to a Unicode Decimal in a char array. If the digital part of the input |
| Packed Decimal is not valid then the digital part of the output will not be valid. The sign of the input Packed |
| Decimal is assumed to be positive unless the sign nibble contains one of the negative sign codes, in which |
| case the sign of the input Packed Decimal is interpreted as negative.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>packedDecimal</code> - byte array that holds a Packed Decimal to be converted</dd> |
| <dd><code>packedOffset</code> - offset in <code>packedDecimal</code> where the Packed Decimal is located</dd> |
| <dd><code>unicodeDecimal</code> - char array that will hold the Unicode Decimal on a successful return</dd> |
| <dd><code>unicodeOffset</code> - offset in the byte array where the Unicode Decimal is expected to be located</dd> |
| <dd><code>precision</code> - number of decimal digits</dd> |
| <dd><code>decimalType</code> - constant value indicating the type of the External Decimal</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/ArrayIndexOutOfBoundsException.html" title="class or interface in java.lang" class="external-link" target="_blank">ArrayIndexOutOfBoundsException</a></code> - if an invalid array access occurs</dd> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/NullPointerException.html" title="class or interface in java.lang" class="external-link" target="_blank">NullPointerException</a></code> - if <code>packedDecimal</code> or <code>unicodeDecimal</code> are null</dd> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link" target="_blank">IllegalArgumentException</a></code> - if <code>precision</code> or <code>decimalType</code> is invalid</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="convertPackedDecimalToBigInteger(byte[],int,int,boolean)"> |
| <h3>convertPackedDecimalToBigInteger</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/math/BigInteger.html" title="class or interface in java.math" class="external-link" target="_blank">BigInteger</a></span> <span class="element-name">convertPackedDecimalToBigInteger</span>​<span class="parameters">(byte[] packedDecimal, |
| int offset, |
| int precision, |
| boolean checkOverflow)</span></div> |
| <div class="block">Convert a Packed Decimal in a byte array to a BigInteger. If the digital part of the input Packed Decimal is not |
| valid then the digital part of the output will not be valid. The sign of the input Packed Decimal is assumed to |
| to be positive unless the sign nibble contains one of the negative sign codes, in which case the sign of the |
| input Packed Decimal is interpreted as negative. |
| |
| Overflow can happen if the Packed Decimal value does not fit into the BigInteger. In this case, when |
| <code>checkOverflow</code> is true an <code>ArithmeticException</code> is thrown, when false a truncated or |
| invalid result is returned.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>packedDecimal</code> - byte array that holds the Packed Decimal to be converted</dd> |
| <dd><code>offset</code> - offset in <code>packedDecimal</code> where the Packed Decimal is located</dd> |
| <dd><code>precision</code> - number of decimal digits. Maximum valid precision is 253</dd> |
| <dd><code>checkOverflow</code> - if true an <code>ArithmeticException</code> will be thrown if the decimal value does not fit in the |
| specified precision (overflow)</dd> |
| <dt>Returns:</dt> |
| <dd>BigInteger the resulting BigInteger</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/ArrayIndexOutOfBoundsException.html" title="class or interface in java.lang" class="external-link" target="_blank">ArrayIndexOutOfBoundsException</a></code> - if an invalid array access occurs</dd> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/NullPointerException.html" title="class or interface in java.lang" class="external-link" target="_blank">NullPointerException</a></code> - if <code>packedDecimal</code> is null</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="convertPackedDecimalToBigDecimal(byte[],int,int,int,boolean)"> |
| <h3>convertPackedDecimalToBigDecimal</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/math/BigDecimal.html" title="class or interface in java.math" class="external-link" target="_blank">BigDecimal</a></span> <span class="element-name">convertPackedDecimalToBigDecimal</span>​<span class="parameters">(byte[] packedDecimal, |
| int offset, |
| int precision, |
| int scale, |
| boolean checkOverflow)</span></div> |
| <div class="block">Convert a Packed Decimal in a byte array to a BigDecimal. If the digital part of the input Packed Decimal is not |
| valid then the digital part of the output will not be valid. The sign of the input Packed Decimal is assumed to |
| to be positive unless the sign nibble contains one of the negative sign codes, in which case the sign of the |
| input Packed Decimal is interpreted as negative. |
| |
| Overflow can happen if the Packed Decimal value does not fit into the BigDecimal. In this case, when |
| <code>checkOverflow</code> is true an <code>ArithmeticException</code> is thrown, when false a truncated or |
| invalid result is returned.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>packedDecimal</code> - byte array that holds the Packed Decimal to be converted</dd> |
| <dd><code>offset</code> - offset in <code>packedDecimal</code> where the Packed Decimal is located</dd> |
| <dd><code>precision</code> - number of decimal digits. Maximum valid precision is 253</dd> |
| <dd><code>scale</code> - scale of the BigDecimal to be returned</dd> |
| <dd><code>checkOverflow</code> - if true an <code>ArithmeticException</code> will be thrown if the decimal value does not fit in the |
| specified precision (overflow)</dd> |
| <dt>Returns:</dt> |
| <dd>BigDecimal the resulting BigDecimal</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/NullPointerException.html" title="class or interface in java.lang" class="external-link" target="_blank">NullPointerException</a></code> - if <code>packedDecimal</code> is null</dd> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/ArrayIndexOutOfBoundsException.html" title="class or interface in java.lang" class="external-link" target="_blank">ArrayIndexOutOfBoundsException</a></code> - /requires rounding if an invalid array access occurs</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="convertExternalDecimalToInteger(byte[],int,int,boolean,int)"> |
| <h3>convertExternalDecimalToInteger</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">int</span> <span class="element-name">convertExternalDecimalToInteger</span>​<span class="parameters">(byte[] externalDecimal, |
| int offset, |
| int precision, |
| boolean checkOverflow, |
| int decimalType)</span></div> |
| <div class="block">Converts an External Decimal value in a byte array into a binary integer. If the digital part of the input |
| External Decimal is not valid then the digital part of the output will not be valid. The sign of the input |
| External Decimal is assumed to be positive unless the sign nibble or byte (depending on |
| <code>decimalType</code>) contains one of the negative sign codes, in which case the sign of the input External |
| Decimal is interpreted as negative. |
| |
| Overflow can happen if the External Decimal value does not fit into a binary integer. In this case, when |
| <code>checkOverflow</code> is true an <code>ArithmeticException</code> is thrown, when false the resulting number |
| will be wrapped around starting at the minimum/maximum possible integer value.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>externalDecimal</code> - byte array which contains the External Decimal value</dd> |
| <dd><code>offset</code> - the offset where the External Decimal value is located</dd> |
| <dd><code>precision</code> - number of decimal digits. Maximum valid precision is 253</dd> |
| <dd><code>checkOverflow</code> - if true an <code>ArithmeticException</code> or <code>IllegalArgumentException</code> may be thrown. If |
| false and there is an overflow, the result is undefined.</dd> |
| <dd><code>decimalType</code> - constant value indicating the type of External Decimal</dd> |
| <dt>Returns:</dt> |
| <dd>int the resulting binary integer</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/NullPointerException.html" title="class or interface in java.lang" class="external-link" target="_blank">NullPointerException</a></code> - if <code>externalDecimal</code> is null</dd> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/ArrayIndexOutOfBoundsException.html" title="class or interface in java.lang" class="external-link" target="_blank">ArrayIndexOutOfBoundsException</a></code> - if an invalid array access occurs</dd> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/ArithmeticException.html" title="class or interface in java.lang" class="external-link" target="_blank">ArithmeticException</a></code> - if <code>checkOverflow</code> is true and the result does not fit into a int (overflow)</dd> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link" target="_blank">IllegalArgumentException</a></code> - if <code>precision</code> or <code>decimalType</code> is invalid</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="convertExternalDecimalToLong(byte[],int,int,boolean,int)"> |
| <h3>convertExternalDecimalToLong</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">long</span> <span class="element-name">convertExternalDecimalToLong</span>​<span class="parameters">(byte[] externalDecimal, |
| int offset, |
| int precision, |
| boolean checkOverflow, |
| int decimalType)</span></div> |
| <div class="block">Converts an External Decimal value in a byte array into a long. If the digital part of the input External Decimal |
| is not valid then the digital part of the output will not be valid. The sign of the input External Decimal is |
| assumed to be positive unless the sign nibble or byte (depending on <code>decimalType</code>) contains one of |
| the negative sign codes, in which case the sign of the input External Decimal is interpreted as negative. |
| |
| Overflow can happen if the External Decimal value does not fit into a binary long. When |
| <code>checkOverflow</code> is true overflow results in an <code>ArithmeticException</code>, when false the |
| resulting number will be wrapped around starting at the minimum/maximum possible long value.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>externalDecimal</code> - byte array which contains the External Decimal value</dd> |
| <dd><code>offset</code> - offset of the first byte of the Packed Decimal in the <code>externalDecimal</code></dd> |
| <dd><code>precision</code> - number of External Decimal digits. Maximum valid precision is 253</dd> |
| <dd><code>checkOverflow</code> - if true an <code>ArithmeticException</code> will be thrown when the converted value cannot fit into |
| designated External Decimal array. If false and there is an overflow, the result is undefined.</dd> |
| <dd><code>decimalType</code> - constant value indicating the type of External Decimal</dd> |
| <dt>Returns:</dt> |
| <dd>long the resulting binary long value</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/NullPointerException.html" title="class or interface in java.lang" class="external-link" target="_blank">NullPointerException</a></code> - if <code>externalDecimal</code> is null</dd> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/ArrayIndexOutOfBoundsException.html" title="class or interface in java.lang" class="external-link" target="_blank">ArrayIndexOutOfBoundsException</a></code> - if an invalid array access occurs</dd> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/ArithmeticException.html" title="class or interface in java.lang" class="external-link" target="_blank">ArithmeticException</a></code> - if <code>checkOverflow</code> is true and the result does not fit into a long (overflow)</dd> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link" target="_blank">IllegalArgumentException</a></code> - if <code>precision</code> or <code>decimalType</code> is invalid</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="convertExternalDecimalToPackedDecimal(byte[],int,byte[],int,int,int)"> |
| <h3>convertExternalDecimalToPackedDecimal</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">void</span> <span class="element-name">convertExternalDecimalToPackedDecimal</span>​<span class="parameters">(byte[] externalDecimal, |
| int externalOffset, |
| byte[] packedDecimal, |
| int packedOffset, |
| int precision, |
| int decimalType)</span></div> |
| <div class="block">Converts an External Decimal in a byte array to a Packed Decimal in another byte array. If the digital part of |
| the input External Decimal is not valid then the digital part of the output will not be valid. The sign of the |
| input External Decimal is assumed to be positive unless the sign nibble or byte (depending on |
| <code>decimalType</code>) contains one of the negative sign codes, in which case the sign of the input External |
| Decimal is interpreted as negative.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>externalDecimal</code> - byte array holding the External Decimal to be converted</dd> |
| <dd><code>externalOffset</code> - offset in <code>externalDecimal</code> where the External Decimal is located</dd> |
| <dd><code>packedDecimal</code> - byte array which will hold the Packed Decimal on a successful return</dd> |
| <dd><code>packedOffset</code> - offset in <code>packedDecimal</code> where the Packed Decimal is expected to be located</dd> |
| <dd><code>precision</code> - the number of decimal digits</dd> |
| <dd><code>decimalType</code> - constant value indicating the type of External Decimal</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/ArrayIndexOutOfBoundsException.html" title="class or interface in java.lang" class="external-link" target="_blank">ArrayIndexOutOfBoundsException</a></code> - if an invalid array access occurs</dd> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/NullPointerException.html" title="class or interface in java.lang" class="external-link" target="_blank">NullPointerException</a></code> - if <code>packedDecimal</code> or <code>externalDecimal</code> is null</dd> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link" target="_blank">IllegalArgumentException</a></code> - if <code>precision</code> or <code>decimalType</code> is invalid</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="convertExternalDecimalToBigInteger(byte[],int,int,boolean,int)"> |
| <h3>convertExternalDecimalToBigInteger</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/math/BigInteger.html" title="class or interface in java.math" class="external-link" target="_blank">BigInteger</a></span> <span class="element-name">convertExternalDecimalToBigInteger</span>​<span class="parameters">(byte[] externalDecimal, |
| int offset, |
| int precision, |
| boolean checkOverflow, |
| int decimalType)</span></div> |
| <div class="block">Convert an External Decimal in a byte array to a BigInteger. The sign of the input External Decimal is assumed to |
| to be positive unless the sign nibble or byte (depending on <code>decimalType</code>) contains one of the |
| negative sign codes, in which case the sign of the input External Decimal is interpreted as negative. |
| |
| Overflow can happen if the External Decimal value does not fit into the BigInteger. In this case, when |
| <code>checkOverflow</code> is true an <code>ArithmeticException</code> is thrown, when false a truncated or |
| invalid result is returned.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>externalDecimal</code> - byte array that holds the Packed Decimal to be converted</dd> |
| <dd><code>offset</code> - offset in <code>externalDecimal</code> where the Packed Decimal is located</dd> |
| <dd><code>precision</code> - number of decimal digits. Maximum valid precision is 253</dd> |
| <dd><code>checkOverflow</code> - if true an <code>ArithmeticException</code> will be thrown if the decimal value does not fit in the |
| specified precision (overflow)</dd> |
| <dd><code>decimalType</code> - constant value indicating the type of External Decimal</dd> |
| <dt>Returns:</dt> |
| <dd>BigInteger the resulting BigInteger</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/ArrayIndexOutOfBoundsException.html" title="class or interface in java.lang" class="external-link" target="_blank">ArrayIndexOutOfBoundsException</a></code> - if an invalid array access occurs</dd> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/NullPointerException.html" title="class or interface in java.lang" class="external-link" target="_blank">NullPointerException</a></code> - if <code>externalDecimal</code> is null</dd> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/ArithmeticException.html" title="class or interface in java.lang" class="external-link" target="_blank">ArithmeticException</a></code> - if <code>checkOverflow</code> is true and the result overflows</dd> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link" target="_blank">IllegalArgumentException</a></code> - if <code>decimalType</code> or <code>precision</code> is invalid, or the digital part of the input is |
| invalid.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="convertExternalDecimalToBigDecimal(byte[],int,int,int,boolean,int)"> |
| <h3>convertExternalDecimalToBigDecimal</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/math/BigDecimal.html" title="class or interface in java.math" class="external-link" target="_blank">BigDecimal</a></span> <span class="element-name">convertExternalDecimalToBigDecimal</span>​<span class="parameters">(byte[] externalDecimal, |
| int offset, |
| int precision, |
| int scale, |
| boolean checkOverflow, |
| int decimalType)</span></div> |
| <div class="block">Converts an External Decimal in a byte array to a BigDecimal. The sign of the input External Decimal is assumed |
| to be positive unless the sign nibble or byte (depending on <code>decimalType</code>) contains one of the |
| negative sign codes, in which case the sign of the input External Decimal is interpreted as negative. |
| |
| Overflow can happen if the External Decimal value does not fit into the BigDecimal. In this case, when |
| <code>checkOverflow</code> is true an <code>ArithmeticException</code> is thrown, when false a truncated or |
| invalid result is returned.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>externalDecimal</code> - byte array holding the External Decimal to be converted</dd> |
| <dd><code>offset</code> - offset in <code>externalDecimal</code> where the External Decimal is located</dd> |
| <dd><code>precision</code> - number of decimal digits. Maximum valid precision is 253</dd> |
| <dd><code>scale</code> - scale of the BigDecimal</dd> |
| <dd><code>checkOverflow</code> - if true an <code>ArithmeticException</code> will be thrown if the decimal value does not fit in the |
| specified precision (overflow)</dd> |
| <dd><code>decimalType</code> - constant value that indicates the type of External Decimal</dd> |
| <dt>Returns:</dt> |
| <dd>BigDecimal the resulting BigDecimal</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/NullPointerException.html" title="class or interface in java.lang" class="external-link" target="_blank">NullPointerException</a></code> - if <code>externalDecimal</code> is null</dd> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/ArrayIndexOutOfBoundsException.html" title="class or interface in java.lang" class="external-link" target="_blank">ArrayIndexOutOfBoundsException</a></code> - if an invalid array access occurs</dd> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/ArithmeticException.html" title="class or interface in java.lang" class="external-link" target="_blank">ArithmeticException</a></code> - if <code>checkOverflow</code> is true and the result overflows</dd> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link" target="_blank">IllegalArgumentException</a></code> - if <code>checkOverflow</code> is true and the Packed Decimal is in an invalid format, or the digital |
| part of the input is invalid.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="convertUnicodeDecimalToInteger(char[],int,int,boolean,int)"> |
| <h3>convertUnicodeDecimalToInteger</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">int</span> <span class="element-name">convertUnicodeDecimalToInteger</span>​<span class="parameters">(char[] unicodeDecimal, |
| int offset, |
| int precision, |
| boolean checkOverflow, |
| int unicodeType)</span></div> |
| <div class="block">Converts a Unicode Decimal value in a char array into a binary integer. The sign of the input Unicode Decimal is |
| assumed to be positive unless the sign char contains the negative sign code, in which case the sign of the |
| input Unicode Decimal is interpreted as negative. |
| |
| Overflow can happen if the Unicode Decimal value does not fit into a binary int. In this case, when |
| <code>checkOverflow</code> is true an <code>ArithmeticException</code> is thrown, when false a truncated or |
| invalid result is returned.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>unicodeDecimal</code> - char array which contains the Unicode Decimal value</dd> |
| <dd><code>offset</code> - the offset where the Unicode Decimal value is located</dd> |
| <dd><code>precision</code> - number of decimal digits. Maximum valid precision is 253</dd> |
| <dd><code>checkOverflow</code> - if true an <code>ArithmeticException</code> or <code>IllegalArgumentException</code> may be thrown</dd> |
| <dd><code>unicodeType</code> - constant value indicating the type of External Decimal</dd> |
| <dt>Returns:</dt> |
| <dd>int the resulting binary integer</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/NullPointerException.html" title="class or interface in java.lang" class="external-link" target="_blank">NullPointerException</a></code> - if <code>unicodeDecimal</code> is null</dd> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/ArrayIndexOutOfBoundsException.html" title="class or interface in java.lang" class="external-link" target="_blank">ArrayIndexOutOfBoundsException</a></code> - if an invalid array access occurs</dd> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/ArithmeticException.html" title="class or interface in java.lang" class="external-link" target="_blank">ArithmeticException</a></code> - if <code>checkOverflow</code> is true and the result does not fit into a long (overflow)</dd> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link" target="_blank">IllegalArgumentException</a></code> - if <code>precision</code> or <code>decimalType</code> is invalid, or the digital part of the input is |
| invalid.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="convertUnicodeDecimalToLong(char[],int,int,boolean,int)"> |
| <h3>convertUnicodeDecimalToLong</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">long</span> <span class="element-name">convertUnicodeDecimalToLong</span>​<span class="parameters">(char[] unicodeDecimal, |
| int offset, |
| int precision, |
| boolean checkOverflow, |
| int unicodeType)</span></div> |
| <div class="block">Converts a Unicode Decimal value in a char array into a binary long. The sign of the input Unicode Decimal is |
| assumed to be positive unless the sign char contains the negative sign code, in which case the sign of the |
| input Unicode Decimal is interpreted as negative. |
| |
| Overflow can happen if the Unicode Decimal value does not fit into a binary long. In this case, when |
| <code>checkOverflow</code> is true an <code>ArithmeticException</code> is thrown, when false a truncated or |
| invalid result is returned.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>unicodeDecimal</code> - char array which contains the External Decimal value</dd> |
| <dd><code>offset</code> - offset of the first byte of the Unicode Decimal in <code>unicodeDecimal</code></dd> |
| <dd><code>precision</code> - number of Unicode Decimal digits. Maximum valid precision is 253</dd> |
| <dd><code>checkOverflow</code> - if true an <code>ArithmeticException</code> will be thrown when</dd> |
| <dd><code>unicodeType</code> - constant value indicating the type of External Decimal</dd> |
| <dt>Returns:</dt> |
| <dd>long the resulting binary long value</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/NullPointerException.html" title="class or interface in java.lang" class="external-link" target="_blank">NullPointerException</a></code> - if <code>unicodeDecimal</code> is null</dd> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/ArrayIndexOutOfBoundsException.html" title="class or interface in java.lang" class="external-link" target="_blank">ArrayIndexOutOfBoundsException</a></code> - if an invalid array access occurs</dd> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/ArithmeticException.html" title="class or interface in java.lang" class="external-link" target="_blank">ArithmeticException</a></code> - if <code>checkOverflow</code> is true and the result does not fit into a long (overflow)</dd> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link" target="_blank">IllegalArgumentException</a></code> - if <code>unicodeType</code> or <code>precision</code> is invalid, or the digital part of the input is |
| invalid.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="convertUnicodeDecimalToPackedDecimal(char[],int,byte[],int,int,int)"> |
| <h3>convertUnicodeDecimalToPackedDecimal</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">void</span> <span class="element-name">convertUnicodeDecimalToPackedDecimal</span>​<span class="parameters">(char[] unicodeDecimal, |
| int unicodeOffset, |
| byte[] packedDecimal, |
| int packedOffset, |
| int precision, |
| int decimalType)</span></div> |
| <div class="block">Converts an Unicode Decimal in a char array to a Packed Decimal in a byte array. If the digital part of the input |
| Unicode Decimal is not valid then the digital part of the output will not be valid. The sign of the input Unicode |
| Decimal is assumed to be positive unless the sign byte contains the negative sign code, in which case the sign |
| of the input Unicode Decimal is interpreted as negative.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>unicodeDecimal</code> - char array that holds the Unicode Decimal to be converted</dd> |
| <dd><code>unicodeOffset</code> - offset in <code>unicodeDecimal</code> at which the Unicode Decimal is located</dd> |
| <dd><code>packedDecimal</code> - byte array that will hold the Packed Decimal on a successful return</dd> |
| <dd><code>packedOffset</code> - offset in <code>packedDecimal</code> where the Packed Decimal is expected to be located</dd> |
| <dd><code>precision</code> - number of decimal digits</dd> |
| <dd><code>decimalType</code> - constant value indicating the type of External Decimal</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/ArrayIndexOutOfBoundsException.html" title="class or interface in java.lang" class="external-link" target="_blank">ArrayIndexOutOfBoundsException</a></code> - if an invalid array access occurs</dd> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/NullPointerException.html" title="class or interface in java.lang" class="external-link" target="_blank">NullPointerException</a></code> - if <code>packedDecimal</code> or <code>unicodeDecimal</code> are null</dd> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link" target="_blank">IllegalArgumentException</a></code> - if <code>precision</code> or <code>decimalType</code> is invalid</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="convertUnicodeDecimalToBigInteger(char[],int,int,boolean,int)"> |
| <h3>convertUnicodeDecimalToBigInteger</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/math/BigInteger.html" title="class or interface in java.math" class="external-link" target="_blank">BigInteger</a></span> <span class="element-name">convertUnicodeDecimalToBigInteger</span>​<span class="parameters">(char[] unicodeDecimal, |
| int offset, |
| int precision, |
| boolean checkOverflow, |
| int decimalType)</span></div> |
| <div class="block">Convert a Unicode Decimal in a char array to a BigInteger. The sign of the input Unicode Decimal is assumed to |
| be positive unless the sign byte contains the negative sign code, in which case the sign of the input Unicode |
| Decimal is interpreted as negative. |
| |
| Overflow can happen if the Unicode Decimal value does not fit into a binary long. In this case, when |
| <code>checkOverflow</code> is true an <code>ArithmeticException</code> is thrown, when false a truncated or |
| invalid result is returned.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>unicodeDecimal</code> - char array that holds the Packed Decimal to be converted</dd> |
| <dd><code>offset</code> - offset into <code>unicodeDecimal</code> where the Packed Decimal is located</dd> |
| <dd><code>precision</code> - number of decimal digits. Maximum valid precision is 253</dd> |
| <dd><code>checkOverflow</code> - if true an <code>ArithmeticException</code> will be thrown if the decimal value does not fit in the |
| specified precision (overflow)</dd> |
| <dd><code>decimalType</code> - constant value indicating the type of External Decimal</dd> |
| <dt>Returns:</dt> |
| <dd>BigInteger the resulting BigInteger</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/ArrayIndexOutOfBoundsException.html" title="class or interface in java.lang" class="external-link" target="_blank">ArrayIndexOutOfBoundsException</a></code> - if an invalid array access occurs</dd> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/NullPointerException.html" title="class or interface in java.lang" class="external-link" target="_blank">NullPointerException</a></code> - if <code>unicodeDecimal</code> is null</dd> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/ArithmeticException.html" title="class or interface in java.lang" class="external-link" target="_blank">ArithmeticException</a></code> - if <code>checkOverflow</code> is true and the result overflows</dd> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link" target="_blank">IllegalArgumentException</a></code> - if <code>decimalType</code> or <code>precision</code> is invalid, or the digital part of the input is |
| invalid.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="convertUnicodeDecimalToBigDecimal(char[],int,int,int,boolean,int)"> |
| <h3>convertUnicodeDecimalToBigDecimal</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/math/BigDecimal.html" title="class or interface in java.math" class="external-link" target="_blank">BigDecimal</a></span> <span class="element-name">convertUnicodeDecimalToBigDecimal</span>​<span class="parameters">(char[] unicodeDecimal, |
| int offset, |
| int precision, |
| int scale, |
| boolean checkOverflow, |
| int decimalType)</span></div> |
| <div class="block">Converts a Unicode Decimal in a char array to a BigDecimal. The sign of the input Unicode Decimal is assumed to |
| to be positive unless the sign byte contains the negative sign code, in which case the sign of the input Unicode |
| Decimal is interpreted as negative. |
| |
| Overflow can happen if the Unicode Decimal value does not fit into the BigDecimal. In this case, when |
| <code>checkOverflow</code> is true an <code>ArithmeticException</code> is thrown, when false a truncated or |
| invalid result is returned.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>unicodeDecimal</code> - char array that holds the Unicode Decimal</dd> |
| <dd><code>offset</code> - offset in <code>unicodeDecimal</code> where the Unicode Decimal is located</dd> |
| <dd><code>precision</code> - number of decimal digits. Maximum valid precision is 253</dd> |
| <dd><code>scale</code> - scale of the returned BigDecimal</dd> |
| <dd><code>checkOverflow</code> - if true an <code>ArithmeticException</code> will be thrown if the decimal value does not fit in the |
| specified precision (overflow)</dd> |
| <dd><code>decimalType</code> - constant value indicating the type of External Decimal</dd> |
| <dt>Returns:</dt> |
| <dd>BigDecimal</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/NullPointerException.html" title="class or interface in java.lang" class="external-link" target="_blank">NullPointerException</a></code> - if <code>unicodeDecimal</code> is null</dd> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/ArrayIndexOutOfBoundsException.html" title="class or interface in java.lang" class="external-link" target="_blank">ArrayIndexOutOfBoundsException</a></code> - if an invalid array access occurs</dd> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/ArithmeticException.html" title="class or interface in java.lang" class="external-link" target="_blank">ArithmeticException</a></code> - if <code>checkOverflow</code> is true and the result overflows</dd> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link" target="_blank">IllegalArgumentException</a></code> - if <code>checkOverflow</code> is true and the Packed Decimal is in an invalid format, or the digital |
| part of the input is invalid.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="convertBigIntegerToPackedDecimal(java.math.BigInteger,byte[],int,int,boolean)"> |
| <h3>convertBigIntegerToPackedDecimal</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">void</span> <span class="element-name">convertBigIntegerToPackedDecimal</span>​<span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/math/BigInteger.html" title="class or interface in java.math" class="external-link" target="_blank">BigInteger</a> bigIntegerValue, |
| byte[] packedDecimal, |
| int offset, |
| int precision, |
| boolean checkOverflow)</span></div> |
| <div class="block">Converts a BigInteger value into a Packed Decimal in a byte array |
| |
| Overflow can happen if the BigInteger does not fit into the byte array. In this case, when |
| <code>checkOverflow</code> is true an <code>ArithmeticException</code> is thrown, when false a truncated or |
| invalid result is returned.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>bigIntegerValue</code> - BigInteger value to be converted</dd> |
| <dd><code>packedDecimal</code> - byte array which will hold the Packed Decimal on a successful return</dd> |
| <dd><code>offset</code> - offset into <code>packedDecimal</code> where the Packed Decimal is expected to be located</dd> |
| <dd><code>precision</code> - number of decimal digits. Maximum valid precision is 253s</dd> |
| <dd><code>checkOverflow</code> - if true an <code>ArithmeticException</code> will be thrown if the decimal value does not fit in the |
| specified precision (overflow)</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/NullPointerException.html" title="class or interface in java.lang" class="external-link" target="_blank">NullPointerException</a></code> - if <code>packedDecimal</code> is null</dd> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/ArrayIndexOutOfBoundsException.html" title="class or interface in java.lang" class="external-link" target="_blank">ArrayIndexOutOfBoundsException</a></code> - if an invalid array access occurs</dd> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/ArithmeticException.html" title="class or interface in java.lang" class="external-link" target="_blank">ArithmeticException</a></code> - if <code>checkOverflow</code> is true and the result overflows</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="convertBigIntegerToExternalDecimal(java.math.BigInteger,byte[],int,int,boolean,int)"> |
| <h3>convertBigIntegerToExternalDecimal</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">void</span> <span class="element-name">convertBigIntegerToExternalDecimal</span>​<span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/math/BigInteger.html" title="class or interface in java.math" class="external-link" target="_blank">BigInteger</a> bigIntegerValue, |
| byte[] externalDecimal, |
| int offset, |
| int precision, |
| boolean checkOverflow, |
| int decimalType)</span></div> |
| <div class="block">Converts a BigInteger value into an External Decimal in a byte array |
| |
| Overflow can happen if the BigInteger does not fit into the byte array. In this case, when |
| <code>checkOverflow</code> is true an <code>ArithmeticException</code> is thrown, when false a truncated or |
| invalid result is returned.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>bigIntegerValue</code> - BigInteger value to be converted</dd> |
| <dd><code>externalDecimal</code> - byte array which will hold the External Decimal on a successful return</dd> |
| <dd><code>offset</code> - offset into <code>externalDecimal</code> where the External Decimal is expected to be located</dd> |
| <dd><code>precision</code> - number of decimal digits. Maximum valid precision is 253</dd> |
| <dd><code>checkOverflow</code> - if true an <code>ArithmeticException</code> will be thrown if the decimal value does not fit in the |
| specified precision (overflow)</dd> |
| <dd><code>decimalType</code> - constant value that indicates the type of External Decimal</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/NullPointerException.html" title="class or interface in java.lang" class="external-link" target="_blank">NullPointerException</a></code> - if <code>externalDecimal</code> is null</dd> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/ArrayIndexOutOfBoundsException.html" title="class or interface in java.lang" class="external-link" target="_blank">ArrayIndexOutOfBoundsException</a></code> - if an invalid array access occurs</dd> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/ArithmeticException.html" title="class or interface in java.lang" class="external-link" target="_blank">ArithmeticException</a></code> - if <code>checkOverflow</code> is true and the result overflows</dd> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link" target="_blank">IllegalArgumentException</a></code> - if <code>decimalType</code> or <code>precision</code> is invalid</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="convertBigIntegerToUnicodeDecimal(java.math.BigInteger,char[],int,int,boolean,int)"> |
| <h3>convertBigIntegerToUnicodeDecimal</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">void</span> <span class="element-name">convertBigIntegerToUnicodeDecimal</span>​<span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/math/BigInteger.html" title="class or interface in java.math" class="external-link" target="_blank">BigInteger</a> bigIntegerValue, |
| char[] unicodeDecimal, |
| int offset, |
| int precision, |
| boolean checkOverflow, |
| int decimalType)</span></div> |
| <div class="block">Converts a BigInteger value to a Unicode Decimal in a char array |
| |
| Overflow can happen if the BigInteger does not fit into the char array. In this case, when |
| <code>checkOverflow</code> is true an <code>ArithmeticException</code> is thrown, when false a truncated or |
| invalid result is returned.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>bigIntegerValue</code> - BigInteger value to be converted</dd> |
| <dd><code>unicodeDecimal</code> - char array that will hold the Unicode decimal on a successful return</dd> |
| <dd><code>offset</code> - offset into <code>unicodeDecimal</code> where the Unicode Decimal is expected to be located</dd> |
| <dd><code>precision</code> - number of decimal digits. Maximum valid precision is 253</dd> |
| <dd><code>checkOverflow</code> - if true an <code>ArithmeticException</code> will be thrown if the decimal value does not fit in the |
| specified precision (overflow)</dd> |
| <dd><code>decimalType</code> - constant indicating the type of External Decimal</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/NullPointerException.html" title="class or interface in java.lang" class="external-link" target="_blank">NullPointerException</a></code> - if <code>unicodeDecimal</code> is null</dd> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/ArrayIndexOutOfBoundsException.html" title="class or interface in java.lang" class="external-link" target="_blank">ArrayIndexOutOfBoundsException</a></code> - if an invalid array access occurs</dd> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/ArithmeticException.html" title="class or interface in java.lang" class="external-link" target="_blank">ArithmeticException</a></code> - if <code>checkOverflow</code> is true and the result overflows</dd> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link" target="_blank">IllegalArgumentException</a></code> - if <code>decimalType</code> or <code>precision</code> is invalid</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="convertBigDecimalToPackedDecimal(java.math.BigDecimal,byte[],int,int,boolean)"> |
| <h3>convertBigDecimalToPackedDecimal</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">void</span> <span class="element-name">convertBigDecimalToPackedDecimal</span>​<span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/math/BigDecimal.html" title="class or interface in java.math" class="external-link" target="_blank">BigDecimal</a> bigDecimalValue, |
| byte[] packedDecimal, |
| int offset, |
| int precision, |
| boolean checkOverflow)</span></div> |
| <div class="block">Converts a BigDecimal into a Packed Decimal in a byte array |
| |
| Overflow can happen if the BigDecimal does not fit into the result byte array. In this case, when |
| <code>checkOverflow</code> is true an <code>ArithmeticException</code> is thrown, when false a truncated or |
| invalid result is returned.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>bigDecimalValue</code> - the BigDecimal value to be converted</dd> |
| <dd><code>packedDecimal</code> - byte array which will hold the Packed Decimal on a successful return</dd> |
| <dd><code>offset</code> - desired offset in <code>packedDecimal</code> where the Packed Decimal is expected to be located</dd> |
| <dd><code>precision</code> - number of decimal digits. Maximum valid precision is 253</dd> |
| <dd><code>checkOverflow</code> - if true an <code>ArithmeticException</code> will be thrown if the decimal value does not fit in the |
| specified precision (overflow)</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/NullPointerException.html" title="class or interface in java.lang" class="external-link" target="_blank">NullPointerException</a></code> - if <code>packedDecimal</code> is null</dd> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/ArrayIndexOutOfBoundsException.html" title="class or interface in java.lang" class="external-link" target="_blank">ArrayIndexOutOfBoundsException</a></code> - if an invalid array access occurs</dd> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/ArithmeticException.html" title="class or interface in java.lang" class="external-link" target="_blank">ArithmeticException</a></code> - if <code>checkOverflow</code> is true and the result overflows</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="convertBigDecimalToExternalDecimal(java.math.BigDecimal,byte[],int,int,boolean,int)"> |
| <h3>convertBigDecimalToExternalDecimal</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">void</span> <span class="element-name">convertBigDecimalToExternalDecimal</span>​<span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/math/BigDecimal.html" title="class or interface in java.math" class="external-link" target="_blank">BigDecimal</a> bigDecimalValue, |
| byte[] externalDecimal, |
| int offset, |
| int precision, |
| boolean checkOverflow, |
| int decimalType)</span></div> |
| <div class="block">Converts a BigDecimal value to an External Decimal in a byte array |
| |
| Overflow can happen if the BigDecimal does not fit into the result byte array. In this case, when |
| <code>checkOverflow</code> is true an <code>ArithmeticException</code> is thrown, when false a truncated or |
| invalid result is returned.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>bigDecimalValue</code> - BigDecimal value to be converted</dd> |
| <dd><code>externalDecimal</code> - byte array that will hold the External Decimal on a successful return</dd> |
| <dd><code>offset</code> - offset in <code>externalDecimal</code> where the External Decimal is expected to be located</dd> |
| <dd><code>precision</code> - number of decimal digits. Maximum valid precision is 253</dd> |
| <dd><code>checkOverflow</code> - if true an <code>ArithmeticException</code> will be thrown if the decimal value does not fit in the |
| specified precision (overflow)</dd> |
| <dd><code>decimalType</code> - constant value indicating the External Decimal type</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/NullPointerException.html" title="class or interface in java.lang" class="external-link" target="_blank">NullPointerException</a></code> - if <code>externalDecimal</code> is null</dd> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/ArrayIndexOutOfBoundsException.html" title="class or interface in java.lang" class="external-link" target="_blank">ArrayIndexOutOfBoundsException</a></code> - if an invalid array access occurs</dd> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/ArithmeticException.html" title="class or interface in java.lang" class="external-link" target="_blank">ArithmeticException</a></code> - if <code>checkOverflow</code> is true and the result overflows</dd> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link" target="_blank">IllegalArgumentException</a></code> - if <code>precision</code> or <code>decimalType</code> is invalid</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="convertBigDecimalToUnicodeDecimal(java.math.BigDecimal,char[],int,int,boolean,int)"> |
| <h3>convertBigDecimalToUnicodeDecimal</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">void</span> <span class="element-name">convertBigDecimalToUnicodeDecimal</span>​<span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/math/BigDecimal.html" title="class or interface in java.math" class="external-link" target="_blank">BigDecimal</a> bigDecimalValue, |
| char[] unicodeDecimal, |
| int offset, |
| int precision, |
| boolean checkOverflow, |
| int decimalType)</span></div> |
| <div class="block">Converts a BigDecimal value to a Unicode Decimal in a char array |
| |
| Overflow can happen if the BigDecimal does not fit into the result char array. In this case, when |
| <code>checkOverflow</code> is true an <code>ArithmeticException</code> is thrown, when false a truncated or |
| invalid result is returned.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>bigDecimalValue</code> - BigDecimal value to be converted</dd> |
| <dd><code>unicodeDecimal</code> - char array which will hold the Unicode Decimal on a successful return</dd> |
| <dd><code>offset</code> - offset in <code>unicodeDecimal</code> where the Unicode Decimal is expected to be located</dd> |
| <dd><code>precision</code> - number of decimal digits. Maximum valid precision is 253</dd> |
| <dd><code>checkOverflow</code> - if true an <code>ArithmeticException</code> will be thrown if the decimal value does not fit in the |
| specified precision (overflow)</dd> |
| <dd><code>decimalType</code> - constant value that indicates the type of External Decimal</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/NullPointerException.html" title="class or interface in java.lang" class="external-link" target="_blank">NullPointerException</a></code> - if <code>unicodeDecimal</code> is null</dd> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/ArrayIndexOutOfBoundsException.html" title="class or interface in java.lang" class="external-link" target="_blank">ArrayIndexOutOfBoundsException</a></code> - if an invalid array access occurs</dd> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/ArithmeticException.html" title="class or interface in java.lang" class="external-link" target="_blank">ArithmeticException</a></code> - if <code>checkOverflow</code> is true and the result overflows</dd> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link" target="_blank">IllegalArgumentException</a></code> - if <code>decimalType</code> or <code>precision</code> is invalid</dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <footer role="contentinfo"> |
| <hr> |
| <p class="legal-copy"><small><a href="https://www.eclipse.org/openj9/" target="_blank">Eclipse OpenJ9 website.</a><br> To raise a bug report or suggest an improvement create an <a href="https://github.com/eclipse-openj9/openj9/issues" target="_blank">Eclipse Openj9 issue.</a><br> Copyright © 1998, 2021, IBM Corp. and others.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |
