org.apache.commons.beanutils
Class WrapDynaClass

java.lang.Object
  |
  +--org.apache.commons.beanutils.WrapDynaClass

All Implemented Interfaces:

DynaClass

public class WrapDynaClass

extends java.lang.Object

implements DynaClass

Implementation of DynaClass for DynaBeans that wrap standard JavaBean instances.

It is suggested that this class should not usually need to be used directly to create new WrapDynaBean instances. It's usually better to call the WrapDynaBean constructor directly. For example:

   Object javaBean = ...;
   DynaBean wrapper = new WrapDynaBean(javaBean);
 

Version:

$Revision: 1.8 $ $Date: 2004/02/28 13:18:34 $

Author:

Craig McClanahan

Field Summary

protected java.lang.Class	beanClass The JavaBean Class which is represented by this WrapDynaClass.
protected java.beans.PropertyDescriptor[]	descriptors The set of PropertyDescriptors for this bean class.
protected java.util.HashMap	descriptorsMap The set of PropertyDescriptors for this bean class, keyed by the property name.
protected static java.util.HashMap	dynaClasses The set of WrapDynaClass instances that have ever been created, keyed by the underlying bean Class.
protected DynaProperty[]	properties The set of dynamic properties that are part of this DynaClass.
protected java.util.HashMap	propertiesMap The set of dynamic properties that are part of this DynaClass, keyed by the property name.

Constructor Summary

private

WrapDynaClass(java.lang.Class beanClass) Construct a new WrapDynaClass for the specified JavaBean class.

Method Summary

static void	clear() Clear our cache of WrapDynaClass instances.
static WrapDynaClass	createDynaClass(java.lang.Class beanClass) Create (if necessary) and return a new WrapDynaClass instance for the specified bean class.
DynaProperty[]	getDynaProperties() Return an array of ProperyDescriptors for the properties currently defined in this DynaClass.
DynaProperty	getDynaProperty(java.lang.String name) Return a property descriptor for the specified property, if it exists; otherwise, return null.
java.lang.String	getName() Return the name of this DynaClass (analogous to the getName() method of java.lang.ClassDynaClass implementation class to support different dynamic classes, with different sets of properties.
java.beans.PropertyDescriptor	getPropertyDescriptor(java.lang.String name) Return the PropertyDescriptor for the specified property name, if any; otherwise return null.
protected void	introspect() Introspect our bean class to identify the supported properties.
DynaBean	newInstance() Instantiates a new standard JavaBean instance associated with this DynaClass and return it wrapped in a new WrapDynaBean instance.

Methods inherited from class java.lang.Object

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

Field Detail

beanClass

protected java.lang.Class beanClass

The JavaBean Class which is represented by this WrapDynaClass.

descriptors

protected java.beans.PropertyDescriptor[] descriptors

The set of PropertyDescriptors for this bean class.

descriptorsMap

protected java.util.HashMap descriptorsMap

The set of PropertyDescriptors for this bean class, keyed by the property name. Individual descriptor instances will be the same instances as those in the descriptors list.

properties

protected DynaProperty[] properties

The set of dynamic properties that are part of this DynaClass.

propertiesMap

protected java.util.HashMap propertiesMap

The set of dynamic properties that are part of this DynaClass, keyed by the property name. Individual descriptor instances will be the same instances as those in the properties list.

dynaClasses

protected static java.util.HashMap dynaClasses

The set of WrapDynaClass instances that have ever been created, keyed by the underlying bean Class.

Constructor Detail

WrapDynaClass

private WrapDynaClass(java.lang.Class beanClass)

Construct a new WrapDynaClass for the specified JavaBean class. This constructor is private; WrapDynaClass instances will be created as needed via calls to the createDynaClass(Class) method.

Parameters:

beanClass - JavaBean class to be introspected around

Method Detail

getName

public java.lang.String getName()

Return the name of this DynaClass (analogous to the getName() method of java.lang.ClassDynaClass implementation class to support different dynamic classes, with different sets of properties.

Specified by:

getName in interface DynaClass

getDynaProperty

public DynaProperty getDynaProperty(java.lang.String name)

Return a property descriptor for the specified property, if it exists; otherwise, return null.

Specified by:

getDynaProperty in interface DynaClass

Parameters:

name - Name of the dynamic property for which a descriptor is requested

Throws:

java.lang.IllegalArgumentException - if no property name is specified

getDynaProperties

public DynaProperty[] getDynaProperties()

Return an array of ProperyDescriptors for the properties currently defined in this DynaClass. If no properties are defined, a zero-length array will be returned.

FIXME - Should we really be implementing getBeanInfo() instead, which returns property descriptors and a bunch of other stuff?

Specified by:

getDynaProperties in interface DynaClass

newInstance

public DynaBean newInstance()
                     throws java.lang.IllegalAccessException,
                            java.lang.InstantiationException

Instantiates a new standard JavaBean instance associated with this DynaClass and return it wrapped in a new WrapDynaBean instance. NOTE the JavaBean should have a no argument constructor.

NOTE - Most common use cases should not need to use this method. It is usually better to create new WrapDynaBean instances by calling its constructor. For example:

   Object javaBean = ...;
   DynaBean wrapper = new WrapDynaBean(javaBean);
 

(This method is needed for some kinds of DynaBean framework.)

Specified by:

newInstance in interface DynaClass

Throws:

java.lang.IllegalAccessException - if the Class or the appropriate constructor is not accessible

java.lang.InstantiationException - if this Class represents an abstract class, an array class, a primitive type, or void; or if instantiation fails for some other reason

getPropertyDescriptor

public java.beans.PropertyDescriptor getPropertyDescriptor(java.lang.String name)

Return the PropertyDescriptor for the specified property name, if any; otherwise return null.

Parameters:

name - Name of the property to be retrieved

clear

public static void clear()

Clear our cache of WrapDynaClass instances.

createDynaClass

public static WrapDynaClass createDynaClass(java.lang.Class beanClass)

Create (if necessary) and return a new WrapDynaClass instance for the specified bean class.

Parameters:

beanClass - Bean class for which a WrapDynaClass is requested

introspect

protected void introspect()

Introspect our bean class to identify the supported properties.