Class LazyDynaClass
- All Implemented Interfaces:
- DynaClass,- MutableDynaClass
 DynaClass which implements the MutableDynaClass interface.
 
 A MutableDynaClass</code> is a specialized extension to <code>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</code> rather than <code>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 SummaryFieldsModifier 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.beanutils2.BasicDynaClassconstructor, constructorValues, dynaBeanClass, name, properties, propertiesMap
- 
Constructor SummaryConstructorsConstructorDescriptionConstructs a new LazyDynaClass with default parameters.LazyDynaClass(String name) Constructs a new LazyDynaClass with the specified name.LazyDynaClass(String name, Class<?> dynaBeanClass) Constructs a new LazyDynaClass with the specified name and DynaBean class.LazyDynaClass(String name, Class<?> dynaBeanClass, DynaProperty[] properties) Constructs a new LazyDynaClass with the specified name, DynaBean class and properties.LazyDynaClass(String name, DynaProperty[] properties) Constructs a new LazyDynaClass with the specified name and properties.
- 
Method SummaryModifier 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) Sets whether this DynaClass should return anullfrom thegetDynaProperty(name)method if the property doesn't exist.Methods inherited from class org.apache.commons.beanutils2.BasicDynaClassgetDynaBeanClass, getDynaProperties, getName, newInstance, setDynaBeanClass, setPropertiesMethods inherited from class java.lang.Objectclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.apache.commons.beanutils2.DynaClassgetDynaProperties, getName, newInstance
- 
Field Details- 
restrictedControls whether changes to this DynaClass's properties are allowed.
- 
returnNullControls whether the getDynaProperty()method returns null if a property doesn't exist - or creates a new one.Default is false.
 
- 
- 
Constructor Details- 
LazyDynaClasspublic LazyDynaClass()Constructs a new LazyDynaClass with default parameters.
- 
LazyDynaClassConstructs a new LazyDynaClass with the specified name.- Parameters:
- name- Name of this DynaBean class
 
- 
LazyDynaClassConstructs a new LazyDynaClass with the specified name and DynaBean class.- Parameters:
- name- Name of this DynaBean class
- dynaBeanClass- The implementation class for new instances
 
- 
LazyDynaClassConstructs a new LazyDynaClass with the specified name, DynaBean class and properties.- Parameters:
- name- Name of this DynaBean class
- dynaBeanClass- The implementation class for new instances
- properties- Property descriptors for the supported properties
 
- 
LazyDynaClassConstructs a new LazyDynaClass with the specified name and properties.- Parameters:
- name- Name of this DynaBean class
- properties- Property descriptors for the supported properties
 
 
- 
- 
Method Details- 
addAdd a new dynamic property.- Parameters:
- property- Property the new dynamic property to add.
- Throws:
- IllegalArgumentException- if name is null
- IllegalStateException- if this DynaClass is currently restricted, so no new properties can be added
 
- 
addAdd a new dynamic property with no restrictions on data type, readability, or writeability.- Specified by:
- addin interface- MutableDynaClass
- Parameters:
- name- Name of the new dynamic property
- Throws:
- IllegalArgumentException- if name is null
- IllegalStateException- if this DynaClass is currently restricted, so no new properties can be added
 
- 
addAdd a new dynamic property with the specified data type, but with no restrictions on readability or writeability.- Specified by:
- addin interface- MutableDynaClass
- Parameters:
- name- Name of the new dynamic property
- type- Data type of the new dynamic property (null for no restrictions)
- Throws:
- IllegalArgumentException- if name is null
- IllegalStateException- if this DynaClass is currently restricted, so no new properties can be added
 
- 
addAdd a new dynamic property with the specified data type, readability, and writeability. N.B.Support for readable/writable 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 interface- MutableDynaClass
- Parameters:
- name- Name of the new dynamic property
- type- Data type of the new dynamic property (null for no restrictions)
- readable- Set to- trueif this property value should be readable
- writable- Set to- trueif this property value should be writable
- Throws:
- UnsupportedOperationException- anytime this method is called
 
- 
getDynaPropertyReturn a property descriptor for the specified property. If the property is not found and the returnNullindicator istrue</code>, this method always returns <code>null.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 behavior.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 interface- DynaClass
- Overrides:
- getDynaPropertyin class- BasicDynaClass
- 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
 
- 
isDynaPropertyIndicate 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, otherwise- false
- Throws:
- IllegalArgumentException- if no property name is specified
 
- 
isRestrictedIs 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 interface- MutableDynaClass
- Returns:
- trueif this- MutableDynaClasscannot be changed otherwise- false
 
- 
isReturnNullShould this DynaClass return anullfrom thegetDynaProperty(name)method if the property doesn't exist.- Returns:
- true</code> if a <code>null- DynaPropertyshould be returned if the property doesn't exist, otherwise- falseif a new- DynaPropertyshould be created.
 
- 
removeRemove 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 interface- MutableDynaClass
- Parameters:
- name- Name of the dynamic property to remove
- Throws:
- IllegalArgumentException- if name is null
- IllegalStateException- if this DynaClass is currently restricted, so no properties can be removed
 
- 
setRestrictedSet 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 interface- MutableDynaClass
- Parameters:
- restricted-- trueif this- MutableDynaClasscannot be changed otherwise- false
 
- 
setReturnNullSets whether this DynaClass should return anullfrom thegetDynaProperty(name)method if the property doesn't exist.- Parameters:
- returnNull-- true</code> if a <code>null- DynaPropertyshould be returned if the property doesn't exist, otherwise- falseif a new- DynaPropertyshould be created.
 
 
-