| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <link rel="canonical" href="https://ignite.apache.org/jcache/1.0.0/javadoc/javax/cache/configuration/FactoryBuilder.html" /> |
| <!-- Generated by javadoc (version 1.7.0_25) on Fri Mar 28 13:34:25 EST 2014 --> |
| <meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> |
| <title>FactoryBuilder (JSR107 API and SPI 1.0.0 API)</title> |
| <meta name="date" content="2014-03-28"> |
| <link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style"> |
| |
| <script> |
| (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){ |
| (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), |
| m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m) |
| })(window,document,'script','https://www.google-analytics.com/analytics.js','ga'); |
| |
| ga('create', 'UA-61232409-1', 'auto'); |
| ga('send', 'pageview'); |
| |
| </script></head> |
| <body> |
| <script type="text/javascript"><!-- |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="FactoryBuilder (JSR107 API and SPI 1.0.0 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/FactoryBuilder.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="../../../javax/cache/configuration/Factory.html" title="interface in javax.cache.configuration"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../javax/cache/configuration/FactoryBuilder.ClassFactory.html" title="class in javax.cache.configuration"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../index.html?javax/cache/configuration/FactoryBuilder.html" target="_top">Frames</a></li> |
| <li><a href="FactoryBuilder.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><a href="#nested_class_summary">Nested</a> | </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">javax.cache.configuration</div> |
| <h2 title="Class FactoryBuilder" class="title">Class FactoryBuilder</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>javax.cache.configuration.FactoryBuilder</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre>public final class <span class="strong">FactoryBuilder</span> |
| extends <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre> |
| <div class="block">A convenience class that defines generically typed static methods to aid in |
| the building of <a href="../../../javax/cache/configuration/Factory.html" title="interface in javax.cache.configuration"><code>Factory</code></a> instances. |
| <p> |
| <a href="../../../javax/cache/configuration/Factory.html" title="interface in javax.cache.configuration"><code>Factory</code></a> is used by <a href="../../../javax/cache/configuration/MutableConfiguration.html" title="class in javax.cache.configuration"><code>MutableConfiguration</code></a> to avoid adding |
| non-Serializable instances that would assume usage in the local JVM. |
| <p> |
| Two styles of builder are available: |
| <ul> |
| <li>those taking a Class or className. A new instance will be created by |
| the <a href="../../../javax/cache/configuration/Factory.html" title="interface in javax.cache.configuration"><code>Factory</code></a> |
| </li> |
| <li>those taking a Serializable instance. That instance will be created |
| by the <a href="../../../javax/cache/configuration/Factory.html" title="interface in javax.cache.configuration"><code>Factory</code></a>. As the instance is Serializable it no assumption of |
| usage in the local JVM is implied. |
| </li> |
| </ul> |
| |
| Factory instances can also be created in other ways.</div> |
| <dl><dt><span class="strong">Since:</span></dt> |
| <dd>1.0</dd> |
| <dt><span class="strong">Author:</span></dt> |
| <dd>Brian Oliver, Greg Luck</dd></dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="nested_class_summary"> |
| <!-- --> |
| </a> |
| <h3>Nested Class Summary</h3> |
| <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> |
| <caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Class and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <td class="colLast"><code><strong><a href="../../../javax/cache/configuration/FactoryBuilder.ClassFactory.html" title="class in javax.cache.configuration">FactoryBuilder.ClassFactory</a><<a href="../../../javax/cache/configuration/FactoryBuilder.ClassFactory.html" title="type parameter in FactoryBuilder.ClassFactory">T</a>></strong></code> |
| <div class="block">A <a href="../../../javax/cache/configuration/Factory.html" title="interface in javax.cache.configuration"><code>Factory</code></a> that instantiates a specific Class.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <td class="colLast"><code><strong><a href="../../../javax/cache/configuration/FactoryBuilder.SingletonFactory.html" title="class in javax.cache.configuration">FactoryBuilder.SingletonFactory</a><<a href="../../../javax/cache/configuration/FactoryBuilder.SingletonFactory.html" title="type parameter in FactoryBuilder.SingletonFactory">T</a>></strong></code> |
| <div class="block">A <a href="../../../javax/cache/configuration/Factory.html" title="interface in javax.cache.configuration"><code>Factory</code></a> that always returns a specific instance.</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>static <T> <a href="../../../javax/cache/configuration/Factory.html" title="interface in javax.cache.configuration">Factory</a><T></code></td> |
| <td class="colLast"><code><strong><a href="../../../javax/cache/configuration/FactoryBuilder.html#factoryOf(java.lang.Class)">factoryOf</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><T> clazz)</code> |
| <div class="block">Constructs a <a href="../../../javax/cache/configuration/Factory.html" title="interface in javax.cache.configuration"><code>Factory</code></a> that will produce factory instances of the |
| specified class.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <T> <a href="../../../javax/cache/configuration/Factory.html" title="interface in javax.cache.configuration">Factory</a><T></code></td> |
| <td class="colLast"><code><strong><a href="../../../javax/cache/configuration/FactoryBuilder.html#factoryOf(java.lang.String)">factoryOf</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> className)</code> |
| <div class="block">Constructs a <a href="../../../javax/cache/configuration/Factory.html" title="interface in javax.cache.configuration"><code>Factory</code></a> that will produce factory instances of the |
| specified class.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <T extends <a href="http://download.oracle.com/javase/6/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a>> <br><a href="../../../javax/cache/configuration/Factory.html" title="interface in javax.cache.configuration">Factory</a><T></code></td> |
| <td class="colLast"><code><strong><a href="../../../javax/cache/configuration/FactoryBuilder.html#factoryOf(T)">factoryOf</a></strong>(T instance)</code> |
| <div class="block">Constructs a <a href="../../../javax/cache/configuration/Factory.html" title="interface in javax.cache.configuration"><code>Factory</code></a> that will return the specified factory |
| Serializable instance.</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.<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> |
| <code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</a></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="factoryOf(java.lang.Class)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>factoryOf</h4> |
| <pre>public static <T> <a href="../../../javax/cache/configuration/Factory.html" title="interface in javax.cache.configuration">Factory</a><T> factoryOf(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><T> clazz)</pre> |
| <div class="block">Constructs a <a href="../../../javax/cache/configuration/Factory.html" title="interface in javax.cache.configuration"><code>Factory</code></a> that will produce factory instances of the |
| specified class. |
| <p> |
| The specified class must have a no-args constructor.</div> |
| <dl><dt><span class="strong">Type Parameters:</span></dt><dd><code>T</code> - the type of the instances produced by the <a href="../../../javax/cache/configuration/Factory.html" title="interface in javax.cache.configuration"><code>Factory</code></a></dd><dt><span class="strong">Parameters:</span></dt><dd><code>clazz</code> - the class of instances to be produced by the returned |
| <a href="../../../javax/cache/configuration/Factory.html" title="interface in javax.cache.configuration"><code>Factory</code></a></dd> |
| <dt><span class="strong">Returns:</span></dt><dd>a <a href="../../../javax/cache/configuration/Factory.html" title="interface in javax.cache.configuration"><code>Factory</code></a> for the specified clazz</dd></dl> |
| </li> |
| </ul> |
| <a name="factoryOf(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>factoryOf</h4> |
| <pre>public static <T> <a href="../../../javax/cache/configuration/Factory.html" title="interface in javax.cache.configuration">Factory</a><T> factoryOf(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> className)</pre> |
| <div class="block">Constructs a <a href="../../../javax/cache/configuration/Factory.html" title="interface in javax.cache.configuration"><code>Factory</code></a> that will produce factory instances of the |
| specified class. |
| <p> |
| The specified class must have a no-args constructor.</div> |
| <dl><dt><span class="strong">Type Parameters:</span></dt><dd><code>T</code> - the type of the instances produced by the <a href="../../../javax/cache/configuration/Factory.html" title="interface in javax.cache.configuration"><code>Factory</code></a></dd><dt><span class="strong">Parameters:</span></dt><dd><code>className</code> - the class of instances to be produced by the returned |
| <a href="../../../javax/cache/configuration/Factory.html" title="interface in javax.cache.configuration"><code>Factory</code></a></dd> |
| <dt><span class="strong">Returns:</span></dt><dd>a <a href="../../../javax/cache/configuration/Factory.html" title="interface in javax.cache.configuration"><code>Factory</code></a> for the specified clazz</dd></dl> |
| </li> |
| </ul> |
| <a name="factoryOf(java.io.Serializable)"> |
| <!-- --> |
| </a><a name="factoryOf(T)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>factoryOf</h4> |
| <pre>public static <T extends <a href="http://download.oracle.com/javase/6/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a>> <a href="../../../javax/cache/configuration/Factory.html" title="interface in javax.cache.configuration">Factory</a><T> factoryOf(T instance)</pre> |
| <div class="block">Constructs a <a href="../../../javax/cache/configuration/Factory.html" title="interface in javax.cache.configuration"><code>Factory</code></a> that will return the specified factory |
| Serializable instance. |
| <p> |
| If T is not Serializable use <a href="../../../javax/cache/configuration/FactoryBuilder.html#factoryOf(java.lang.Class)"><code>factoryOf(Class)</code></a> or |
| <a href="../../../javax/cache/configuration/FactoryBuilder.html#factoryOf(java.lang.String)"><code>factoryOf(String)</code></a>.</div> |
| <dl><dt><span class="strong">Type Parameters:</span></dt><dd><code>T</code> - the type of the instances returned</dd><dt><span class="strong">Parameters:</span></dt><dd><code>instance</code> - the Serializable instance the <a href="../../../javax/cache/configuration/Factory.html" title="interface in javax.cache.configuration"><code>Factory</code></a> will return</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>a <a href="../../../javax/cache/configuration/Factory.html" title="interface in javax.cache.configuration"><code>Factory</code></a> for the instance</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/FactoryBuilder.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="../../../javax/cache/configuration/Factory.html" title="interface in javax.cache.configuration"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../javax/cache/configuration/FactoryBuilder.ClassFactory.html" title="class in javax.cache.configuration"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../index.html?javax/cache/configuration/FactoryBuilder.html" target="_top">Frames</a></li> |
| <li><a href="FactoryBuilder.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><a href="#nested_class_summary">Nested</a> | </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 © 2014. All Rights Reserved.</small></p> |
| </body> |
| </html> |
