Class LazyDynaClass
- All Implemented Interfaces:
Serializable,DynaClass,MutableDynaClass
DynaClass which implements the MutableDynaClass interface.
A MutableDynaClass is a specialized extension to DynaClass
that allows properties to be added or removed dynamically.
This implementation has one slightly unusual default behavior - calling
the getDynaProperty(name) method for a property which doesn't
exist returns a DynaProperty rather than null. The
reason for this is that BeanUtils calls this method to check if
a property exists before trying to set the value. This would defeat the object
of the LazyDynaBean which automatically adds missing properties
when any of its set() methods are called. For this reason the
isDynaProperty(name) method has been added to this implementation
in order to determine if a property actually exists. If the more normal
behavior of returning null is required, then this can be achieved
by calling the setReturnNull(true).
The add(name, type, readable, writable) method is not implemented
and always throws an UnsupportedOperationException. I believe
this attributes need to be added to the DynaProperty class
in order to control read/write facilities.
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected booleanControls whether changes to this DynaClass's properties are allowed.protected booleanControls whether thegetDynaProperty()method returns null if a property doesn't exist - or creates a new one.Fields inherited from class org.apache.commons.beanutils.BasicDynaClass
constructor, constructorTypes, constructorValues, dynaBeanClass, name, properties, propertiesMap -
Constructor Summary
ConstructorsConstructorDescriptionConstruct a new LazyDynaClass with default parameters.LazyDynaClass(String name) Construct a new LazyDynaClass with the specified name.LazyDynaClass(String name, Class<?> dynaBeanClass) Construct a new LazyDynaClass with the specified name and DynaBean class.LazyDynaClass(String name, Class<?> dynaBeanClass, DynaProperty[] properties) Construct a new LazyDynaClass with the specified name, DynaBean class and properties.LazyDynaClass(String name, DynaProperty[] properties) Construct a new LazyDynaClass with the specified name and properties. -
Method Summary
Modifier and TypeMethodDescriptionvoidAdd a new dynamic property with no restrictions on data type, readability, or writeability.voidAdd a new dynamic property with the specified data type, but with no restrictions on readability or writeability.voidAdd a new dynamic property with the specified data type, readability, and writeability.protected voidadd(DynaProperty property) Add a new dynamic property.getDynaProperty(String name) Return a property descriptor for the specified property.booleanisDynaProperty(String name) Indicate whether a property actually exists.booleanIs this DynaClass currently restricted.booleanShould this DynaClass return anullfrom thegetDynaProperty(name)method if the property doesn't exist.voidRemove the specified dynamic property, and any associated data type, readability, and writeability, from this dynamic class.voidsetRestricted(boolean restricted) Set whether this DynaClass is currently restricted.voidsetReturnNull(boolean returnNull) Set whether this DynaClass should return anullfrom thegetDynaProperty(name)method if the property doesn't exist.Methods inherited from class org.apache.commons.beanutils.BasicDynaClass
getDynaBeanClass, getDynaProperties, getName, newInstance, setDynaBeanClass, setPropertiesMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.apache.commons.beanutils.DynaClass
getDynaProperties, getName, newInstance
-
Field Details
-
restricted
Controls whether changes to this DynaClass's properties are allowed. -
returnNull
Controls whether the
getDynaProperty()method returns null if a property doesn't exist - or creates a new one.Default is
false.
-
-
Constructor Details
-
LazyDynaClass
public LazyDynaClass()Construct a new LazyDynaClass with default parameters. -
LazyDynaClass
Construct a new LazyDynaClass with the specified name.- Parameters:
name- Name of this DynaBean class
-
LazyDynaClass
Construct a new LazyDynaClass with the specified name and DynaBean class.- Parameters:
name- Name of this DynaBean classdynaBeanClass- The implementation class for new instances
-
LazyDynaClass
Construct a new LazyDynaClass with the specified name, DynaBean class and properties.- Parameters:
name- Name of this DynaBean classdynaBeanClass- The implementation class for new instancesproperties- Property descriptors for the supported properties
-
LazyDynaClass
Construct a new LazyDynaClass with the specified name and properties.- Parameters:
name- Name of this DynaBean classproperties- Property descriptors for the supported properties
-
-
Method Details
-
add
Add a new dynamic property.- Parameters:
property- Property the new dynamic property to add.- Throws:
IllegalArgumentException- if name is nullIllegalStateException- if this DynaClass is currently restricted, so no new properties can be added
-
add
Add a new dynamic property with no restrictions on data type, readability, or writeability.- Specified by:
addin interfaceMutableDynaClass- Parameters:
name- Name of the new dynamic property- Throws:
IllegalArgumentException- if name is nullIllegalStateException- if this DynaClass is currently restricted, so no new properties can be added
-
add
Add a new dynamic property with the specified data type, but with no restrictions on readability or writeability.- Specified by:
addin interfaceMutableDynaClass- Parameters:
name- Name of the new dynamic propertytype- Data type of the new dynamic property (null for no restrictions)- Throws:
IllegalArgumentException- if name is nullIllegalStateException- if this DynaClass is currently restricted, so no new properties can be added
-
add
Add a new dynamic property with the specified data type, readability, and writeability.
N.B.Support for readable/writeable properties has not been implemented and this method always throws a
UnsupportedOperationException.I'm not sure the intention of the original authors for this method, but it seems to me that readable/writable should be attributes of the
DynaPropertyclass (which they are not) and is the reason this method has not been implemented.- Specified by:
addin interfaceMutableDynaClass- Parameters:
name- Name of the new dynamic propertytype- Data type of the new dynamic property (null for no restrictions)readable- Set totrueif this property value should be readablewriteable- Set totrueif this property value should be writeable- Throws:
UnsupportedOperationException- anytime this method is called
-
getDynaProperty
Return a property descriptor for the specified property.
If the property is not found and the
returnNullindicator istrue, this method always returnsnull.If the property is not found and the
returnNullindicator isfalsea new property descriptor is created and returned (although its not actually added to the DynaClass's properties). This is the default beahviour.The reason for not returning a
nullproperty descriptor is thatBeanUtilsuses this method to check if a property exists before trying to set it - since these Lazy implementations automatically add any new properties when they are set, returningnullfrom this method would defeat their purpose.- Specified by:
getDynaPropertyin interfaceDynaClass- Overrides:
getDynaPropertyin classBasicDynaClass- Parameters:
name- Name of the dynamic property for which a descriptor is requested- Returns:
- The dyna property for the specified name
- Throws:
IllegalArgumentException- if no property name is specified
-
isDynaProperty
Indicate whether a property actually exists.
N.B. Using
getDynaProperty(name) == nulldoesn't work in this implementation because that method might return a DynaProperty if it doesn't exist (depending on thereturnNullindicator).- Parameters:
name- The name of the property to check- Returns:
trueif there is a property of the specified name, otherwisefalse- Throws:
IllegalArgumentException- if no property name is specified
-
isRestricted
Is this DynaClass currently restricted.
If restricted, no changes to the existing registration of property names, data types, readability, or writeability are allowed.
- Specified by:
isRestrictedin interfaceMutableDynaClass- Returns:
trueif thisMutableDynaClasscannot be changed otherwisefalse
-
isReturnNull
Should this DynaClass return anullfrom thegetDynaProperty(name)method if the property doesn't exist.- Returns:
trueif anullDynaPropertyshould be returned if the property doesn't exist, otherwisefalseif a newDynaPropertyshould be created.
-
remove
Remove the specified dynamic property, and any associated data type, readability, and writeability, from this dynamic class. NOTE - This does NOT cause any corresponding property values to be removed from DynaBean instances associated with this DynaClass.- Specified by:
removein interfaceMutableDynaClass- Parameters:
name- Name of the dynamic property to remove- Throws:
IllegalArgumentException- if name is nullIllegalStateException- if this DynaClass is currently restricted, so no properties can be removed
-
setRestricted
Set whether this DynaClass is currently restricted.
If restricted, no changes to the existing registration of property names, data types, readability, or writeability are allowed.
- Specified by:
setRestrictedin interfaceMutableDynaClass- Parameters:
restricted-trueif thisMutableDynaClasscannot be changed otherwisefalse
-
setReturnNull
Set whether this DynaClass should return anullfrom thegetDynaProperty(name)method if the property doesn't exist.- Parameters:
returnNull-trueif anullDynaPropertyshould be returned if the property doesn't exist, otherwisefalseif a newDynaPropertyshould be created.
-