diff options
| author | Jesse Morgan <morganjm@amazon.com> | 2013-12-03 14:03:28 -0800 |
|---|---|---|
| committer | Jesse Morgan <morganjm@amazon.com> | 2013-12-03 14:03:28 -0800 |
| commit | d479253768d296a40b4f699e1de9b03c7146a97a (patch) | |
| tree | 208e70d81fc3e477a37d3f9ca6475c39bb6410d3 /apidocs/com/amazon/carbonado/raw/StorablePropertyInfo.html | |
Adding javadocs and Carbonado User Guidegh-pages
Diffstat (limited to 'apidocs/com/amazon/carbonado/raw/StorablePropertyInfo.html')
| -rw-r--r-- | apidocs/com/amazon/carbonado/raw/StorablePropertyInfo.html | 474 |
1 files changed, 474 insertions, 0 deletions
diff --git a/apidocs/com/amazon/carbonado/raw/StorablePropertyInfo.html b/apidocs/com/amazon/carbonado/raw/StorablePropertyInfo.html new file mode 100644 index 0000000..02749bc --- /dev/null +++ b/apidocs/com/amazon/carbonado/raw/StorablePropertyInfo.html @@ -0,0 +1,474 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc (version 1.7.0_25) on Tue Dec 03 13:53:44 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>StorablePropertyInfo (Carbonado 1.2.3 API)</title> +<meta name="date" content="2013-12-03"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +</head> +<body> +<script type="text/javascript"><!-- + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="StorablePropertyInfo (Carbonado 1.2.3 API)"; + } +//--> +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar_top"> +<!-- --> +</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/StorablePropertyInfo.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="subNav"> +<ul class="navList"> +<li><a href="../../../../com/amazon/carbonado/raw/StorableCodecFactory.html" title="interface in com.amazon.carbonado.raw"><span class="strong">Prev Class</span></a></li> +<li>Next Class</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/raw/StorablePropertyInfo.html" target="_top">Frames</a></li> +<li><a href="StorablePropertyInfo.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">com.amazon.carbonado.raw</div> +<h2 title="Class StorablePropertyInfo" class="title">Class StorablePropertyInfo</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.raw.StorablePropertyInfo</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd><a href="../../../../com/amazon/carbonado/raw/GenericPropertyInfo.html" title="interface in com.amazon.carbonado.raw">GenericPropertyInfo</a></dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">StorablePropertyInfo</span> +extends java.lang.Object +implements <a href="../../../../com/amazon/carbonado/raw/GenericPropertyInfo.html" title="interface in com.amazon.carbonado.raw">GenericPropertyInfo</a></pre> +<dl><dt><span class="strong">Author:</span></dt> + <dd>Brian S O'Neill</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="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span>Methods</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/StorablePropertyInfo.html#addInvokeReadMethod(org.cojen.classfile.CodeAssembler)">addInvokeReadMethod</a></strong>(org.cojen.classfile.CodeAssembler a)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/StorablePropertyInfo.html#addInvokeReadMethod(org.cojen.classfile.CodeAssembler, org.cojen.classfile.TypeDesc)">addInvokeReadMethod</a></strong>(org.cojen.classfile.CodeAssembler a, + org.cojen.classfile.TypeDesc instanceType)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/StorablePropertyInfo.html#addInvokeWriteMethod(org.cojen.classfile.CodeAssembler)">addInvokeWriteMethod</a></strong>(org.cojen.classfile.CodeAssembler a)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/StorablePropertyInfo.html#addInvokeWriteMethod(org.cojen.classfile.CodeAssembler, org.cojen.classfile.TypeDesc)">addInvokeWriteMethod</a></strong>(org.cojen.classfile.CodeAssembler a, + org.cojen.classfile.TypeDesc instanceType)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.reflect.Method</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/StorablePropertyInfo.html#getFromStorageAdapter()">getFromStorageAdapter</a></strong>()</code> +<div class="block">Returns the optional method used to adapt the property from the + storage supported type to the user visible type.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/StorablePropertyInfo.html#getPropertyName()">getPropertyName</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>org.cojen.classfile.TypeDesc</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/StorablePropertyInfo.html#getPropertyType()">getPropertyType</a></strong>()</code> +<div class="block">Returns the user specified property type.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/StorablePropertyInfo.html#getReadMethodName()">getReadMethodName</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>org.cojen.classfile.TypeDesc</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/StorablePropertyInfo.html#getStorageType()">getStorageType</a></strong>()</code> +<div class="block">Returns the storage supported type.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.reflect.Method</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/StorablePropertyInfo.html#getToStorageAdapter()">getToStorageAdapter</a></strong>()</code> +<div class="block">Returns the optional method used to adapt the property from the user + visible type to the storage supported type.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/StorablePropertyInfo.html#getWriteMethodName()">getWriteMethodName</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/StorablePropertyInfo.html#isDerived()">isDerived</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/StorablePropertyInfo.html#isLob()">isLob</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/StorablePropertyInfo.html#isNullable()">isNullable</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/StorablePropertyInfo.html#toString()">toString</a></strong>()</code> </td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.Object</h3> +<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</code></li> +</ul> +</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="getPropertyName()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getPropertyName</h4> +<pre>public java.lang.String getPropertyName()</pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/raw/GenericPropertyInfo.html#getPropertyName()">getPropertyName</a></code> in interface <code><a href="../../../../com/amazon/carbonado/raw/GenericPropertyInfo.html" title="interface in com.amazon.carbonado.raw">GenericPropertyInfo</a></code></dd> +</dl> +</li> +</ul> +<a name="getPropertyType()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getPropertyType</h4> +<pre>public org.cojen.classfile.TypeDesc getPropertyType()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/raw/GenericPropertyInfo.html#getPropertyType()">GenericPropertyInfo</a></code></strong></div> +<div class="block">Returns the user specified property type.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/raw/GenericPropertyInfo.html#getPropertyType()">getPropertyType</a></code> in interface <code><a href="../../../../com/amazon/carbonado/raw/GenericPropertyInfo.html" title="interface in com.amazon.carbonado.raw">GenericPropertyInfo</a></code></dd> +</dl> +</li> +</ul> +<a name="getStorageType()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getStorageType</h4> +<pre>public org.cojen.classfile.TypeDesc getStorageType()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/raw/GenericPropertyInfo.html#getStorageType()">GenericPropertyInfo</a></code></strong></div> +<div class="block">Returns the storage supported type. If it differs from the property + type, then adapter methods must also exist.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/raw/GenericPropertyInfo.html#getStorageType()">getStorageType</a></code> in interface <code><a href="../../../../com/amazon/carbonado/raw/GenericPropertyInfo.html" title="interface in com.amazon.carbonado.raw">GenericPropertyInfo</a></code></dd> +</dl> +</li> +</ul> +<a name="isNullable()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isNullable</h4> +<pre>public boolean isNullable()</pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/raw/GenericPropertyInfo.html#isNullable()">isNullable</a></code> in interface <code><a href="../../../../com/amazon/carbonado/raw/GenericPropertyInfo.html" title="interface in com.amazon.carbonado.raw">GenericPropertyInfo</a></code></dd> +</dl> +</li> +</ul> +<a name="isLob()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isLob</h4> +<pre>public boolean isLob()</pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/raw/GenericPropertyInfo.html#isLob()">isLob</a></code> in interface <code><a href="../../../../com/amazon/carbonado/raw/GenericPropertyInfo.html" title="interface in com.amazon.carbonado.raw">GenericPropertyInfo</a></code></dd> +</dl> +</li> +</ul> +<a name="isDerived()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isDerived</h4> +<pre>public boolean isDerived()</pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/raw/GenericPropertyInfo.html#isDerived()">isDerived</a></code> in interface <code><a href="../../../../com/amazon/carbonado/raw/GenericPropertyInfo.html" title="interface in com.amazon.carbonado.raw">GenericPropertyInfo</a></code></dd> +</dl> +</li> +</ul> +<a name="getFromStorageAdapter()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getFromStorageAdapter</h4> +<pre>public java.lang.reflect.Method getFromStorageAdapter()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/raw/GenericPropertyInfo.html#getFromStorageAdapter()">GenericPropertyInfo</a></code></strong></div> +<div class="block">Returns the optional method used to adapt the property from the + storage supported type to the user visible type.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/raw/GenericPropertyInfo.html#getFromStorageAdapter()">getFromStorageAdapter</a></code> in interface <code><a href="../../../../com/amazon/carbonado/raw/GenericPropertyInfo.html" title="interface in com.amazon.carbonado.raw">GenericPropertyInfo</a></code></dd> +</dl> +</li> +</ul> +<a name="getToStorageAdapter()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getToStorageAdapter</h4> +<pre>public java.lang.reflect.Method getToStorageAdapter()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/raw/GenericPropertyInfo.html#getToStorageAdapter()">GenericPropertyInfo</a></code></strong></div> +<div class="block">Returns the optional method used to adapt the property from the user + visible type to the storage supported type.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/raw/GenericPropertyInfo.html#getToStorageAdapter()">getToStorageAdapter</a></code> in interface <code><a href="../../../../com/amazon/carbonado/raw/GenericPropertyInfo.html" title="interface in com.amazon.carbonado.raw">GenericPropertyInfo</a></code></dd> +</dl> +</li> +</ul> +<a name="getReadMethodName()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getReadMethodName</h4> +<pre>public java.lang.String getReadMethodName()</pre> +</li> +</ul> +<a name="addInvokeReadMethod(org.cojen.classfile.CodeAssembler)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addInvokeReadMethod</h4> +<pre>public void addInvokeReadMethod(org.cojen.classfile.CodeAssembler a)</pre> +</li> +</ul> +<a name="addInvokeReadMethod(org.cojen.classfile.CodeAssembler, org.cojen.classfile.TypeDesc)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addInvokeReadMethod</h4> +<pre>public void addInvokeReadMethod(org.cojen.classfile.CodeAssembler a, + org.cojen.classfile.TypeDesc instanceType)</pre> +</li> +</ul> +<a name="getWriteMethodName()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getWriteMethodName</h4> +<pre>public java.lang.String getWriteMethodName()</pre> +</li> +</ul> +<a name="addInvokeWriteMethod(org.cojen.classfile.CodeAssembler)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addInvokeWriteMethod</h4> +<pre>public void addInvokeWriteMethod(org.cojen.classfile.CodeAssembler a)</pre> +</li> +</ul> +<a name="addInvokeWriteMethod(org.cojen.classfile.CodeAssembler, org.cojen.classfile.TypeDesc)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addInvokeWriteMethod</h4> +<pre>public void addInvokeWriteMethod(org.cojen.classfile.CodeAssembler a, + org.cojen.classfile.TypeDesc instanceType)</pre> +</li> +</ul> +<a name="toString()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>toString</h4> +<pre>public java.lang.String toString()</pre> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code>toString</code> in class <code>java.lang.Object</code></dd> +</dl> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar_bottom"> +<!-- --> +</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/StorablePropertyInfo.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="subNav"> +<ul class="navList"> +<li><a href="../../../../com/amazon/carbonado/raw/StorableCodecFactory.html" title="interface in com.amazon.carbonado.raw"><span class="strong">Prev Class</span></a></li> +<li>Next Class</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/raw/StorablePropertyInfo.html" target="_top">Frames</a></li> +<li><a href="StorablePropertyInfo.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </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 © 2006-2013 <a href="https://github.com/Carbonado/Carbonado">Amazon Technologies, Inc.</a>. All Rights Reserved.</small></p> +</body> +</html> |