org.springframework.beans.factory.config
Class FieldRetrievingFactoryBean

java.lang.Object
  org.springframework.beans.factory.config.FieldRetrievingFactoryBean

All Implemented Interfaces:

FactoryBean, InitializingBean

public class FieldRetrievingFactoryBean

extends java.lang.Object

implements FactoryBean, InitializingBean

FactoryBean which retrieves a static or non-static field value. Typically used for retrieving public static final constants.

Since:

31.07.2004

Author:

Juergen Hoeller

See Also:

setStaticField(java.lang.String)

Constructor Summary

FieldRetrievingFactoryBean()

Method Summary

void	afterPropertiesSet() Invoked by a BeanFactory after it has set all bean properties supplied (and satisfied BeanFactoryAware and ApplicationContextAware).
java.lang.Object	getObject() Return an instance (possibly shared or independent) of the object managed by this factory.
java.lang.Class	getObjectType() Return the type of object that this FactoryBean creates, or null if not known in advance.
java.lang.Class	getTargetClass() Return the target class on which the field is defined.
java.lang.String	getTargetField() Return the name of the field to be retrieved.
java.lang.Object	getTargetObject() Return the target object on which the field is defined.
boolean	isSingleton() Is the bean managed by this factory a singleton or a prototype?
void	setStaticField(java.lang.String staticField) Set a fully qualified static field name to retrieve, e.g.
void	setTargetClass(java.lang.Class targetClass) Set the target class on which the field is defined.
void	setTargetField(java.lang.String targetField) Set the name of the field to be retrieved.
void	setTargetObject(java.lang.Object targetObject) Set the target object on which the field is defined.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FieldRetrievingFactoryBean

public FieldRetrievingFactoryBean()

Method Detail

setTargetClass

public void setTargetClass(java.lang.Class targetClass)

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:

setTargetObject(java.lang.Object), setTargetField(java.lang.String)

getTargetClass

public java.lang.Class getTargetClass()

Return the target class on which the field is defined.

setTargetObject

public void setTargetObject(java.lang.Object targetObject)

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:

setTargetClass(java.lang.Class), setTargetField(java.lang.String)

getTargetObject

public java.lang.Object getTargetObject()

Return the target object on which the field is defined.

setTargetField

public void setTargetField(java.lang.String targetField)

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:

setTargetClass(java.lang.Class), setTargetObject(java.lang.Object)

getTargetField

public java.lang.String getTargetField()

Return the name of the field to be retrieved.

setStaticField

public void setStaticField(java.lang.String staticField)
                    throws java.lang.ClassNotFoundException

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

Throws:

java.lang.ClassNotFoundException

See Also:

setTargetClass(java.lang.Class), setTargetField(java.lang.String)

afterPropertiesSet

public void afterPropertiesSet()
                        throws java.lang.NoSuchFieldException

Description copied from interface: InitializingBean

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.

Specified by:

afterPropertiesSet in interface InitializingBean

Throws:

java.lang.NoSuchFieldException

getObject

public java.lang.Object getObject()
                           throws java.lang.IllegalAccessException

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.

Specified by:

getObject in interface FactoryBean

Returns:

an instance of the bean (should never be null)

Throws:

java.lang.IllegalAccessException

getObjectType

public java.lang.Class getObjectType()

Description copied from interface: FactoryBean

Return the type of object that this FactoryBean creates, or null if not known in advance. This allows to check for specific types of beans without instantiating objects, e.g. on autowiring.

For a singleton, this can simply return getObject().getClass(), or even null, as autowiring will always check the actual objects for singletons. For prototypes, returning a meaningful type here is highly advisable, as autowiring will simply ignore them else.

Specified by:

getObjectType in interface FactoryBean

Returns:

the type of object that this FactoryBean creates, or null

See Also:

ListableBeanFactory.getBeansOfType(java.lang.Class, boolean, boolean)

isSingleton

public boolean isSingleton()

Description copied from interface: FactoryBean

Is the bean managed by this factory a singleton or a prototype? That is, will getObject() always return the same object?

The singleton status of the FactoryBean itself will generally be provided by the owning BeanFactory.

Specified by:

isSingleton in interface FactoryBean

Returns:

if this bean is a singleton