| java.lang.Object com.jgoodies.binding.beans.BeanUtils
BeanUtils | final public class BeanUtils (Code) | | Consists exclusively of static methods that provide
convenience behavior for working with Java Bean properties.
author: Karsten Lentzsch version: $Revision: 1.12 $ See Also: Introspector See Also: BeanInfo See Also: PropertyDescriptor |
Method Summary | |
public static void | addPropertyChangeListener(Object bean, Class> beanClass, PropertyChangeListener listener) Adds a property change listener to the given bean. | public static void | addPropertyChangeListener(Object bean, Class> beanClass, String propertyName, PropertyChangeListener listener) Adds a named property change listener to the given bean. | public static void | addPropertyChangeListener(Object bean, PropertyChangeListener listener) Adds a property change listener to the given bean. | public static void | addPropertyChangeListener(Object bean, String propertyName, PropertyChangeListener listener) Adds a named property change listener to the given bean. | public static Method | getNamedPCLAdder(Class> clazz) Looks up and returns the method that adds a PropertyChangeListener
for a specified property name to instances of the given class. | public static Method | getNamedPCLRemover(Class> clazz) Looks up and returns the method that removes a PropertyChangeListener
for a specified property name from instances of the given class. | public static Method | getPCLAdder(Class> clazz) Looks up and returns the method that adds a multicast
PropertyChangeListener to instances of the given class. | public static Method | getPCLRemover(Class> clazz) Looks up and returns the method that removes a multicast
PropertyChangeListener from instances of the given class. | public static PropertyDescriptor | getPropertyDescriptor(Class> beanClass, String propertyName) Looks up and returns a PropertyDescriptor for the
given Java Bean class and property name using the standard
Java Bean introspection behavior. | public static PropertyDescriptor | getPropertyDescriptor(Class> beanClass, String propertyName, String getterName, String setterName) Looks up and returns a PropertyDescriptor for the given
Java Bean class and property name. | public static Object | getValue(Object bean, PropertyDescriptor propertyDescriptor) Returns the value of the specified property of the given non-null bean. | public static void | removePropertyChangeListener(Object bean, Class> beanClass, PropertyChangeListener listener) Removes a property change listener from the given bean. | public static void | removePropertyChangeListener(Object bean, Class> beanClass, String propertyName, PropertyChangeListener listener) Removes a named property change listener from the given bean. | public static void | removePropertyChangeListener(Object bean, PropertyChangeListener listener) Removes a property change listener from the given bean. | public static void | removePropertyChangeListener(Object bean, String propertyName, PropertyChangeListener listener) Removes a named property change listener from the given bean. | public static void | setValue(Object bean, PropertyDescriptor propertyDescriptor, Object newValue) Sets the given object as new value of the specified property of the given
non-null bean. | public static boolean | supportsBoundProperties(Class> clazz) Checks and answers whether the given class supports bound properties,
i.e. |
addPropertyChangeListener | public static void addPropertyChangeListener(Object bean, Class> beanClass, PropertyChangeListener listener)(Code) | | Adds a property change listener to the given bean. First checks
whether the bean supports bound properties, i.e. it provides
a pair of methods to register multicast property change event listeners;
see section 7.4.1 of the Java Beans specification for details.
Parameters: bean - the bean to add the property change listener to Parameters: beanClass - the Bean class used to lookup methods from Parameters: listener - the listener to add throws: NullPointerException - if the bean or listener is null throws: IllegalArgumentException - if the bean is not an instance of the bean class throws: PropertyUnboundException - if the bean does not support bound properties throws: PropertyNotBindableException - if the property change handler cannot be added successfully since: 1.1.1 |
addPropertyChangeListener | public static void addPropertyChangeListener(Object bean, Class> beanClass, String propertyName, PropertyChangeListener listener)(Code) | | Adds a named property change listener to the given bean. The bean
must provide the optional support for listening on named properties
as described in section 7.4.5 of the
Java Bean
Specification. The bean class must provide the method:
public void addPropertyChangeListener(String name, PropertyChangeListener l);
Parameters: bean - the bean to add a property change handler Parameters: beanClass - the Bean class used to lookup methods from Parameters: propertyName - the name of the property to be observed Parameters: listener - the listener to add throws: NullPointerException - if the bean, propertyName or listener is null throws: IllegalArgumentException - if the bean is not an instance of the bean class throws: PropertyNotBindableException - if the property change handler cannot be added successfully |
addPropertyChangeListener | public static void addPropertyChangeListener(Object bean, PropertyChangeListener listener)(Code) | | Adds a property change listener to the given bean. First checks
whether the bean supports bound properties, i.e. it provides
a pair of methods to register multicast property change event listeners;
see section 7.4.1 of the Java Beans specification for details.
Parameters: bean - the bean to add the property change listener to Parameters: listener - the listener to add throws: NullPointerException - if the bean or listener is null throws: PropertyUnboundException - if the bean does not support bound properties throws: PropertyNotBindableException - if the property change handler cannot be added successfully |
addPropertyChangeListener | public static void addPropertyChangeListener(Object bean, String propertyName, PropertyChangeListener listener)(Code) | | Adds a named property change listener to the given bean. The bean
must provide the optional support for listening on named properties
as described in section 7.4.5 of the
Java Bean
Specification. The bean class must provide the method:
public void addPropertyChangeListener(String name, PropertyChangeListener l);
Parameters: bean - the bean to add a property change handler Parameters: propertyName - the name of the property to be observed Parameters: listener - the listener to add throws: NullPointerException - if the bean, propertyName or listener is null throws: PropertyNotBindableException - if the property change handler cannot be added successfully |
getNamedPCLAdder | public static Method getNamedPCLAdder(Class> clazz)(Code) | | Looks up and returns the method that adds a PropertyChangeListener
for a specified property name to instances of the given class.
Parameters: clazz - the class that provides the adder method the method that adds the PropertyChangeListeners |
getNamedPCLRemover | public static Method getNamedPCLRemover(Class> clazz)(Code) | | Looks up and returns the method that removes a PropertyChangeListener
for a specified property name from instances of the given class.
Parameters: clazz - the class that provides the remover method the method that removes the PropertyChangeListeners |
getPCLAdder | public static Method getPCLAdder(Class> clazz)(Code) | | Looks up and returns the method that adds a multicast
PropertyChangeListener to instances of the given class.
Parameters: clazz - the class that provides the adder method the method that adds multicast PropertyChangeListeners |
getPCLRemover | public static Method getPCLRemover(Class> clazz)(Code) | | Looks up and returns the method that removes a multicast
PropertyChangeListener from instances of the given class.
Parameters: clazz - the class that provides the remover method the method that removes multicast PropertyChangeListeners |
getPropertyDescriptor | public static PropertyDescriptor getPropertyDescriptor(Class> beanClass, String propertyName) throws IntrospectionException(Code) | | Looks up and returns a PropertyDescriptor for the
given Java Bean class and property name using the standard
Java Bean introspection behavior.
Parameters: beanClass - the type of the bean that holds the property Parameters: propertyName - the name of the Bean property the PropertyDescriptor associated with the givenbean and property name as returned by the Bean introspection throws: IntrospectionException - if an exception occurs duringintrospection. throws: NullPointerException - if the beanClass or propertyName is null since: 1.1.1 |
getPropertyDescriptor | public static PropertyDescriptor getPropertyDescriptor(Class> beanClass, String propertyName, String getterName, String setterName)(Code) | | Looks up and returns a PropertyDescriptor for the given
Java Bean class and property name. If a getter name or setter name
is available, these are used to create a PropertyDescriptor.
Otherwise, the standard Java Bean introspection is used to determine
the property descriptor.
Parameters: beanClass - the class of the bean that holds the property Parameters: propertyName - the name of the property to be accessed Parameters: getterName - the optional name of the property's getter Parameters: setterName - the optional name of the property's setter the PropertyDescriptor associated with thegiven bean and property name throws: PropertyNotFoundException - if the property could not be found since: 1.1.1 |
getValue | public static Object getValue(Object bean, PropertyDescriptor propertyDescriptor)(Code) | | Returns the value of the specified property of the given non-null bean.
This operation is unsupported if the bean property is read-only.
If the read access fails, a PropertyAccessException is thrown
that provides the Throwable that caused the failure.
Parameters: bean - the bean to read the value from Parameters: propertyDescriptor - describes the property to be read the bean's property value throws: NullPointerException - if the bean is null throws: UnsupportedOperationException - if the bean property is write-only throws: PropertyAccessException - if the new value could not be read |
removePropertyChangeListener | public static void removePropertyChangeListener(Object bean, Class> beanClass, PropertyChangeListener listener)(Code) | | Removes a property change listener from the given bean.
Parameters: bean - the bean to remove the property change listener from Parameters: beanClass - the Java Bean class used to lookup methods from Parameters: listener - the listener to remove throws: NullPointerException - if the bean or listener is null throws: IllegalArgumentException - if the bean is not an instance of the bean class throws: PropertyUnboundException - if the bean does not support bound properties throws: PropertyNotBindableException - if the property change handler cannot be removed successfully since: 1.1.1 |
removePropertyChangeListener | public static void removePropertyChangeListener(Object bean, Class> beanClass, String propertyName, PropertyChangeListener listener)(Code) | | Removes a named property change listener from the given bean. The bean
must provide the optional support for listening on named properties
as described in section 7.4.5 of the
Java Bean
Specification. The bean class must provide the method:
public void removePropertyChangeHandler(String name, PropertyChangeListener l);
Parameters: bean - the bean to remove the property change listener from Parameters: beanClass - the Java Bean class used to lookup methods from Parameters: propertyName - the name of the observed property Parameters: listener - the listener to remove throws: NullPointerException - if the bean, propertyName, or listener is null throws: IllegalArgumentException - if the bean is not an instance of the bean class throws: PropertyNotBindableException - if the property change handler cannot be removed successfully since: 1.1.1 |
removePropertyChangeListener | public static void removePropertyChangeListener(Object bean, PropertyChangeListener listener)(Code) | | Removes a property change listener from the given bean.
Parameters: bean - the bean to remove the property change listener from Parameters: listener - the listener to remove throws: NullPointerException - if the bean or listener is null throws: PropertyUnboundException - if the bean does not support bound properties throws: PropertyNotBindableException - if the property change handler cannot be removed successfully |
removePropertyChangeListener | public static void removePropertyChangeListener(Object bean, String propertyName, PropertyChangeListener listener)(Code) | | Removes a named property change listener from the given bean. The bean
must provide the optional support for listening on named properties
as described in section 7.4.5 of the
Java Bean
Specification. The bean class must provide the method:
public void removePropertyChangeHandler(String name, PropertyChangeListener l);
Parameters: bean - the bean to remove the property change listener from Parameters: propertyName - the name of the observed property Parameters: listener - the listener to remove throws: NullPointerException - if the bean, propertyName, or listener is null throws: PropertyNotBindableException - if the property change handler cannot be removed successfully |
setValue | public static void setValue(Object bean, PropertyDescriptor propertyDescriptor, Object newValue) throws PropertyVetoException(Code) | | Sets the given object as new value of the specified property of the given
non-null bean. This is unsupported if the bean property is read-only.
If the write access fails, a PropertyAccessException is thrown
that provides the Throwable that caused the failure.
If the bean property is constrained and a VetoableChangeListener
has vetoed against the value change, the PropertyAccessException
wraps the PropertyVetoException thrown by the setter.
Parameters: bean - the bean that holds the adapted property Parameters: propertyDescriptor - describes the property to be set Parameters: newValue - the property value to be set throws: NullPointerException - if the bean is null throws: UnsupportedOperationException - if the bean property is read-only throws: PropertyAccessException - if the new value could not be set throws: PropertyVetoException - if the bean setter throws this exception |
supportsBoundProperties | public static boolean supportsBoundProperties(Class> clazz)(Code) | | Checks and answers whether the given class supports bound properties,
i.e. it provides a pair of multicast event listener registration methods
for PropertyChangeListener s:
public void addPropertyChangeListener(PropertyChangeListener x);
public void removePropertyChangeListener(PropertyChangeListener x);
Parameters: clazz - the class to test true if the class supports bound properties, false otherwise |
|
|