Java Doc for FactoryBean.java in  » J2EE » spring-framework-2.0.6 » org » springframework » beans » factory » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » J2EE » spring framework 2.0.6 » org.springframework.beans.factory 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


org.springframework.beans.factory.FactoryBean

All known Subclasses:   org.springframework.transaction.jta.WebSphereTransactionManagerFactoryBean,  org.springframework.remoting.caucho.BurlapProxyFactoryBean,  org.springframework.jmx.support.MBeanServerConnectionFactoryBean,  org.springframework.jmx.access.MBeanProxyFactoryBean,  org.springframework.scheduling.commonj.TimerManagerFactoryBean,  org.springframework.beans.factory.config.MethodInvokingFactoryBean,  org.springframework.orm.jpa.AbstractEntityManagerFactoryBean,  org.springframework.aop.framework.ProxyFactoryBean,  org.springframework.transaction.jta.JotmFactoryBean,  org.springframework.orm.jdo.LocalPersistenceManagerFactoryBean,  org.springframework.scheduling.quartz.SchedulerFactoryBean,  org.springframework.aop.framework.AbstractSingletonProxyFactoryBean,  org.springframework.orm.jpa.support.SharedEntityManagerBean,  org.springframework.jca.support.ResourceAdapterFactoryBean,  org.springframework.jms.remoting.JmsInvokerProxyFactoryBean,  org.springframework.orm.hibernate3.FilterDefinitionFactoryBean,  org.springframework.ejb.access.SimpleRemoteStatelessSessionProxyFactoryBean,  org.springframework.cache.ehcache.EhCacheFactoryBean,  org.springframework.jmx.support.WebSphereMBeanServerFactoryBean,  org.springframework.remoting.rmi.RmiRegistryFactoryBean,  org.springframework.jmx.support.ConnectorServerFactoryBean,  org.springframework.remoting.jaxrpc.LocalJaxRpcServiceFactoryBean,  org.springframework.scheduling.timer.TimerFactoryBean,  org.springframework.aop.config.MethodLocatingFactoryBean,  org.springframework.jca.support.LocalConnectionFactoryBean,  org.springframework.scheduling.backportconcurrent.ScheduledExecutorFactoryBean,  org.springframework.jmx.support.WebLogicJndiMBeanServerFactoryBean,  org.springframework.remoting.rmi.RmiProxyFactoryBean,  org.springframework.orm.hibernate3.AbstractSessionFactoryBean,  org.springframework.scheduling.quartz.MethodInvokingJobDetailFactoryBean,  org.springframework.ui.freemarker.FreeMarkerConfigurationFactoryBean,  org.springframework.remoting.httpinvoker.HttpInvokerProxyFactoryBean,  org.springframework.remoting.jaxrpc.JaxRpcPortProxyFactoryBean,  org.springframework.beans.factory.config.PropertyPathFactoryBean,  org.springframework.transaction.jta.WebLogicServerTransactionManagerFactoryBean,  org.springframework.beans.factory.config.CommonsLogFactoryBean,  org.springframework.beans.factory.config.ResourceFactoryBean,  org.springframework.scheduling.concurrent.ScheduledExecutorFactoryBean,  org.springframework.aop.scope.ScopedProxyFactoryBean,  org.springframework.beans.factory.config.AbstractFactoryBean,  org.springframework.ui.velocity.VelocityEngineFactoryBean,  org.springframework.jndi.JndiObjectFactoryBean,  org.springframework.orm.jdo.TransactionAwarePersistenceManagerFactoryProxy,  org.springframework.orm.toplink.support.TransactionAwareSessionAdapter,  org.springframework.beans.factory.config.FieldRetrievingFactoryBean,  org.springframework.web.context.support.ServletContextParameterFactoryBean,  org.springframework.scheduling.timer.MethodInvokingTimerTaskFactoryBean,  org.springframework.ejb.access.LocalStatelessSessionProxyFactoryBean,  org.springframework.orm.ibatis.SqlMapClientFactoryBean,  org.springframework.web.context.support.ServletContextAttributeFactoryBean,  org.springframework.transaction.interceptor.TransactionProxyFactoryBean,  org.springframework.remoting.rmi.JndiRmiProxyFactoryBean,  org.springframework.remoting.caucho.HessianProxyFactoryBean,  org.springframework.web.context.support.ServletContextFactoryBean,  org.springframework.jmx.support.MBeanServerFactoryBean,  org.springframework.beans.factory.config.PropertiesFactoryBean,  org.springframework.beans.factory.config.ServiceLocatorFactoryBean,  org.springframework.jmx.support.WebLogicMBeanServerFactoryBean,  org.springframework.orm.hibernate.LocalSessionFactoryBean,  org.springframework.cache.ehcache.EhCacheManagerFactoryBean,  org.springframework.orm.toplink.LocalSessionFactoryBean,
FactoryBean
public interface FactoryBean (Code)
Interface to be implemented by objects used within a BeanFactory which are themselves factories. If a bean implements this interface, it is used as a factory for an object to expose, not directly as a bean instance that will be exposed itself.

NB: A bean that implements this interface cannot be used as a normal bean. A FactoryBean is defined in a bean style, but the object exposed for bean references is always the object that it creates.

FactoryBeans can support singletons and prototypes, and can either create objects lazily on demand or eagerly on startup.

This interface is heavily used within the framework itself, for example for the AOP org.springframework.aop.framework.ProxyFactoryBean or the org.springframework.jndi.JndiObjectFactoryBean . It can be used for application components as well; however, this is not common outside of infrastructure code.
author:
   Rod Johnson
author:
   Juergen Hoeller
since:
   08.03.2003
See Also:   org.springframework.beans.factory.BeanFactory
See Also:   org.springframework.aop.framework.ProxyFactoryBean
See Also:   org.springframework.jndi.JndiObjectFactoryBean





Method Summary
 ObjectgetObject()
     Return an instance (possibly shared or independent) of the object managed by this factory.

As with a BeanFactory , this allows support for both the Singleton and Prototype design pattern.

If this FactoryBean is not fully initialized yet at the time of the call (for example because it is involved in a circular reference), throw a corresponding FactoryBeanNotInitializedException .

As of Spring 2.0, FactoryBeans are allowed to return null objects.

 ClassgetObjectType()
     Return the type of object that this FactoryBean creates, or null if not known in advance.

This allows one to check for specific types of beans without instantiating objects, for example on autowiring.

In the case of implementations that are creating a singleton object, this method should try to avoid singleton creation as far as possible; it should rather estimate the type in advance. For prototypes, returning a meaningful type here is advisable too.

This method can be called before this FactoryBean has been fully initialized.

 booleanisSingleton()
     Is the object managed by this factory a singleton? That is, will FactoryBean.getObject() always return the same object (a reference that can be cached)?

NOTE: If a FactoryBean indicates to hold a singleton object, the object returned from getObject() might get cached by the owning BeanFactory.




Method Detail
getObject
Object getObject() throws Exception(Code)
Return an instance (possibly shared or independent) of the object managed by this factory.

As with a BeanFactory , this allows support for both the Singleton and Prototype design pattern.

If this FactoryBean is not fully initialized yet at the time of the call (for example because it is involved in a circular reference), throw a corresponding FactoryBeanNotInitializedException .

As of Spring 2.0, FactoryBeans are allowed to return null objects. The factory will consider this as normal value to be used; it will not throw a FactoryBeanNotInitializedException in this case anymore. FactoryBean implementations are encouraged to throw FactoryBeanNotInitializedException themselves now, as appropriate. an instance of the bean (can be null)
throws:
  Exception - in case of creation errors
See Also:   FactoryBeanNotInitializedException




getObjectType
Class getObjectType()(Code)
Return the type of object that this FactoryBean creates, or null if not known in advance.

This allows one to check for specific types of beans without instantiating objects, for example on autowiring.

In the case of implementations that are creating a singleton object, this method should try to avoid singleton creation as far as possible; it should rather estimate the type in advance. For prototypes, returning a meaningful type here is advisable too.

This method can be called before this FactoryBean has been fully initialized. It must not rely on state created during initialization; of course, it can still use such state if available.

NOTE: Autowiring will simply ignore FactoryBeans that return null here. Therefore it is highly recommended to implement this method properly, using the current state of the FactoryBean. the type of object that this FactoryBean creates,or null if not known at the time of the call
See Also:   ListableBeanFactory.getBeansOfType




isSingleton
boolean isSingleton()(Code)
Is the object managed by this factory a singleton? That is, will FactoryBean.getObject() always return the same object (a reference that can be cached)?

NOTE: If a FactoryBean indicates to hold a singleton object, the object returned from getObject() might get cached by the owning BeanFactory. Hence, do not return true unless the FactoryBean always exposes the same reference.

The singleton status of the FactoryBean itself will generally be provided by the owning BeanFactory; usually, it has to be defined as singleton there.

NOTE: This method returning false does not necessarily indicate that returned objects are independent instances. An implementation of the extended SmartFactoryBean interface may explicitly indicate independent instances through its SmartFactoryBean.isPrototype method. Plain FactoryBean implementations which do not implement this extended interface are simply assumed to always return independent instances if the isSingleton() implementation returns false. if the exposed object is a singleton
See Also:   FactoryBean.getObject()
See Also:   SmartFactoryBean.isPrototype




www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.