blob: a74d0641b72b92d582f2c3ddef1ed9bf684bac62 [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (11.0.10) on Mon Dec 05 10:27:04 MSK 2022 -->
<title>org.apache.cayenne.access.types (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="org.apache.cayenne.access.types (cayenne-doc: Cayenne Documentation 4.2.RC2 API)";
}
}
catch(err) {
}
//-->
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 class="navBarCell1Rev">Package</li>
<li>Class</li>
<li><a href="package-use.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
<div 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&nbsp;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>
<a id="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>
<main role="main">
<div class="header">
<h1 title="Package" class="title">Package&nbsp;org.apache.cayenne.access.types</h1>
</div>
<div class="contentContainer">
<section role="region"><a id="package.description">
<!-- -->
</a>
<div class="block">Defines an extendable mechanism to map Java types to JDBC types.</div>
</section>
<ul class="blockList">
<li class="blockList">
<table class="typeSummary">
<caption><span>Interface Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Interface</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="ExtendedType.html" title="interface in org.apache.cayenne.access.types">ExtendedType</a>&lt;T&gt;</th>
<td class="colLast">
<div class="block">Defines methods to read Java objects from JDBC ResultSets and write as parameters of PreparedStatements.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="ExtendedTypeFactory.html" title="interface in org.apache.cayenne.access.types">ExtendedTypeFactory</a></th>
<td class="colLast">
<div class="block">ExtendedType factory interface.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="InternalUnsupportedTypeFactory.Marker.html" title="interface in org.apache.cayenne.access.types">InternalUnsupportedTypeFactory.Marker</a></th>
<td class="colLast">
<div class="block">Marker interface, that should be used by any internal value types, that could potentially get to the SQL</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="ValueObjectType.html" title="interface in org.apache.cayenne.access.types">ValueObjectType</a>&lt;V,&#8203;T&gt;</th>
<td class="colLast">
<div class="block">Descriptor and serialization helper for custom value objects that can be safely stored in the DB.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="ValueObjectTypeRegistry.html" title="interface in org.apache.cayenne.access.types">ValueObjectTypeRegistry</a></th>
<td class="colLast">
<div class="block">Registry of user-defined descriptors of custom value objects' classes.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary">
<caption><span>Class Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="BigDecimalType.html" title="class in org.apache.cayenne.access.types">BigDecimalType</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="BigDecimalValueType.html" title="class in org.apache.cayenne.access.types">BigDecimalValueType</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="BigIntegerValueType.html" title="class in org.apache.cayenne.access.types">BigIntegerValueType</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="BooleanType.html" title="class in org.apache.cayenne.access.types">BooleanType</a></th>
<td class="colLast">
<div class="block">Handles <code>java.lang.Boolean</code> mapping.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="ByteArrayType.html" title="class in org.apache.cayenne.access.types">ByteArrayType</a></th>
<td class="colLast">
<div class="block">Handles <code>byte[]</code>, mapping it as either of JDBC types - BLOB or
(VAR)BINARY.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="ByteType.html" title="class in org.apache.cayenne.access.types">ByteType</a></th>
<td class="colLast">
<div class="block">Handles <code>java.lang.Byte</code> type mapping.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="CalendarType.html" title="class in org.apache.cayenne.access.types">CalendarType</a>&lt;T extends <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Calendar.html?is-external=true" title="class or interface in java.util" class="externalLink">Calendar</a>&gt;</th>
<td class="colLast">
<div class="block">ExtendedType that handles <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Calendar.html?is-external=true" title="class or interface in java.util" class="externalLink"><code>Calendar</code></a> fields.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="CharacterValueType.html" title="class in org.apache.cayenne.access.types">CharacterValueType</a></th>
<td class="colLast">
<div class="block">This is char and Character type mapped to zero or one char String.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="CharType.html" title="class in org.apache.cayenne.access.types">CharType</a></th>
<td class="colLast">
<div class="block">Handles <code>java.lang.String</code>, mapping it as either of JDBC types -
CLOB or (VAR)CHAR.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="DateType.html" title="class in org.apache.cayenne.access.types">DateType</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="DefaultValueObjectTypeRegistry.html" title="class in org.apache.cayenne.access.types">DefaultValueObjectTypeRegistry</a></th>
<td class="colLast">
<div class="block">Default implementation of <a href="ValueObjectTypeRegistry.html" title="interface in org.apache.cayenne.access.types"><code>ValueObjectTypeRegistry</code></a></div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="DoubleType.html" title="class in org.apache.cayenne.access.types">DoubleType</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="DurationType.html" title="class in org.apache.cayenne.access.types">DurationType</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="EnumType.html" title="class in org.apache.cayenne.access.types">EnumType</a>&lt;T extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true" title="class or interface in java.lang" class="externalLink">Enum</a>&lt;T&gt;&gt;</th>
<td class="colLast">
<div class="block">An ExtendedType that handles an enum class.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="EnumTypeFactory.html" title="class in org.apache.cayenne.access.types">EnumTypeFactory</a></th>
<td class="colLast">
<div class="block">ExtendedTypeFactory for handling Enum types.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="ExtendedEnumType.html" title="class in org.apache.cayenne.access.types">ExtendedEnumType</a>&lt;T extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true" title="class or interface in java.lang" class="externalLink">Enum</a>&lt;T&gt;&gt;</th>
<td class="colLast">
<div class="block">An ExtendedType that handles a Java Enum based upon the Cayenne ExtendedEnumeration
interface.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="ExtendedTypeMap.html" title="class in org.apache.cayenne.access.types">ExtendedTypeMap</a></th>
<td class="colLast">
<div class="block">Stores ExtendedTypes, implementing an algorithm to determine the right type
for a given Java class.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="FloatType.html" title="class in org.apache.cayenne.access.types">FloatType</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="GeoJsonType.html" title="class in org.apache.cayenne.access.types">GeoJsonType</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="IntegerType.html" title="class in org.apache.cayenne.access.types">IntegerType</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="InternalUnsupportedTypeFactory.html" title="class in org.apache.cayenne.access.types">InternalUnsupportedTypeFactory</a></th>
<td class="colLast">
<div class="block">Extended type factory that produces types for Cayenne internal value types that could potentially make it to the DB.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="JsonType.html" title="class in org.apache.cayenne.access.types">JsonType</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="LocalDateTimeValueType.html" title="class in org.apache.cayenne.access.types">LocalDateTimeValueType</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="LocalDateValueType.html" title="class in org.apache.cayenne.access.types">LocalDateValueType</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="LocalTimeValueType.html" title="class in org.apache.cayenne.access.types">LocalTimeValueType</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="LongType.html" title="class in org.apache.cayenne.access.types">LongType</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="ObjectType.html" title="class in org.apache.cayenne.access.types">ObjectType</a></th>
<td class="colLast">
<div class="block">This is a default ExtendedType that relies on JDBC driver to determine the result type.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="PeriodValueType.html" title="class in org.apache.cayenne.access.types">PeriodValueType</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="ShortType.html" title="class in org.apache.cayenne.access.types">ShortType</a></th>
<td class="colLast">
<div class="block">Handles <code>java.lang.Short</code> type mapping.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="TimestampType.html" title="class in org.apache.cayenne.access.types">TimestampType</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="TimeType.html" title="class in org.apache.cayenne.access.types">TimeType</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="UtilDateType.html" title="class in org.apache.cayenne.access.types">UtilDateType</a></th>
<td class="colLast">
<div class="block">Maps <code>java.util.Date</code> to any of the three database date/time types: TIME,
DATE, TIMESTAMP.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="UUIDValueType.html" title="class in org.apache.cayenne.access.types">UUIDValueType</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="ValueObjectTypeFactory.html" title="class in org.apache.cayenne.access.types">ValueObjectTypeFactory</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="VoidType.html" title="class in org.apache.cayenne.access.types">VoidType</a></th>
<td class="colLast">
<div class="block">A noop type that is sometimes useful to suppress extended types operations.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="WktType.html" title="class in org.apache.cayenne.access.types">WktType</a></th>
<td class="colLast">&nbsp;</td>
</tr>
</tbody>
</table>
</li>
</ul>
</div>
</main>
<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 class="navBarCell1Rev">Package</li>
<li>Class</li>
<li><a href="package-use.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
<div 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&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<a id="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
<p class="legalCopy"><small>Copyright &#169; 2001&#x2013;2022 <a href="https://cayenne.apache.org/">Apache Cayenne</a>. All rights reserved.</small></p>
</footer>
</body>
</html>