org.apache.commons.beanutils
public class LazyDynaMap extends LazyDynaBean implements MutableDynaClass
Provides a light weight DynaBean
facade to a Map
with lazy map/list processing.
Its a light weight DynaBean
implementation because there is no
actual DynaClass
associated with this DynaBean
- in fact
it implements the DynaClass
interface itself providing pseudo DynaClass
behaviour from the actual values stored in the Map
.
As well providing rhe standard DynaBean
access to the Map
's properties
this class also provides the usual Lazy behaviour:
DynaClass
Lists
or Arrays
) are automatically instantiated
and grown so that they are large enough to cater for the index being set.Restricted DynaClass
This class implements the MutableDynaClass
interface.
MutableDynaClass
have a facility to restrict the 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 Summary | |
---|---|
protected String | name
The name of this DynaClass (analogous to the
getName() method of java.lang.Class ). |
protected boolean | restricted
Controls whether changes to this DynaClass's properties are allowed. |
protected boolean | returnNull Controls whether the Default is |
Constructor Summary | |
---|---|
LazyDynaMap()
Default Constructor. | |
LazyDynaMap(String name)
Construct a new LazyDynaMap with the specified name.
| |
LazyDynaMap(Map values)
Construct a new LazyDynaMap with the specified Map .
| |
LazyDynaMap(String name, Map values)
Construct a new LazyDynaMap with the specified name and Map .
| |
LazyDynaMap(DynaProperty[] properties)
Construct a new LazyDynaMap with the specified properties.
| |
LazyDynaMap(String name, DynaProperty[] properties)
Construct a new LazyDynaMap with the specified name and properties.
| |
LazyDynaMap(DynaClass dynaClass)
Construct a new LazyDynaMap based on an exisiting DynaClass
|
Method Summary | |
---|---|
void | add(String name)
Add a new dynamic property with no restrictions on data type,
readability, or writeability.
|
void | add(String name, Class type)
Add a new dynamic property with the specified data type, but with
no restrictions on readability or writeability.
|
void | add(String name, Class type, boolean readable, boolean writeable) 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 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 |
protected void | add(DynaProperty property)
Add a new dynamic property.
|
DynaProperty[] | getDynaProperties() Return an array of |
DynaProperty | getDynaProperty(String name) Return a property descriptor for the specified property. If the property is not found and the If the property is not found and the |
Map | getMap()
Return the underlying Map backing this DynaBean |
String | getName()
Return the name of this DynaClass (analogous to the
getName() method of java.lang.Class |
protected boolean | isDynaProperty(String name) Indicate whether a property actually exists. N.B. Using |
boolean | isRestricted() Is this DynaClass currently restricted. If restricted, no changes to the existing registration of property names, data types, readability, or writeability are allowed. |
boolean | isReturnNull()
Should this DynaClass return a null from
the getDynaProperty(name) method if the property
doesn't exist.
|
DynaBean | newInstance()
Instantiate and return a new DynaBean instance, associated
with this DynaClass. |
void | remove(String name)
Remove the specified dynamic property, and any associated data type,
readability, and writeability, from this dynamic class.
|
void | set(String name, Object value)
Set the value of a simple property with the specified name.
|
void | setMap(Map values)
Set the Map backing this DynaBean
|
void | setRestricted(boolean restricted) 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. |
void | setReturnNull(boolean returnNull)
Set whether this DynaClass should return a null from
the getDynaProperty(name) method if the property
doesn't exist.
|
getName()
method of java.lang.Class
).Controls whether the getDynaProperty()
method returns
null if a property doesn't exist - or creates a new one.
Default is false
.
LazyDynaMap
with the specified name.
Parameters: name Name of this DynaBean class
LazyDynaMap
with the specified Map
.
Parameters: values The Map backing this LazyDynaMap
LazyDynaMap
with the specified name and Map
.
Parameters: name Name of this DynaBean class values The Map backing this LazyDynaMap
LazyDynaMap
with the specified properties.
Parameters: properties Property descriptors for the supported properties
LazyDynaMap
with the specified name and properties.
Parameters: name Name of this DynaBean class properties Property descriptors for the supported properties
LazyDynaMap
based on an exisiting DynaClass
Parameters: dynaClass DynaClass to copy the name and properties from
Parameters: name Name of the new dynamic property
Throws: IllegalArgumentException if name is null
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
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 DynaProperty
class
(which they are not) and is the reason this method has not been implemented.
Parameters: name Name of the new dynamic property type Data type of the new dynamic property (null for no
restrictions) readable Set to true
if this property value
should be readable writeable Set to true
if this property value
should be writeable
Throws: UnsupportedOperationException anytime this method is called
Parameters: property Property the new dynamic property to add.
Throws: IllegalArgumentException if name is null
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?
Returns: the set of properties for this DynaClass
Return a property descriptor for the specified property.
If the property is not found and the returnNull
indicator is
true
, this method always returns null
.
If the property is not found and the returnNull
indicator is
false
a 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 null
property descriptor is that
BeanUtils
uses 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, returning null
from
this method would defeat their purpose.
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
DynaBean
Returns: the underlying Map
Since: 1.8.0
getName()
method of java.lang.Class
Returns: the name of the DynaClass
Indicate whether a property actually exists.
N.B. Using getDynaProperty(name) == null
doesn't work in this implementation because that method might
return a DynaProperty if it doesn't exist (depending on the
returnNull
indicator).
Parameters: name Name of the dynamic property
Returns: true
if the property exists,
otherwise false
Throws: IllegalArgumentException if no property name is specified
Is this DynaClass currently restricted.
If restricted, no changes to the existing registration of property names, data types, readability, or writeability are allowed.
Returns: true
if this Mutable DynaClass is restricted,
otherwise false
null
from
the getDynaProperty(name)
method if the property
doesn't exist.
Returns: true
if a
null
DynaProperty
should be returned if the property doesn't exist, otherwise
false
if a new DynaProperty should be created.
Returns: A new DynaBean
instance
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
Parameters: name Name of the property whose value is to be set value Value to which this property is to be set
DynaBean
Parameters: values The new Map of values
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.
Parameters: restricted The new restricted state
null
from
the getDynaProperty(name)
method if the property
doesn't exist.
Parameters: returnNull true
if a
null
DynaProperty
should be returned if the property doesn't exist, otherwise
false
if a new DynaProperty should be created.