| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (11.0.10) on Mon Dec 05 10:27:04 MSK 2022 --> |
| <title>ExtendedType (cayenne-doc: Cayenne Documentation 4.2.RC2 API)</title> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="dc.created" content="2022-12-05"> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../jquery/jquery-ui.css" title="Style"> |
| <script type="text/javascript" src="../../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../../jquery/jszip/dist/jszip.min.js"></script> |
| <script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script> |
| <!--[if IE]> |
| <script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script> |
| <![endif]--> |
| <script type="text/javascript" src="../../../../../jquery/jquery-3.5.1.js"></script> |
| <script type="text/javascript" src="../../../../../jquery/jquery-ui.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="ExtendedType (cayenne-doc: Cayenne Documentation 4.2.RC2 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| var pathtoroot = "../../../../../"; |
| var useModuleDirectories = false; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <header role="banner"> |
| <nav role="navigation"> |
| <div class="fixedNav"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a id="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/ExtendedType.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../help-doc.html">Help</a></li> |
| </ul> |
| <div class="aboutLanguage"><a href="http://cayenne.apache.org" target="top">Apache Cayenne</a></div> |
| </div> |
| <div class="subNav"> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../allclasses.html">All Classes</a></li> |
| </ul> |
| <ul class="navListSearch"> |
| <li><label for="search">SEARCH:</label> |
| <input type="text" id="search" value="search" disabled="disabled"> |
| <input type="reset" id="reset" value="reset" disabled="disabled"> |
| </li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <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="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a id="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| </div> |
| <div class="navPadding"> </div> |
| <script type="text/javascript"><!-- |
| $('.navPadding').css('padding-top', $('.fixedNav').css("height")); |
| //--> |
| </script> |
| </nav> |
| </header> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <main role="main"> |
| <div class="header"> |
| <div class="subTitle"><span class="packageLabelInType">Package</span> <a href="package-summary.html">org.apache.cayenne.access.types</a></div> |
| <h2 title="Interface ExtendedType" class="title">Interface ExtendedType<T></h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><code><a href="BigDecimalType.html" title="class in org.apache.cayenne.access.types">BigDecimalType</a></code>, <code><a href="BooleanType.html" title="class in org.apache.cayenne.access.types">BooleanType</a></code>, <code><a href="ByteArrayType.html" title="class in org.apache.cayenne.access.types">ByteArrayType</a></code>, <code><a href="ByteType.html" title="class in org.apache.cayenne.access.types">ByteType</a></code>, <code><a href="CalendarType.html" title="class in org.apache.cayenne.access.types">CalendarType</a></code>, <code><a href="CharType.html" title="class in org.apache.cayenne.access.types">CharType</a></code>, <code><a href="DateType.html" title="class in org.apache.cayenne.access.types">DateType</a></code>, <code><a href="DoubleType.html" title="class in org.apache.cayenne.access.types">DoubleType</a></code>, <code><a href="DurationType.html" title="class in org.apache.cayenne.access.types">DurationType</a></code>, <code><a href="EnumType.html" title="class in org.apache.cayenne.access.types">EnumType</a></code>, <code><a href="ExtendedEnumType.html" title="class in org.apache.cayenne.access.types">ExtendedEnumType</a></code>, <code><a href="FloatType.html" title="class in org.apache.cayenne.access.types">FloatType</a></code>, <code><a href="GeoJsonType.html" title="class in org.apache.cayenne.access.types">GeoJsonType</a></code>, <code><a href="../../dba/h2/H2CharType.html" title="class in org.apache.cayenne.dba.h2">H2CharType</a></code>, <code><a href="../../dba/ingres/IngresBooleanType.html" title="class in org.apache.cayenne.dba.ingres">IngresBooleanType</a></code>, <code><a href="IntegerType.html" title="class in org.apache.cayenne.access.types">IntegerType</a></code>, <code><a href="JsonType.html" title="class in org.apache.cayenne.access.types">JsonType</a></code>, <code><a href="LongType.html" title="class in org.apache.cayenne.access.types">LongType</a></code>, <code><a href="ObjectType.html" title="class in org.apache.cayenne.access.types">ObjectType</a></code>, <code><a href="../../dba/oracle/OracleByteArrayType.html" title="class in org.apache.cayenne.dba.oracle">OracleByteArrayType</a></code>, <code><a href="../../dba/oracle/OracleCharType.html" title="class in org.apache.cayenne.dba.oracle">OracleCharType</a></code>, <code><a href="../../dba/oracle/OracleUtilDateType.html" title="class in org.apache.cayenne.dba.oracle">OracleUtilDateType</a></code>, <code><a href="ShortType.html" title="class in org.apache.cayenne.access.types">ShortType</a></code>, <code><a href="TimestampType.html" title="class in org.apache.cayenne.access.types">TimestampType</a></code>, <code><a href="TimeType.html" title="class in org.apache.cayenne.access.types">TimeType</a></code>, <code><a href="UtilDateType.html" title="class in org.apache.cayenne.access.types">UtilDateType</a></code>, <code><a href="VoidType.html" title="class in org.apache.cayenne.access.types">VoidType</a></code>, <code><a href="WktType.html" title="class in org.apache.cayenne.access.types">WktType</a></code></dd> |
| </dl> |
| <hr> |
| <pre>public interface <span class="typeNameLabel">ExtendedType<T></span></pre> |
| <div class="block">Defines methods to read Java objects from JDBC ResultSets and write as parameters of PreparedStatements.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <table class="memberSummary"> |
| <caption><span>Fields</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Field</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#TRIM_VALUES_THRESHOLD">TRIM_VALUES_THRESHOLD</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">Defines trimming constant for toString method that helps to limit logging of large values.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </section> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Method</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getClassName()">getClassName</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns a full name of Java class that this ExtendedType supports.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="ExtendedType.html" title="type parameter in ExtendedType">T</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#materializeObject(java.sql.CallableStatement,int,int)">materializeObject</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/sql/CallableStatement.html?is-external=true" title="class or interface in java.sql" class="externalLink">CallableStatement</a> rs, |
| int index, |
| int type)</code></th> |
| <td class="colLast"> |
| <div class="block">Reads an object from a stored procedure OUT parameter, converting it to class |
| returned by 'getClassName' method.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="ExtendedType.html" title="type parameter in ExtendedType">T</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#materializeObject(java.sql.ResultSet,int,int)">materializeObject</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/sql/ResultSet.html?is-external=true" title="class or interface in java.sql" class="externalLink">ResultSet</a> rs, |
| int index, |
| int type)</code></th> |
| <td class="colLast"> |
| <div class="block">Reads an object from JDBC ResultSet column, converting it to class returned by |
| 'getClassName' method.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setJdbcObject(java.sql.PreparedStatement,T,int,int,int)">setJdbcObject</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/sql/PreparedStatement.html?is-external=true" title="class or interface in java.sql" class="externalLink">PreparedStatement</a> statement, |
| <a href="ExtendedType.html" title="type parameter in ExtendedType">T</a> value, |
| int pos, |
| int type, |
| int scale)</code></th> |
| <td class="colLast"> |
| <div class="block">Initializes a single parameter of a PreparedStatement with object value.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toString(T)">toString</a></span>​(<a href="ExtendedType.html" title="type parameter in ExtendedType">T</a> value)</code></th> |
| <td class="colLast"> |
| <div class="block">Converts value of the supported type to a human-readable String representation.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="field.detail"> |
| <!-- --> |
| </a> |
| <h3>Field Detail</h3> |
| <a id="TRIM_VALUES_THRESHOLD"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>TRIM_VALUES_THRESHOLD</h4> |
| <pre>static final int TRIM_VALUES_THRESHOLD</pre> |
| <div class="block">Defines trimming constant for toString method that helps to limit logging of large values.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../constant-values.html#org.apache.cayenne.access.types.ExtendedType.TRIM_VALUES_THRESHOLD">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| <!-- ============ METHOD DETAIL ========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a id="getClassName()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getClassName</h4> |
| <pre class="methodSignature"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> getClassName()</pre> |
| <div class="block">Returns a full name of Java class that this ExtendedType supports.</div> |
| </li> |
| </ul> |
| <a id="setJdbcObject(java.sql.PreparedStatement,java.lang.Object,int,int,int)"> |
| <!-- --> |
| </a><a id="setJdbcObject(java.sql.PreparedStatement,T,int,int,int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setJdbcObject</h4> |
| <pre class="methodSignature">void setJdbcObject​(<a href="https://docs.oracle.com/javase/8/docs/api/java/sql/PreparedStatement.html?is-external=true" title="class or interface in java.sql" class="externalLink">PreparedStatement</a> statement, |
| <a href="ExtendedType.html" title="type parameter in ExtendedType">T</a> value, |
| int pos, |
| int type, |
| int scale) |
| throws <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></pre> |
| <div class="block">Initializes a single parameter of a PreparedStatement with object value.</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="materializeObject(java.sql.ResultSet,int,int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>materializeObject</h4> |
| <pre class="methodSignature"><a href="ExtendedType.html" title="type parameter in ExtendedType">T</a> materializeObject​(<a href="https://docs.oracle.com/javase/8/docs/api/java/sql/ResultSet.html?is-external=true" title="class or interface in java.sql" class="externalLink">ResultSet</a> rs, |
| int index, |
| int type) |
| throws <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></pre> |
| <div class="block">Reads an object from JDBC ResultSet column, converting it to class returned by |
| 'getClassName' method.</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></code> - if read error occurred, or an object can't be converted to a |
| target Java class.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="materializeObject(java.sql.CallableStatement,int,int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>materializeObject</h4> |
| <pre class="methodSignature"><a href="ExtendedType.html" title="type parameter in ExtendedType">T</a> materializeObject​(<a href="https://docs.oracle.com/javase/8/docs/api/java/sql/CallableStatement.html?is-external=true" title="class or interface in java.sql" class="externalLink">CallableStatement</a> rs, |
| int index, |
| int type) |
| throws <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></pre> |
| <div class="block">Reads an object from a stored procedure OUT parameter, converting it to class |
| returned by 'getClassName' method.</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></code> - if read error occurred, or an object can't be converted to a |
| target Java class.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="toString(java.lang.Object)"> |
| <!-- --> |
| </a><a id="toString(T)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>toString</h4> |
| <pre class="methodSignature"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> toString​(<a href="ExtendedType.html" title="type parameter in ExtendedType">T</a> value)</pre> |
| <div class="block">Converts value of the supported type to a human-readable String representation.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>value</code> - a value to convert to String.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>4.0</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </main> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <footer role="contentinfo"> |
| <nav role="navigation"> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a id="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/ExtendedType.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../help-doc.html">Help</a></li> |
| </ul> |
| <div class="aboutLanguage"><a href="http://cayenne.apache.org" target="top">Apache Cayenne</a></div> |
| </div> |
| <div class="subNav"> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../allclasses.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <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="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a id="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </nav> |
| <p class="legalCopy"><small>Copyright © 2001–2022 <a href="https://cayenne.apache.org/">Apache Cayenne</a>. All rights reserved.</small></p> |
| </footer> |
| </body> |
| </html> |
