org.sakaiproject.metaobj.utils.ioc
Class FieldRetrievingFactoryBean

java.lang.Object
  extended byorg.sakaiproject.metaobj.utils.ioc.FieldRetrievingFactoryBean
All Implemented Interfaces:
BeanNameAware, FactoryBean, InitializingBean

public class FieldRetrievingFactoryBean
extends Object
implements FactoryBean, BeanNameAware, InitializingBean

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</value></property>
 </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"/>

Since:
1.1
Author:
Juergen Hoeller
See Also:
setStaticField(java.lang.String)

Constructor Summary
FieldRetrievingFactoryBean()
           
 
Method Summary
 void afterPropertiesSet()
           
 Object getObject()
           
 Class getObjectType()
           
 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()
           
 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.
 
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(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 Class getTargetClass()
Return the target class on which the field is defined.


setTargetObject

public void setTargetObject(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 Object getTargetObject()
Return the target object on which the field is defined.


setTargetField

public void setTargetField(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 String getTargetField()
Return the name of the field to be retrieved.


setStaticField

public void setStaticField(String staticField)
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:
setTargetClass(java.lang.Class), setTargetField(java.lang.String)

setBeanName

public 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. This allows for concise bean definitions with just an id/name.

Specified by:
setBeanName in interface BeanNameAware

afterPropertiesSet

public void afterPropertiesSet()
                        throws ClassNotFoundException,
                               NoSuchFieldException
Specified by:
afterPropertiesSet in interface InitializingBean
Throws:
ClassNotFoundException
NoSuchFieldException

getObject

public Object getObject()
                 throws IllegalAccessException
Specified by:
getObject in interface FactoryBean
Throws:
IllegalAccessException

getObjectType

public Class getObjectType()
Specified by:
getObjectType in interface FactoryBean

isSingleton

public boolean isSingleton()
Specified by:
isSingleton in interface FactoryBean