Save This Page
Home » spring-framework-2.5.5-with-dependencies » org.springframework » beans » [javadoc | source]
org.springframework.beans
abstract public class: BeanUtils [javadoc | source]
java.lang.Object
   org.springframework.beans.BeanUtils
Static convenience methods for JavaBeans: for instantiating beans, checking bean property types, copying bean properties, etc.

Mainly for use within the framework, but to some degree also useful for application classes.

Method from org.springframework.beans.BeanUtils Summary:
copyProperties,   copyProperties,   copyProperties,   findDeclaredMethod,   findDeclaredMethodWithMinimalParameters,   findEditorByConvention,   findMethod,   findMethodWithMinimalParameters,   findPropertyForMethod,   findPropertyType,   getPropertyDescriptor,   getPropertyDescriptors,   getWriteMethodParameter,   instantiateClass,   instantiateClass,   isAssignable,   isAssignable,   isSimpleProperty,   isSimpleValueType,   resolveSignature
Methods from java.lang.Object:
equals,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from org.springframework.beans.BeanUtils Detail:
 public static  void copyProperties(Object source,
    Object target) throws BeansException 
    Copy the property values of the given source bean into the target bean.

    Note: The source and target classes do not have to match or even be derived from each other, as long as the properties match. Any bean properties that the source bean exposes but the target bean does not will silently be ignored.

    This is just a convenience method. For more complex transfer needs, consider using a full BeanWrapper.

 public static  void copyProperties(Object source,
    Object target,
    Class editable) throws BeansException 
    Copy the property values of the given source bean into the given target bean, only setting properties defined in the given "editable" class (or interface).

    Note: The source and target classes do not have to match or even be derived from each other, as long as the properties match. Any bean properties that the source bean exposes but the target bean does not will silently be ignored.

    This is just a convenience method. For more complex transfer needs, consider using a full BeanWrapper.

 public static  void copyProperties(Object source,
    Object target,
    String[] ignoreProperties) throws BeansException 
    Copy the property values of the given source bean into the given target bean, ignoring the given "ignoreProperties".

    Note: The source and target classes do not have to match or even be derived from each other, as long as the properties match. Any bean properties that the source bean exposes but the target bean does not will silently be ignored.

    This is just a convenience method. For more complex transfer needs, consider using a full BeanWrapper.

 public static Method findDeclaredMethod(Class clazz,
    String methodName,
    Class[] paramTypes) 
    Find a method with the given method name and the given parameter types, declared on the given class or one of its superclasses. Will return a public, protected, package access, or private method.

    Checks Class.getDeclaredMethod, cascading upwards to all superclasses.

 public static Method findDeclaredMethodWithMinimalParameters(Class clazz,
    String methodName) throws IllegalArgumentException 
    Find a method with the given method name and minimal parameters (best case: none), declared on the given class or one of its superclasses. Will return a public, protected, package access, or private method.

    Checks Class.getDeclaredMethods, cascading upwards to all superclasses.

 public static PropertyEditor findEditorByConvention(Class targetType) 
    Find a JavaBeans PropertyEditor following the 'Editor' suffix convention (e.g. "mypackage.MyDomainClass" -> "mypackage.MyDomainClassEditor").

    Compatible to the standard JavaBeans convention as implemented by java.beans.PropertyEditorManager but isolated from the latter's registered default editors for primitive types.

 public static Method findMethod(Class clazz,
    String methodName,
    Class[] paramTypes) 
    Find a method with the given method name and the given parameter types, declared on the given class or one of its superclasses. Prefers public methods, but will return a protected, package access, or private method too.

    Checks Class.getMethod first, falling back to findDeclaredMethod. This allows to find public methods without issues even in environments with restricted Java security settings.

 public static Method findMethodWithMinimalParameters(Class clazz,
    String methodName) throws IllegalArgumentException 
    Find a method with the given method name and minimal parameters (best case: none), declared on the given class or one of its superclasses. Prefers public methods, but will return a protected, package access, or private method too.

    Checks Class.getMethods first, falling back to findDeclaredMethodWithMinimalParameters. This allows to find public methods without issues even in environments with restricted Java security settings.

 public static PropertyDescriptor findPropertyForMethod(Method method) throws BeansException 
    Find a JavaBeans PropertyDescriptor for the given method, with the method either being the read method or the write method for that bean property.
 public static Class findPropertyType(String propertyName,
    Class[] beanClasses) 
    Determine the bean property type for the given property from the given classes/interfaces, if possible.
 public static PropertyDescriptor getPropertyDescriptor(Class clazz,
    String propertyName) throws BeansException 
    Retrieve the JavaBeans PropertyDescriptors for the given property.
 public static PropertyDescriptor[] getPropertyDescriptors(Class clazz) throws BeansException 
    Retrieve the JavaBeans PropertyDescriptors of a given class.
 public static MethodParameter getWriteMethodParameter(PropertyDescriptor pd) 
    Obtain a new MethodParameter object for the write method of the specified property.
 public static Object instantiateClass(Class clazz) throws BeanInstantiationException 
    Convenience method to instantiate a class using its no-arg constructor. As this method doesn't try to load classes by name, it should avoid class-loading issues.

    Note that this method tries to set the constructor accessible if given a non-accessible (that is, non-public) constructor.

 public static Object instantiateClass(Constructor ctor,
    Object[] args) throws BeanInstantiationException 
    Convenience method to instantiate a class using the given constructor. As this method doesn't try to load classes by name, it should avoid class-loading issues.

    Note that this method tries to set the constructor accessible if given a non-accessible (that is, non-public) constructor.

 public static boolean isAssignable(Class targetType,
    Class valueType) 
Deprecated! as - of Spring 2.0, in favor of ClassUtils.isAssignable

    Determine if the given target type is assignable from the given value type, assuming setting by reflection. Considers primitive wrapper classes as assignable to the corresponding primitive types.
 public static boolean isAssignable(Class type,
    Object value) 
Deprecated! as - of Spring 2.0, in favor of ClassUtils.isAssignableValue

    Determine if the given type is assignable from the given value, assuming setting by reflection. Considers primitive wrapper classes as assignable to the corresponding primitive types.
 public static boolean isSimpleProperty(Class clazz) 
    Check if the given type represents a "simple" property: a primitive, a String or other CharSequence, a Number, a Date, a URI, a URL, a Locale, a Class, or a corresponding array.

    Used to determine properties to check for a "simple" dependency-check.

 public static boolean isSimpleValueType(Class clazz) 
    Check if the given type represents a "simple" value type: a primitive, a String or other CharSequence, a Number, a Date, a URI, a URL, a Locale or a Class.
 public static Method resolveSignature(String signature,
    Class clazz) 
    Parse a method signature in the form methodName[([arg_list])], where arg_list is an optional, comma-separated list of fully-qualified type names, and attempts to resolve that signature against the supplied Class.

    When not supplying an argument list (methodName) the method whose name matches and has the least number of parameters will be returned. When supplying an argument type list, only the method whose name and argument types match will be returned.

    Note then that methodName and methodName() are not resolved in the same way. The signature methodName means the method called methodName with the least number of arguments, whereas methodName() means the method called methodName with exactly 0 arguments.

    If no method can be found, then null is returned.