Package org.apache.commons.beanutils2
Class WrapDynaBean
java.lang.Object
org.apache.commons.beanutils2.WrapDynaBean
- All Implemented Interfaces:
- DynaBean
- Direct Known Subclasses:
- ConvertingWrapDynaBean
 Implements DynaBean to wrap a standard JavaBean instance, so that DynaBean APIs can be used to access its properties.
 
 The most common use cases for this class involve wrapping an existing Java bean. (This makes it different from the typical use cases for other
 DynaBean's.) For example:
 
  Object aJavaBean = ...;
  ...
  DynaBean db = new WrapDynaBean(aJavaBean);
  ...
 
 IMPLEMENTATION NOTE - This implementation does not support the contains()</code> and <code>remove() methods.
 
- 
Field SummaryFieldsModifier and TypeFieldDescriptionprotected WrapDynaClassTheDynaClass"base class" that this DynaBean is associated with.protected ObjectThe JavaBean instance wrapped by this WrapDynaBean.
- 
Constructor SummaryConstructorsConstructorDescriptionWrapDynaBean(Object instance) Constructs a newDynaBeanassociated with the specified JavaBean instance.WrapDynaBean(Object instance, WrapDynaClass cls) Creates a new instance ofWrapDynaBean, associates it with the specified JavaBean instance, and initializes the bean'sDynaClass.
- 
Method SummaryModifier and TypeMethodDescriptionbooleanDoes the specified mapped property contain a value for the specified key value?Gets the value of a simple property with the specified name.Gets the value of an indexed property with the specified name.Gets the value of a mapped property with the specified name, ornullif there is no value for the specified key.Gets theDynaClassinstance that describes the set of properties available for this DynaBean.protected DynaPropertygetDynaProperty(String name) Gets the property descriptor for the specified property name.Gets the bean instance wrapped by this DynaBean.voidRemove any existing value for the specified key on the specified mapped property.voidSets the value of an indexed property with the specified name.voidSets the value of a simple property with the specified name.voidSets the value of a mapped property with the specified name.
- 
Field Details- 
dynaClassTheDynaClass"base class" that this DynaBean is associated with.
- 
instanceThe JavaBean instance wrapped by this WrapDynaBean.
 
- 
- 
Constructor Details- 
WrapDynaBeanConstructs a newDynaBeanassociated with the specified JavaBean instance.- Parameters:
- instance- JavaBean instance to be wrapped
 
- 
WrapDynaBeanCreates a new instance ofWrapDynaBean, associates it with the specified JavaBean instance, and initializes the bean'sDynaClass. Using this constructor thisWrapDynaBeaninstance can be assigned a class which has been configured externally. If noWrapDynaClassis provided, a new one is created using a standard mechanism.- Parameters:
- instance- JavaBean instance to be wrapped
- cls- the optional- WrapDynaClassto be used for this bean
- Since:
- 1.9
 
 
- 
- 
Method Details- 
containsDoes the specified mapped property contain a value for the specified key value?- Specified by:
- containsin interface- DynaBean
- Parameters:
- name- Name of the property to check
- key- Name of the key to check
- Returns:
- trueif the mapped property contains a value for the specified key, otherwise- false
- Throws:
- IllegalArgumentException- if there is no property of the specified name
 
- 
getGets the value of a simple property with the specified name.- Specified by:
- getin interface- DynaBean
- Parameters:
- name- Name of the property whose value is to be retrieved
- Returns:
- The property's value
- Throws:
- IllegalArgumentException- if there is no property of the specified name
- NullPointerException- for null input.
 
- 
getGets the value of an indexed property with the specified name.- Specified by:
- getin interface- DynaBean
- Parameters:
- name- Name of the property whose value is to be retrieved
- index- Index of the value to be retrieved
- Returns:
- The indexed property's value
- Throws:
- IllegalArgumentException- if there is no property of the specified name
- IllegalArgumentException- if the specified property exists, but is not indexed
- IndexOutOfBoundsException- if the specified index is outside the range of the underlying property
- NullPointerException- if no array or List has been initialized for this property
 
- 
getGets the value of a mapped property with the specified name, ornullif there is no value for the specified key.- Specified by:
- getin interface- DynaBean
- Parameters:
- name- Name of the property whose value is to be retrieved
- key- Key of the value to be retrieved
- Returns:
- The mapped property's value
- Throws:
- IllegalArgumentException- if there is no property of the specified name
- IllegalArgumentException- if the specified property exists, but is not mapped
 
- 
getDynaClassGets theDynaClassinstance that describes the set of properties available for this DynaBean.- Specified by:
- getDynaClassin interface- DynaBean
- Returns:
- The associated DynaClass
 
- 
getDynaPropertyGets the property descriptor for the specified property name.- Parameters:
- name- Name of the property for which to retrieve the descriptor
- Returns:
- The descriptor for the specified property
- Throws:
- IllegalArgumentException- if this is not a valid property name for our DynaClass
 
- 
getInstanceGets the bean instance wrapped by this DynaBean. For most common use cases, this object should already be known and this method safely be ignored. But some creators of frameworks usingDynaBean's may find this useful.- Returns:
- the Java bean Object wrapped by this DynaBean
 
- 
removeRemove any existing value for the specified key on the specified mapped property.- Specified by:
- removein interface- DynaBean
- Parameters:
- name- Name of the property for which a value is to be removed
- key- Key of the value to be removed
- Throws:
- IllegalArgumentException- if there is no property of the specified name
 
- 
setSets the value of an indexed property with the specified name.- Specified by:
- setin interface- DynaBean
- Parameters:
- name- Name of the property whose value is to be set
- index- Index of the property to be set
- value- Value to which this property is to be set
- Throws:
- ConversionException- if the specified value cannot be converted to the type required for this property
- IllegalArgumentException- if there is no property of the specified name
- IllegalArgumentException- if the specified property exists, but is not indexed
- IndexOutOfBoundsException- if the specified index is outside the range of the underlying property
 
- 
setSets the value of a simple property with the specified name.- Specified by:
- setin interface- DynaBean
- Parameters:
- name- Name of the property whose value is to be set
- value- Value to which this property is to be set
- Throws:
- ConversionException- if the specified value cannot be converted to the type required for this property
- IllegalArgumentException- if there is no property of the specified name
- NullPointerException- if an attempt is made to set a primitive property to null
 
- 
setSets the value of a mapped property with the specified name.- Specified by:
- setin interface- DynaBean
- Parameters:
- name- Name of the property whose value is to be set
- key- Key of the property to be set
- value- Value to which this property is to be set
- Throws:
- ConversionException- if the specified value cannot be converted to the type required for this property
- IllegalArgumentException- if there is no property of the specified name
- IllegalArgumentException- if the specified property exists, but is not mapped
 
 
-