Spring Framework

org.springframework.aop.config
Class MethodLocatingFactoryBean

java.lang.Object
  extended by org.springframework.aop.config.MethodLocatingFactoryBean
All Implemented Interfaces:
Aware, BeanFactoryAware, FactoryBean<java.lang.reflect.Method>

public class MethodLocatingFactoryBean
extends java.lang.Object
implements FactoryBean<java.lang.reflect.Method>, BeanFactoryAware

FactoryBean implementation that locates a Method on a specified bean.

Since:
2.0
Author:
Rob Harrop

Constructor Summary
MethodLocatingFactoryBean()
           
 
Method Summary
 java.lang.reflect.Method getObject()
          Return an instance (possibly shared or independent) of the object managed by this factory.
 java.lang.Class<java.lang.reflect.Method> getObjectType()
          Return the type of object that this FactoryBean creates, or null if not known in advance.
 boolean isSingleton()
          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)?
 void setBeanFactory(BeanFactory beanFactory)
          Callback that supplies the owning factory to a bean instance.
 void setMethodName(java.lang.String methodName)
          Set the name of the Method to locate.
 void setTargetBeanName(java.lang.String targetBeanName)
          Set the name of the bean to locate the Method on.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

MethodLocatingFactoryBean

public MethodLocatingFactoryBean()
Method Detail

setTargetBeanName

public void setTargetBeanName(java.lang.String targetBeanName)
Set the name of the bean to locate the Method on.

This property is required.

Parameters:
targetBeanName - the name of the bean to locate the Method on

setMethodName

public void setMethodName(java.lang.String methodName)
Set the name of the Method to locate.

This property is required.

Parameters:
methodName - the name of the Method to locate

setBeanFactory

public void setBeanFactory(BeanFactory beanFactory)
Description copied from interface: BeanFactoryAware
Callback that supplies the owning factory to a bean instance.

Invoked after the population of normal bean properties but before an initialization callback such as InitializingBean.afterPropertiesSet() or a custom init-method.

Specified by:
setBeanFactory in interface BeanFactoryAware
Parameters:
beanFactory - owning BeanFactory (never null). The bean can immediately call methods on the factory.
See Also:
BeanInitializationException

getObject

public java.lang.reflect.Method getObject()
                                   throws java.lang.Exception
Description copied from interface: FactoryBean
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.

Specified by:
getObject in interface FactoryBean<java.lang.reflect.Method>
Returns:
an instance of the bean (can be null)
Throws:
java.lang.Exception - in case of creation errors
See Also:
FactoryBeanNotInitializedException

getObjectType

public java.lang.Class<java.lang.reflect.Method> getObjectType()
Description copied from interface: FactoryBean
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.

Specified by:
getObjectType in interface FactoryBean<java.lang.reflect.Method>
Returns:
the type of object that this FactoryBean creates, or null if not known at the time of the call
See Also:
ListableBeanFactory.getBeansOfType(java.lang.Class)

isSingleton

public boolean isSingleton()
Description copied from interface: FactoryBean
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.

Specified by:
isSingleton in interface FactoryBean<java.lang.reflect.Method>
Returns:
whether the exposed object is a singleton
See Also:
FactoryBean.getObject(), SmartFactoryBean.isPrototype()

Spring Framework