Class LazyDynaMap
- All Implemented Interfaces:
- DynaBean,- DynaClass,- MutableDynaClass
 Provides a light weight DynaBean</code> facade to a <code>Map
  with lazy map/list processing.
Its a light weight DynaBean implementation because there is no
    actual DynaClass</code> associated with this <code>DynaBean - in fact
    it implements the DynaClass interface itself providing pseudo DynaClass
    behavior from the actual values stored in the Map.
As well providing rhe standard DynaBean</code> access to the <code>Map's properties
    this class also provides the usual Lazy behavior:
- Properties don't need to be pre-defined in a DynaClass
- Indexed properties (Lists</code> or <code>Arrays) are automatically instantiated and grown so that they are large enough to cater for the index being set.
- Mapped properties are automatically instantiated.
Restricted DynaClass
This class implements the MutableDynaClass interface.
       MutableDynaClass</code> have a facility to <em>restrict</em> the <code>DynaClass so that its properties cannot be modified. If the
 MutableDynaClass is restricted then calling any of the set() methods for a property which doesn't exist will result in a
 IllegalArgumentException being thrown.
 
- 
Field SummaryFieldsModifier and TypeFieldDescriptionprotected StringThe name of this DynaClass (analogous to thegetName()</code> method of <code>java.lang.Class).protected 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.LazyDynaBeanBigDecimal_ZERO, BigInteger_ZERO, Byte_ZERO, Character_SPACE, Double_ZERO, dynaClass, Float_ZERO, Integer_ZERO, Long_ZERO, Short_ZERO, values
- 
Constructor SummaryConstructorsConstructorDescriptionConstructs a new instance.LazyDynaMap(String name) Constructs a newLazyDynaMapwith the specified name.LazyDynaMap(String name, Map<String, Object> values) Constructs a newLazyDynaMap</code> with the specified name and <code>Map.LazyDynaMap(String name, DynaProperty[] properties) Constructs a newLazyDynaMapwith the specified name and properties.LazyDynaMap(Map<String, Object> values) Constructs a newLazyDynaMap</code> with the specified <code>Map.LazyDynaMap(DynaClass dynaClass) Constructs a newLazyDynaMapbased on an exisiting DynaClassLazyDynaMap(DynaProperty[] properties) Constructs a newLazyDynaMapwith the specified 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.Return an array ofPropertyDescriptorfor the properties currently defined in this DynaClass.getDynaProperty(String name) Return a property descriptor for the specified property.getMap()Gets the underlying Map backing thisDynaBeangetName()Gets the name of this DynaClass (analogous to thegetName()</code> method of <code>java.lang.Class)protected 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.Instantiate and return a new DynaBean instance, associated with this DynaClass.voidRemove the specified dynamic property, and any associated data type, readability, and writeability, from this dynamic class.voidSets the value of a simple property with the specified name.voidSets the Map backing thisDynaBeanvoidsetRestricted(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.LazyDynaBeancontains, createDynaBeanProperty, createIndexedProperty, createMappedProperty, createNumberProperty, createOtherProperty, createPrimitiveProperty, createProperty, defaultIndexedProperty, defaultMappedProperty, get, get, get, getDynaClass, growIndexedProperty, isAssignable, newMap, remove, set, set, size
- 
Field Details- 
nameThe name of this DynaClass (analogous to thegetName()</code> method of <code>java.lang.Class).
- 
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- 
LazyDynaMappublic LazyDynaMap()Constructs a new instance.
- 
LazyDynaMapConstructs a newLazyDynaMapbased on an exisiting DynaClass- Parameters:
- dynaClass- DynaClass to copy the name and properties from
 
- 
LazyDynaMapConstructs a newLazyDynaMapwith the specified properties.- Parameters:
- properties- Property descriptors for the supported properties
 
- 
LazyDynaMapConstructs a newLazyDynaMap</code> with the specified <code>Map.- Parameters:
- values- The Map backing this- LazyDynaMap
 
- 
LazyDynaMapConstructs a newLazyDynaMapwith the specified name.- Parameters:
- name- Name of this DynaBean class
 
- 
LazyDynaMapConstructs a newLazyDynaMapwith the specified name and properties.- Parameters:
- name- Name of this DynaBean class
- properties- Property descriptors for the supported properties
 
- 
LazyDynaMapConstructs a newLazyDynaMap</code> with the specified name and <code>Map.- Parameters:
- name- Name of this DynaBean class
- values- The Map backing this- LazyDynaMap
 
 
- 
- 
Method Details- 
addAdd a new dynamic property.- Parameters:
- property- Property the new dynamic property to add.
- Throws:
- IllegalArgumentException- if name is null
 
- 
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
 
- 
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
 
- 
getDynaPropertiesReturn an array of PropertyDescriptorfor 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:
- getDynaPropertiesin interface- DynaClass
- Returns:
- the set of properties for this DynaClass
 
- 
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 Map implementations automatically add any new properties when they are set, returningnullfrom this method would defeat their purpose.- Specified by:
- getDynaPropertyin interface- DynaClass
- Parameters:
- name- Name of the dynamic property for which a descriptor is requested
- Returns:
- The descriptor for the specified property
- Throws:
- IllegalArgumentException- if no property name is specified
 
- 
getMapGets the underlying Map backing thisDynaBean- Overrides:
- getMapin class- LazyDynaBean
- Returns:
- the underlying Map
- Since:
- 1.8.0
 
- 
getNameGets the name of this DynaClass (analogous to thegetName()</code> method of <code>java.lang.Class)
- 
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).- Overrides:
- isDynaPropertyin class- LazyDynaBean
- Parameters:
- name- Name of the dynamic property
- Returns:
- trueif the property exists, 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 Mutable- DynaClassis restricted, 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.
 
- 
newInstanceInstantiate and return a new DynaBean instance, associated with this DynaClass.- Specified by:
- newInstancein interface- DynaClass
- Returns:
- A new DynaBeaninstance
 
- 
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
 
- 
setSets the value of a simple property with the specified name.- Specified by:
- setin interface- DynaBean
- Overrides:
- setin class- LazyDynaBean
- Parameters:
- name- Name of the property whose value is to be set
- value- Value to which this property is to be set
 
- 
setMapSets the Map backing thisDynaBean- Parameters:
- values- The new Map of values
 
- 
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- The new restricted state
 
- 
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.
 
 
-