Google Git
Sign in
apache / cayenne-website / 017cf03748c43ba409f0544b0c0a0f42b7e1cddc / . / src / main / site / static / docs / 4.0 / api / org / apache / cayenne / access / types / ValueObjectType.html
blob: 9f1a7d6f5ddd97651b67c6ca13be4b5d7c61d753 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_112) on Mon Oct 14 11:36:12 MSK 2019 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>ValueObjectType (cayenne-doc: Cayenne Documentation 4.0.2 API)</title>
<meta name="date" content="2019-10-14">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="ValueObjectType (cayenne-doc: Cayenne Documentation 4.0.2 API)";
}
}
catch(err) {
}
//-->
var methods = {"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";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/ValueObjectType.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>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/apache/cayenne/access/types/UUIDValueType.html" title="class in org.apache.cayenne.access.types"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/cayenne/access/types/ValueObjectTypeFactory.html" title="class in org.apache.cayenne.access.types"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/cayenne/access/types/ValueObjectType.html" target="_top">Frames</a></li>
<li><a href="ValueObjectType.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.cayenne.access.types</div>
<h2 title="Interface ValueObjectType" class="title">Interface ValueObjectType&lt;V,T&gt;</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt><span class="paramLabel">Type Parameters:</span></dt>
<dd><code>V</code> - type of user's custom object.</dd>
<dd><code>T</code> - type that custom object will be serialized to/from
should be backed by appropriate <a href="../../../../../org/apache/cayenne/access/types/ExtendedType.html" title="interface in org.apache.cayenne.access.types"><code>ExtendedType</code></a>.</dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../../org/apache/cayenne/access/types/BigIntegerValueType.html" title="class in org.apache.cayenne.access.types">BigIntegerValueType</a>, <a href="../../../../../org/apache/cayenne/access/types/CharacterValueType.html" title="class in org.apache.cayenne.access.types">CharacterValueType</a>, <a href="../../../../../org/apache/cayenne/access/types/UUIDValueType.html" title="class in org.apache.cayenne.access.types">UUIDValueType</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">ValueObjectType&lt;V,T&gt;</span></pre>
<div class="block">Descriptor and serialization helper for custom value objects that can be safely stored in the DB.
Lightweight alternative for the <a href="../../../../../org/apache/cayenne/access/types/ExtendedType.html" title="interface in org.apache.cayenne.access.types"><code>ExtendedType</code></a>.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>4.0</dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/cayenne/access/types/ValueObjectType.html" title="type parameter in ValueObjectType">T</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/cayenne/access/types/ValueObjectType.html#fromJavaObject-V-">fromJavaObject</a></span>(<a href="../../../../../org/apache/cayenne/access/types/ValueObjectType.html" title="type parameter in ValueObjectType">V</a>&nbsp;object)</code>&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;<a href="../../../../../org/apache/cayenne/access/types/ValueObjectType.html" title="type parameter in ValueObjectType">T</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/cayenne/access/types/ValueObjectType.html#getTargetType--">getTargetType</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;<a href="../../../../../org/apache/cayenne/access/types/ValueObjectType.html" title="type parameter in ValueObjectType">V</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/cayenne/access/types/ValueObjectType.html#getValueType--">getValueType</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/cayenne/access/types/ValueObjectType.html#toCacheKey-V-">toCacheKey</a></span>(<a href="../../../../../org/apache/cayenne/access/types/ValueObjectType.html" title="type parameter in ValueObjectType">V</a>&nbsp;object)</code>
<div class="block">Returned value should be same for objects that is logically equal.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/cayenne/access/types/ValueObjectType.html" title="type parameter in ValueObjectType">V</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/cayenne/access/types/ValueObjectType.html#toJavaObject-T-">toJavaObject</a></span>(<a href="../../../../../org/apache/cayenne/access/types/ValueObjectType.html" title="type parameter in ValueObjectType">T</a>&nbsp;value)</code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getTargetType--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTargetType</h4>
<pre><a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;<a href="../../../../../org/apache/cayenne/access/types/ValueObjectType.html" title="type parameter in ValueObjectType">T</a>&gt;&nbsp;getTargetType()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>base type used to serialize <b>V</b> objects to.</dd>
</dl>
</li>
</ul>
<a name="getValueType--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getValueType</h4>
<pre><a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;<a href="../../../../../org/apache/cayenne/access/types/ValueObjectType.html" title="type parameter in ValueObjectType">V</a>&gt;&nbsp;getValueType()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>type of Objects described by this ValueObjectType.</dd>
</dl>
</li>
</ul>
<a name="toJavaObject-java.lang.Object-">
<!-- -->
</a><a name="toJavaObject-T-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toJavaObject</h4>
<pre><a href="../../../../../org/apache/cayenne/access/types/ValueObjectType.html" title="type parameter in ValueObjectType">V</a>&nbsp;toJavaObject(<a href="../../../../../org/apache/cayenne/access/types/ValueObjectType.html" title="type parameter in ValueObjectType">T</a>&nbsp;value)</pre>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>value</code> - of type T</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>java object</dd>
</dl>
</li>
</ul>
<a name="fromJavaObject-java.lang.Object-">
<!-- -->
</a><a name="fromJavaObject-V-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>fromJavaObject</h4>
<pre><a href="../../../../../org/apache/cayenne/access/types/ValueObjectType.html" title="type parameter in ValueObjectType">T</a>&nbsp;fromJavaObject(<a href="../../../../../org/apache/cayenne/access/types/ValueObjectType.html" title="type parameter in ValueObjectType">V</a>&nbsp;object)</pre>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>object</code> - java object</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>value of type T</dd>
</dl>
</li>
</ul>
<a name="toCacheKey-java.lang.Object-">
<!-- -->
</a><a name="toCacheKey-V-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>toCacheKey</h4>
<pre><a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;toCacheKey(<a href="../../../../../org/apache/cayenne/access/types/ValueObjectType.html" title="type parameter in ValueObjectType">V</a>&nbsp;object)</pre>
<div class="block">Returned value should be same for objects that is logically equal.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>String representation usable for cache.</dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/ValueObjectType.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>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/apache/cayenne/access/types/UUIDValueType.html" title="class in org.apache.cayenne.access.types"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/cayenne/access/types/ValueObjectTypeFactory.html" title="class in org.apache.cayenne.access.types"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/cayenne/access/types/ValueObjectType.html" target="_top">Frames</a></li>
<li><a href="ValueObjectType.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2001&#x2013;2019 <a href="http://cayenne.apache.org/">Apache Cayenne</a>. All rights reserved.</small></p>
</body>
</html>