<!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:42 PST 2013 --> <meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> <title>Converter (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="Converter (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/Converter.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/util/ConversionComparator.html" title="class in com.amazon.carbonado.util"><span class="strong">Prev Class</span></a></li> <li><a href="../../../../com/amazon/carbonado/util/QuickConstructorGenerator.html" title="class in com.amazon.carbonado.util"><span class="strong">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../index.html?com/amazon/carbonado/util/Converter.html" target="_top">Frames</a></li> <li><a href="Converter.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.util</div> <h2 title="Class Converter" class="title">Class Converter</h2> </div> <div class="contentContainer"> <ul class="inheritance"> <li>java.lang.Object</li> <li> <ul class="inheritance"> <li>com.amazon.carbonado.util.Converter</li> </ul> </li> </ul> <div class="description"> <ul class="blockList"> <li class="blockList"> <hr> <br> <pre>public abstract class <span class="strong">Converter</span> extends java.lang.Object</pre> <div class="block">General purpose type converter. Custom conversions are possible by supplying an abstract subclass which has public conversion methods whose names begin with "convert". Each conversion method takes a single argument and returns a value.</div> <dl><dt><span class="strong">Since:</span></dt> <dd>1.2</dd> <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/util/Converter.html#Converter()">Converter</a></strong>()</code> </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>static <C extends <a href="../../../../com/amazon/carbonado/util/Converter.html" title="class in com.amazon.carbonado.util">Converter</a>> <br>C</code></td> <td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/Converter.html#build(java.lang.Class)">build</a></strong>(java.lang.Class<C> converterType)</code> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>static <C extends <a href="../../../../com/amazon/carbonado/util/Converter.html" title="class in com.amazon.carbonado.util">Converter</a>> <br>java.lang.Class<? extends C></code></td> <td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/Converter.html#buildClass(java.lang.Class)">buildClass</a></strong>(java.lang.Class<C> converterType)</code> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>protected java.lang.IllegalArgumentException</code></td> <td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/Converter.html#conversionNotSupported(java.lang.Object, java.lang.Class, java.lang.Class)">conversionNotSupported</a></strong>(java.lang.Object fromValue, java.lang.Class fromType, java.lang.Class toType)</code> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>abstract <T> T</code></td> <td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/Converter.html#convert(boolean, java.lang.Class)">convert</a></strong>(boolean from, java.lang.Class<T> toType)</code> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>abstract <T> T</code></td> <td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/Converter.html#convert(byte, java.lang.Class)">convert</a></strong>(byte from, java.lang.Class<T> toType)</code> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>abstract <T> T</code></td> <td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/Converter.html#convert(char, java.lang.Class)">convert</a></strong>(char from, java.lang.Class<T> toType)</code> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>abstract <T> T</code></td> <td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/Converter.html#convert(double, java.lang.Class)">convert</a></strong>(double from, java.lang.Class<T> toType)</code> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>abstract <T> T</code></td> <td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/Converter.html#convert(float, java.lang.Class)">convert</a></strong>(float from, java.lang.Class<T> toType)</code> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>abstract <T> T</code></td> <td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/Converter.html#convert(int, java.lang.Class)">convert</a></strong>(int from, java.lang.Class<T> toType)</code> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>abstract <T> T</code></td> <td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/Converter.html#convert(long, java.lang.Class)">convert</a></strong>(long from, java.lang.Class<T> toType)</code> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>abstract <T> T</code></td> <td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/Converter.html#convert(java.lang.Object, java.lang.Class)">convert</a></strong>(java.lang.Object from, java.lang.Class<T> toType)</code> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>abstract <T> T</code></td> <td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/Converter.html#convert(short, java.lang.Class)">convert</a></strong>(short from, java.lang.Class<T> toType)</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, 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="Converter()"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>Converter</h4> <pre>public Converter()</pre> </li> </ul> </li> </ul> <!-- ============ METHOD DETAIL ========== --> <ul class="blockList"> <li class="blockList"><a name="method_detail"> <!-- --> </a> <h3>Method Detail</h3> <a name="build(java.lang.Class)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>build</h4> <pre>public static <C extends <a href="../../../../com/amazon/carbonado/util/Converter.html" title="class in com.amazon.carbonado.util">Converter</a>> C build(java.lang.Class<C> converterType)</pre> <dl><dt><span class="strong">Parameters:</span></dt><dd><code>converterType</code> - type of converter to generate</dd> <dt><span class="strong">Throws:</span></dt> <dd><code>java.lang.IllegalArgumentException</code> - if converter doesn't a no-arg constructor</dd></dl> </li> </ul> <a name="buildClass(java.lang.Class)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>buildClass</h4> <pre>public static <C extends <a href="../../../../com/amazon/carbonado/util/Converter.html" title="class in com.amazon.carbonado.util">Converter</a>> java.lang.Class<? extends C> buildClass(java.lang.Class<C> converterType)</pre> <dl><dt><span class="strong">Parameters:</span></dt><dd><code>converterType</code> - type of converter to generate</dd></dl> </li> </ul> <a name="convert(java.lang.Object, java.lang.Class)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>convert</h4> <pre>public abstract <T> T convert(java.lang.Object from, java.lang.Class<T> toType)</pre> <dl><dt><span class="strong">Throws:</span></dt> <dd><code>java.lang.IllegalArgumentException</code> - if conversion is not supported</dd></dl> </li> </ul> <a name="convert(byte, java.lang.Class)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>convert</h4> <pre>public abstract <T> T convert(byte from, java.lang.Class<T> toType)</pre> <dl><dt><span class="strong">Throws:</span></dt> <dd><code>java.lang.IllegalArgumentException</code> - if conversion is not supported</dd></dl> </li> </ul> <a name="convert(short, java.lang.Class)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>convert</h4> <pre>public abstract <T> T convert(short from, java.lang.Class<T> toType)</pre> <dl><dt><span class="strong">Throws:</span></dt> <dd><code>java.lang.IllegalArgumentException</code> - if conversion is not supported</dd></dl> </li> </ul> <a name="convert(int, java.lang.Class)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>convert</h4> <pre>public abstract <T> T convert(int from, java.lang.Class<T> toType)</pre> <dl><dt><span class="strong">Throws:</span></dt> <dd><code>java.lang.IllegalArgumentException</code> - if conversion is not supported</dd></dl> </li> </ul> <a name="convert(long, java.lang.Class)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>convert</h4> <pre>public abstract <T> T convert(long from, java.lang.Class<T> toType)</pre> <dl><dt><span class="strong">Throws:</span></dt> <dd><code>java.lang.IllegalArgumentException</code> - if conversion is not supported</dd></dl> </li> </ul> <a name="convert(float, java.lang.Class)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>convert</h4> <pre>public abstract <T> T convert(float from, java.lang.Class<T> toType)</pre> <dl><dt><span class="strong">Throws:</span></dt> <dd><code>java.lang.IllegalArgumentException</code> - if conversion is not supported</dd></dl> </li> </ul> <a name="convert(double, java.lang.Class)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>convert</h4> <pre>public abstract <T> T convert(double from, java.lang.Class<T> toType)</pre> <dl><dt><span class="strong">Throws:</span></dt> <dd><code>java.lang.IllegalArgumentException</code> - if conversion is not supported</dd></dl> </li> </ul> <a name="convert(boolean, java.lang.Class)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>convert</h4> <pre>public abstract <T> T convert(boolean from, java.lang.Class<T> toType)</pre> <dl><dt><span class="strong">Throws:</span></dt> <dd><code>java.lang.IllegalArgumentException</code> - if conversion is not supported</dd></dl> </li> </ul> <a name="convert(char, java.lang.Class)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>convert</h4> <pre>public abstract <T> T convert(char from, java.lang.Class<T> toType)</pre> <dl><dt><span class="strong">Throws:</span></dt> <dd><code>java.lang.IllegalArgumentException</code> - if conversion is not supported</dd></dl> </li> </ul> <a name="conversionNotSupported(java.lang.Object, java.lang.Class, java.lang.Class)"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>conversionNotSupported</h4> <pre>protected java.lang.IllegalArgumentException conversionNotSupported(java.lang.Object fromValue, java.lang.Class fromType, java.lang.Class toType)</pre> </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/Converter.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/util/ConversionComparator.html" title="class in com.amazon.carbonado.util"><span class="strong">Prev Class</span></a></li> <li><a href="../../../../com/amazon/carbonado/util/QuickConstructorGenerator.html" title="class in com.amazon.carbonado.util"><span class="strong">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../index.html?com/amazon/carbonado/util/Converter.html" target="_top">Frames</a></li> <li><a href="Converter.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>