diff options
Diffstat (limited to 'apidocs/com/amazon/carbonado/info/StorablePropertyAdapter.html')
| -rw-r--r-- | apidocs/com/amazon/carbonado/info/StorablePropertyAdapter.html | 432 |
1 files changed, 432 insertions, 0 deletions
diff --git a/apidocs/com/amazon/carbonado/info/StorablePropertyAdapter.html b/apidocs/com/amazon/carbonado/info/StorablePropertyAdapter.html new file mode 100644 index 0000000..fb3e3c2 --- /dev/null +++ b/apidocs/com/amazon/carbonado/info/StorablePropertyAdapter.html @@ -0,0 +1,432 @@ +<!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:43 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>StorablePropertyAdapter (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="StorablePropertyAdapter (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/StorablePropertyAdapter.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/info/StorableProperty.html" title="interface in com.amazon.carbonado.info"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/info/StorablePropertyAnnotation.html" title="class in com.amazon.carbonado.info"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/info/StorablePropertyAdapter.html" target="_top">Frames</a></li> +<li><a href="StorablePropertyAdapter.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><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor_detail">Constr</a> | </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.info</div> +<h2 title="Class StorablePropertyAdapter" class="title">Class StorablePropertyAdapter</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.info.StorablePropertyAdapter</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="strong">StorablePropertyAdapter</span> +extends java.lang.Object</pre> +<div class="block">Information about an <a href="../../../../com/amazon/carbonado/adapter/AdapterDefinition.html" title="annotation in com.amazon.carbonado.adapter"><code>adapter</code></a> annotation applied to a property.</div> +<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"> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> +<caption><span>Constructors</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../../com/amazon/carbonado/info/StorablePropertyAdapter.html#StorablePropertyAdapter(java.lang.String, java.lang.Class, java.lang.Class)">StorablePropertyAdapter</a></strong>(java.lang.String propertyName, + java.lang.Class<?> propertyType, + java.lang.Class<? extends java.lang.annotation.Annotation> adapterType)</code> +<div class="block">Construct a generic StorablePropertyAdapter instance not attached to a + storable definition.</div> +</td> +</tr> +</table> +</li> +</ul> +<!-- ========== 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>java.lang.reflect.Method</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorablePropertyAdapter.html#findAdaptMethod(java.lang.Class, java.lang.Class)">findAdaptMethod</a></strong>(java.lang.Class from, + java.lang.Class to)</code> +<div class="block">Returns an adapt method that supports the given conversion, or null if + none.</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/info/StorablePropertyAdapter.html#findAdaptMethodsFrom(java.lang.Class)">findAdaptMethodsFrom</a></strong>(java.lang.Class from)</code> +<div class="block">Returns all the adapt methods that convert from the given type.</div> +</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/info/StorablePropertyAdapter.html#findAdaptMethodsTo(java.lang.Class)">findAdaptMethodsTo</a></strong>(java.lang.Class to)</code> +<div class="block">Returns all the adapt methods that convert to the given type.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.reflect.Constructor</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorablePropertyAdapter.html#getAdapterConstructor()">getAdapterConstructor</a></strong>()</code> +<div class="block">Returns the constructor for the adapter class.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorablePropertyAdapter.html#getAdapterInstance()">getAdapterInstance</a></strong>()</code> +<div class="block">Returns an instance of the adapter, for which an adapt method is applied to.</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/info/StorablePropertyAdapter.html#getAdaptMethod(int)">getAdaptMethod</a></strong>(int index)</code> +<div class="block">Returns a specific adapt method.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorablePropertyAdapter.html#getAdaptMethodCount()">getAdaptMethodCount</a></strong>()</code> +<div class="block">Returns the count of all defined adapt methods.</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/info/StorablePropertyAdapter.html#getAdaptMethods()">getAdaptMethods</a></strong>()</code> +<div class="block">Returns a new array with all the adapt methods in it.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/info/StorablePropertyAnnotation.html" title="class in com.amazon.carbonado.info">StorablePropertyAnnotation</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorablePropertyAdapter.html#getAnnotation()">getAnnotation</a></strong>()</code> +<div class="block">Returns the annotation that applied this adapter, or null if none.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.Class[]</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorablePropertyAdapter.html#getStorageTypePreferences()">getStorageTypePreferences</a></strong>()</code> +<div class="block">Returns the adapter's storage type preferences.</div> +</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, toString, wait, wait, wait</code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="StorablePropertyAdapter(java.lang.String, java.lang.Class, java.lang.Class)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>StorablePropertyAdapter</h4> +<pre>public StorablePropertyAdapter(java.lang.String propertyName, + java.lang.Class<?> propertyType, + java.lang.Class<? extends java.lang.annotation.Annotation> adapterType)</pre> +<div class="block">Construct a generic StorablePropertyAdapter instance not attached to a + storable definition. Call <a href="../../../../com/amazon/carbonado/info/StorableProperty.html#getAdapter()"><code>StorableProperty.getAdapter()</code></a> to gain + access to adapter information on actual storable definitions.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>propertyName</code> - name of property with adapter</dd><dd><code>propertyType</code> - declated type of adapted property</dd><dd><code>adapterType</code> - adapter type</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if adapterType is not an adapter + definition.</dd></dl> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="getAnnotation()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getAnnotation</h4> +<pre>public <a href="../../../../com/amazon/carbonado/info/StorablePropertyAnnotation.html" title="class in com.amazon.carbonado.info">StorablePropertyAnnotation</a> getAnnotation()</pre> +<div class="block">Returns the annotation that applied this adapter, or null if none.</div> +</li> +</ul> +<a name="getAdapterConstructor()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getAdapterConstructor</h4> +<pre>public java.lang.reflect.Constructor getAdapterConstructor()</pre> +<div class="block">Returns the constructor for the adapter class. It has the signature + <code>(Class type, String propertyName, <i>Annotation</i>)</code>, where + <i>Annotation</i> is the fully resolved annotation.</div> +</li> +</ul> +<a name="getAdapterInstance()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getAdapterInstance</h4> +<pre>public java.lang.Object getAdapterInstance()</pre> +<div class="block">Returns an instance of the adapter, for which an adapt method is applied to.</div> +</li> +</ul> +<a name="getStorageTypePreferences()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getStorageTypePreferences</h4> +<pre>public java.lang.Class[] getStorageTypePreferences()</pre> +<div class="block">Returns the adapter's storage type preferences.</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../com/amazon/carbonado/adapter/AdapterDefinition.html#storageTypePreferences()"><code>AdapterDefinition.storageTypePreferences()</code></a></dd></dl> +</li> +</ul> +<a name="findAdaptMethod(java.lang.Class, java.lang.Class)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>findAdaptMethod</h4> +<pre>public java.lang.reflect.Method findAdaptMethod(java.lang.Class from, + java.lang.Class to)</pre> +<div class="block">Returns an adapt method that supports the given conversion, or null if + none.</div> +</li> +</ul> +<a name="findAdaptMethodsFrom(java.lang.Class)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>findAdaptMethodsFrom</h4> +<pre>public java.lang.reflect.Method[] findAdaptMethodsFrom(java.lang.Class from)</pre> +<div class="block">Returns all the adapt methods that convert from the given type.</div> +</li> +</ul> +<a name="findAdaptMethodsTo(java.lang.Class)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>findAdaptMethodsTo</h4> +<pre>public java.lang.reflect.Method[] findAdaptMethodsTo(java.lang.Class to)</pre> +<div class="block">Returns all the adapt methods that convert to the given type.</div> +</li> +</ul> +<a name="getAdaptMethodCount()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getAdaptMethodCount</h4> +<pre>public int getAdaptMethodCount()</pre> +<div class="block">Returns the count of all defined adapt methods.</div> +</li> +</ul> +<a name="getAdaptMethod(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getAdaptMethod</h4> +<pre>public java.lang.reflect.Method getAdaptMethod(int index) + throws java.lang.IndexOutOfBoundsException</pre> +<div class="block">Returns a specific adapt method.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IndexOutOfBoundsException</code></dd></dl> +</li> +</ul> +<a name="getAdaptMethods()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getAdaptMethods</h4> +<pre>public java.lang.reflect.Method[] getAdaptMethods()</pre> +<div class="block">Returns a new array with all the adapt methods in it.</div> +</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/StorablePropertyAdapter.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/info/StorableProperty.html" title="interface in com.amazon.carbonado.info"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/info/StorablePropertyAnnotation.html" title="class in com.amazon.carbonado.info"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/info/StorablePropertyAdapter.html" target="_top">Frames</a></li> +<li><a href="StorablePropertyAdapter.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><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor_detail">Constr</a> | </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> |