public class

FieldRetrievingFactoryBean

extends Object
implements BeanClassLoaderAware BeanNameAware FactoryBean<T> InitializingBean
java.lang.Object
   ↳ org.springframework.beans.factory.config.FieldRetrievingFactoryBean

Class Overview

FactoryBean which retrieves a static or non-static field value.

Typically used for retrieving public static final constants. Usage example: 

// standard definition for exposing a static field, specifying the "staticField" property
 <bean id="myField" class="org.springframework.beans.factory.config.FieldRetrievingFactoryBean">
   <property name="staticField" value="java.sql.Connection.TRANSACTION_SERIALIZABLE"/>
 </bean>

 // convenience version that specifies a static field pattern as bean name
 <bean id="java.sql.Connection.TRANSACTION_SERIALIZABLE"
       class="org.springframework.beans.factory.config.FieldRetrievingFactoryBean"/>

If you are using Spring 2.0, you can also use the following style of configuration for public static fields. 

<util:constant static-field="java.sql.Connection.TRANSACTION_SERIALIZABLE"/>

See Also

Summary

Public Constructors
FieldRetrievingFactoryBean()
Public Methods
void afterPropertiesSet()
Invoked by a BeanFactory after it has set all bean properties supplied (and satisfied BeanFactoryAware and ApplicationContextAware).
Object getObject()
Return an instance (possibly shared or independent) of the object managed by this factory.
Class<?> getObjectType()
Return the type of object that this FactoryBean creates, or null if not known in advance.
Class getTargetClass()
Return the target class on which the field is defined.
String getTargetField()
Return the name of the field to be retrieved.
Object getTargetObject()
Return the target object on which the field is defined.
boolean isSingleton()
Is the object managed by this factory a singleton? That is, will 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.

void setBeanClassLoader(ClassLoader classLoader)
Callback that supplies the bean class loader to a bean instance.
void setBeanName(String beanName)
The bean name of this FieldRetrievingFactoryBean will be interpreted as "staticField" pattern, if neither "targetClass" nor "targetObject" nor "targetField" have been specified.
void setStaticField(String staticField)
Set a fully qualified static field name to retrieve, e.g.
void setTargetClass(Class targetClass)
Set the target class on which the field is defined.
void setTargetField(String targetField)
Set the name of the field to be retrieved.
void setTargetObject(Object targetObject)
Set the target object on which the field is defined.
[Expand]
Inherited Methods
From class java.lang.Object
From interface org.springframework.beans.factory.BeanClassLoaderAware
From interface org.springframework.beans.factory.BeanNameAware
From interface org.springframework.beans.factory.FactoryBean
From interface org.springframework.beans.factory.InitializingBean

Public Constructors

public FieldRetrievingFactoryBean ()

Also: SpringBeans

Public Methods

public void afterPropertiesSet ()

Also: SpringBeans

Invoked by a BeanFactory after it has set all bean properties supplied (and satisfied BeanFactoryAware and ApplicationContextAware).

This method allows the bean instance to perform initialization only possible when all bean properties have been set and to throw an exception in the event of misconfiguration.

Throws
ClassNotFoundException
NoSuchFieldException

public Object getObject ()

Also: SpringBeans

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.

Returns
  • an instance of the bean (can be null)
Throws
IllegalAccessException

public Class<?> getObjectType ()

Also: SpringBeans

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.

Returns
  • the type of object that this FactoryBean creates, or null if not known at the time of the call

public Class getTargetClass ()

Also: SpringBeans

Return the target class on which the field is defined.

public String getTargetField ()

Also: SpringBeans

Return the name of the field to be retrieved.

public Object getTargetObject ()

Also: SpringBeans

Return the target object on which the field is defined.

public boolean isSingleton ()

Also: SpringBeans

Is the object managed by this factory a singleton? That is, will 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 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.

Returns
  • whether the exposed object is a singleton

public void setBeanClassLoader (ClassLoader classLoader)

Also: SpringBeans

Callback that supplies the bean class loader to a bean instance.

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

Parameters
classLoader the owning class loader; may be null in which case a default ClassLoader must be used, for example the ClassLoader obtained via getDefaultClassLoader()

public void setBeanName (String beanName)

Also: SpringBeans

The bean name of this FieldRetrievingFactoryBean will be interpreted as "staticField" pattern, if neither "targetClass" nor "targetObject" nor "targetField" have been specified. This allows for concise bean definitions with just an id/name.

Parameters
beanName the name of the bean in the factory. Note that this name is the actual bean name used in the factory, which may differ from the originally specified name: in particular for inner bean names, the actual bean name might have been made unique through appending "#..." suffixes. Use the originalBeanName(String) method to extract the original bean name (without suffix), if desired.

public void setStaticField (String staticField)

Also: SpringBeans

Set a fully qualified static field name to retrieve, e.g. "example.MyExampleClass.MY_EXAMPLE_FIELD". Convenient alternative to specifying targetClass and targetField.

See Also

public void setTargetClass (Class targetClass)

Also: SpringBeans

Set the target class on which the field is defined. Only necessary when the target field is static; else, a target object needs to be specified anyway.

See Also

public void setTargetField (String targetField)

Also: SpringBeans

Set the name of the field to be retrieved. Refers to either a static field or a non-static field, depending on a target object being set.

See Also

public void setTargetObject (Object targetObject)

Also: SpringBeans

Set the target object on which the field is defined. Only necessary when the target field is not static; else, a target class is sufficient.

See Also