# ignite-sprint-7: IgniteReflectionFactory javadoc
Project: http://git-wip-us.apache.org/repos/asf/incubator-ignite/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-ignite/commit/359b4314 Tree: http://git-wip-us.apache.org/repos/asf/incubator-ignite/tree/359b4314 Diff: http://git-wip-us.apache.org/repos/asf/incubator-ignite/diff/359b4314 Branch: refs/heads/ignite-621 Commit: 359b43144046bc683f9e28794eb7e7bc9c63ebc1 Parents: dfe95bd Author: ashutak <ashu...@gridgain.com> Authored: Tue Jun 23 16:59:44 2015 +0300 Committer: ashutak <ashu...@gridgain.com> Committed: Tue Jun 23 16:59:44 2015 +0300 ---------------------------------------------------------------------- .../configuration/IgniteReflectionFactory.java | 81 ++++++++++++++++++-- 1 file changed, 76 insertions(+), 5 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-ignite/blob/359b4314/modules/core/src/main/java/org/apache/ignite/configuration/IgniteReflectionFactory.java ---------------------------------------------------------------------- diff --git a/modules/core/src/main/java/org/apache/ignite/configuration/IgniteReflectionFactory.java b/modules/core/src/main/java/org/apache/ignite/configuration/IgniteReflectionFactory.java index 3222938..af73737 100644 --- a/modules/core/src/main/java/org/apache/ignite/configuration/IgniteReflectionFactory.java +++ b/modules/core/src/main/java/org/apache/ignite/configuration/IgniteReflectionFactory.java @@ -26,26 +26,91 @@ import java.lang.reflect.*; import java.util.*; /** - * Convenience class for reflection-based object creation. + * Factory implementation that use reflection to create instance of given class. + * <p> + * There are 2 modes of factory: singleton and non-sigletton. + * <p> + * Class that should be created by {@link IgniteReflectionFactory} (component class) have to be + * public java POJO with public setters for field + * for which property injection will be used (see {@link #setProperties(Map)}). + * <p> + * <h1 class="header">Configuration</h1> + * <h2 class="header">Mandatory</h2> + * The following configuration parameters are mandatory: + * <ul> + * <li>Component class - class to be created (see {@link #setComponentClass(Class)}. + * It have to be public java POJO class with default constructor + * and public setters to be used by properties injection (see {@link #setProperties(Map)})</li> + * </ul> + * <h2 class="header">Optional</h2> + * The following configuration parameters are optional: + * <ul> + * </li> + * <li>Singleton mode (see {@link #setSingleton(boolean)})</li> + * <li>Properties map (see {@link #setProperties(Map)}</li> + * <li>With method (see {@link #setWithMethod(Object, String, Serializable)}</li> + * </ul> + * <h2 class="header">Java Example</h2> + * <pre name="code" class="java"> + * Factory<CacheStoreSessionListener> factory = + * new IgniteReflectionFactory<CacheStoreSessionListener>(MyCacheStoreSessionListener.class); + * + * CacheConfiguration cc = new CacheConfiguration() + * .setCacheStoreSessionListenerFactories(factory); + * + * IgniteConfiguration cfg = new IgniteConfiguration() + * .setCacheConfiguration(cc); + * + * // Start grid. + * Ignition.start(cfg); + * </pre> + * <h2 class="header">Spring Example</h2> + * TcpDiscoverySpi can be configured from Spring XML configuration file: + * <pre name="code" class="xml"> + * <bean id="grid.custom.cfg" class="org.apache.ignite.configuration.IgniteConfiguration"> + * ... + * <property name="cacheConfiguration"> + * <list> + * <bean class="org.apache.ignite.configuration.CacheConfiguration"> + * ... + * <property name="cacheStoreSessionListenerFactories"> + * <list> + * <bean class="org.apache.ignite.configuration.IgniteReflectionFactory"> + * <property name="componentClass" value="custom.project.MyCacheStoreSessionListener"/> + * </bean> + * </list> + * </property> + * ... + * </bean> + * </list> + * </property> + * ... + * </bean> + * </pre> + * <p> + * <img src="http://ignite.incubator.apache.org/images/spring-small.png";> + * <br> + * For information about Spring framework visit <a href="http://www.springframework.org/";>www.springframework.org</a> + * @see Factory */ public class IgniteReflectionFactory<T> implements Factory<T> { /** */ private static final long serialVersionUID = 0L; - /** */ + /** Singletom mode */ private volatile boolean singleton; - /** */ + /** Component class */ private volatile Class<? extends T> cls; - /** */ + /** Properties */ private volatile Map<String, Serializable> props; /** */ private transient T instance; /** - * + * Default constructor. */ public IgniteReflectionFactory() { // No-op. @@ -98,6 +163,9 @@ public class IgniteReflectionFactory<T> implements Factory<T> { } /** + * Gets a map of properties. Map contains entries of component class field name + * to value of the filed which will be used as initial value. + * * @return Properties. */ public Map<String, Serializable> getProperties() { @@ -105,6 +173,9 @@ public class IgniteReflectionFactory<T> implements Factory<T> { } /** + * Sets a map of properties. Map contains entries of component class field name + * to a value of the filed which will be used as initial value. + * * @param props Properties. */ public void setProperties(Map<String, Serializable> props) {
![http://ignite.incubator.apache.org/images/spring-small.png"](http://ignite.incubator.apache.org/images/spring-small.png"){kind=link}