Class LazyDynaMap
- java.lang.Object
-
- org.apache.commons.beanutils.LazyDynaBean
-
- org.apache.commons.beanutils.LazyDynaMap
-
- All Implemented Interfaces:
java.io.Serializable
,DynaBean
,DynaClass
,MutableDynaClass
public class LazyDynaMap extends LazyDynaBean implements MutableDynaClass
Provides a light weight
DynaBean
facade to aMap
with lazy map/list processing.Its a light weight
DynaBean
implementation because there is no actualDynaClass
associated with thisDynaBean
- in fact it implements theDynaClass
interface itself providing pseudo DynaClass behaviour from the actual values stored in theMap
.As well providing rhe standard
DynaBean
access to theMap
's properties this class also provides the usual Lazy behaviour:- Properties don't need to be pre-defined in a
DynaClass
- Indexed properties (
Lists
orArrays
) 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
have a facility to restrict theDynaClass
so that its properties cannot be modified. If theMutableDynaClass
is restricted then calling any of theset()
methods for a property which doesn't exist will result in aIllegalArgumentException
being thrown.- Version:
- $Id: LazyDynaMap.java 1540509 2013-11-10 18:39:11Z oheger $
- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description protected java.lang.String
name
The name of this DynaClass (analogous to thegetName()
method ofjava.lang.Class
).protected boolean
restricted
Controls whether changes to this DynaClass's properties are allowed.protected boolean
returnNull
Controls whether thegetDynaProperty()
method returns null if a property doesn't exist - or creates a new one.-
Fields inherited from class org.apache.commons.beanutils.LazyDynaBean
BigDecimal_ZERO, BigInteger_ZERO, Byte_ZERO, Character_SPACE, Double_ZERO, dynaClass, Float_ZERO, Integer_ZERO, Long_ZERO, Short_ZERO, values
-
-
Constructor Summary
Constructors Constructor Description LazyDynaMap()
Default Constructor.LazyDynaMap(java.lang.String name)
Construct a newLazyDynaMap
with the specified name.LazyDynaMap(java.lang.String name, java.util.Map<java.lang.String,java.lang.Object> values)
Construct a newLazyDynaMap
with the specified name andMap
.LazyDynaMap(java.lang.String name, DynaProperty[] properties)
Construct a newLazyDynaMap
with the specified name and properties.LazyDynaMap(java.util.Map<java.lang.String,java.lang.Object> values)
Construct a newLazyDynaMap
with the specifiedMap
.LazyDynaMap(DynaClass dynaClass)
Construct a newLazyDynaMap
based on an exisiting DynaClassLazyDynaMap(DynaProperty[] properties)
Construct a newLazyDynaMap
with the specified properties.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
add(java.lang.String name)
Add a new dynamic property with no restrictions on data type, readability, or writeability.void
add(java.lang.String name, java.lang.Class<?> type)
Add a new dynamic property with the specified data type, but with no restrictions on readability or writeability.void
add(java.lang.String name, java.lang.Class<?> type, boolean readable, boolean writeable)
Add a new dynamic property with the specified data type, readability, and writeability.protected void
add(DynaProperty property)
Add a new dynamic property.DynaProperty[]
getDynaProperties()
Return an array ofProperyDescriptors
for the properties currently defined in this DynaClass.DynaProperty
getDynaProperty(java.lang.String name)
Return a property descriptor for the specified property.java.util.Map<java.lang.String,java.lang.Object>
getMap()
Return the underlying Map backing thisDynaBean
java.lang.String
getName()
Return the name of this DynaClass (analogous to thegetName()
method ofjava.lang.Class
)protected boolean
isDynaProperty(java.lang.String name)
Indicate whether a property actually exists.boolean
isRestricted()
Is this DynaClass currently restricted.boolean
isReturnNull()
Should this DynaClass return anull
from thegetDynaProperty(name)
method if the property doesn't exist.DynaBean
newInstance()
Instantiate and return a new DynaBean instance, associated with this DynaClass.void
remove(java.lang.String name)
Remove the specified dynamic property, and any associated data type, readability, and writeability, from this dynamic class.void
set(java.lang.String name, java.lang.Object value)
Set the value of a simple property with the specified name.void
setMap(java.util.Map<java.lang.String,java.lang.Object> values)
Set the Map backing thisDynaBean
void
setRestricted(boolean restricted)
Set whether this DynaClass is currently restricted.void
setReturnNull(boolean returnNull)
Set whether this DynaClass should return anull
from thegetDynaProperty(name)
method if the property doesn't exist.-
Methods inherited from class org.apache.commons.beanutils.LazyDynaBean
contains, createDynaBeanProperty, createIndexedProperty, createMappedProperty, createNumberProperty, createOtherProperty, createPrimitiveProperty, createProperty, defaultIndexedProperty, defaultMappedProperty, get, get, get, getDynaClass, growIndexedProperty, isAssignable, newMap, remove, set, set, size
-
-
-
-
Field Detail
-
name
protected java.lang.String name
The name of this DynaClass (analogous to thegetName()
method ofjava.lang.Class
).
-
restricted
protected boolean restricted
Controls whether changes to this DynaClass's properties are allowed.
-
returnNull
protected boolean returnNull
Controls whether the
getDynaProperty()
method returns null if a property doesn't exist - or creates a new one.Default is
false
.
-
-
Constructor Detail
-
LazyDynaMap
public LazyDynaMap()
Default Constructor.
-
LazyDynaMap
public LazyDynaMap(java.lang.String name)
Construct a newLazyDynaMap
with the specified name.- Parameters:
name
- Name of this DynaBean class
-
LazyDynaMap
public LazyDynaMap(java.util.Map<java.lang.String,java.lang.Object> values)
Construct a newLazyDynaMap
with the specifiedMap
.- Parameters:
values
- The Map backing thisLazyDynaMap
-
LazyDynaMap
public LazyDynaMap(java.lang.String name, java.util.Map<java.lang.String,java.lang.Object> values)
Construct a newLazyDynaMap
with the specified name andMap
.- Parameters:
name
- Name of this DynaBean classvalues
- The Map backing thisLazyDynaMap
-
LazyDynaMap
public LazyDynaMap(DynaProperty[] properties)
Construct a newLazyDynaMap
with the specified properties.- Parameters:
properties
- Property descriptors for the supported properties
-
LazyDynaMap
public LazyDynaMap(java.lang.String name, DynaProperty[] properties)
Construct a newLazyDynaMap
with the specified name and properties.- Parameters:
name
- Name of this DynaBean classproperties
- Property descriptors for the supported properties
-
LazyDynaMap
public LazyDynaMap(DynaClass dynaClass)
Construct a newLazyDynaMap
based on an exisiting DynaClass- Parameters:
dynaClass
- DynaClass to copy the name and properties from
-
-
Method Detail
-
setMap
public void setMap(java.util.Map<java.lang.String,java.lang.Object> values)
Set the Map backing thisDynaBean
- Parameters:
values
- The new Map of values
-
getMap
public java.util.Map<java.lang.String,java.lang.Object> getMap()
Return the underlying Map backing thisDynaBean
- Overrides:
getMap
in classLazyDynaBean
- Returns:
- the underlying Map
- Since:
- 1.8.0
-
set
public void set(java.lang.String name, java.lang.Object value)
Set the value of a simple property with the specified name.- Specified by:
set
in interfaceDynaBean
- Overrides:
set
in classLazyDynaBean
- Parameters:
name
- Name of the property whose value is to be setvalue
- Value to which this property is to be set
-
getName
public java.lang.String getName()
Return the name of this DynaClass (analogous to thegetName()
method ofjava.lang.Class
)
-
getDynaProperty
public DynaProperty getDynaProperty(java.lang.String name)
Return a property descriptor for the specified property.
If the property is not found and the
returnNull
indicator istrue
, this method always returnsnull
.If the property is not found and the
returnNull
indicator isfalse
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 thatBeanUtils
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, returningnull
from this method would defeat their purpose.- Specified by:
getDynaProperty
in interfaceDynaClass
- Parameters:
name
- Name of the dynamic property for which a descriptor is requested- Returns:
- The descriptor for the specified property
- Throws:
java.lang.IllegalArgumentException
- if no property name is specified
-
getDynaProperties
public DynaProperty[] getDynaProperties()
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?- Specified by:
getDynaProperties
in interfaceDynaClass
- Returns:
- the set of properties for this DynaClass
-
newInstance
public DynaBean newInstance()
Instantiate and return a new DynaBean instance, associated with this DynaClass.- Specified by:
newInstance
in interfaceDynaClass
- Returns:
- A new
DynaBean
instance
-
isRestricted
public 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.
- Specified by:
isRestricted
in interfaceMutableDynaClass
- Returns:
true
if this MutableDynaClass
is restricted, otherwisefalse
-
setRestricted
public 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.
- Specified by:
setRestricted
in interfaceMutableDynaClass
- Parameters:
restricted
- The new restricted state
-
add
public void add(java.lang.String name)
Add a new dynamic property with no restrictions on data type, readability, or writeability.- Specified by:
add
in interfaceMutableDynaClass
- Parameters:
name
- Name of the new dynamic property- Throws:
java.lang.IllegalArgumentException
- if name is null
-
add
public void add(java.lang.String name, java.lang.Class<?> type)
Add a new dynamic property with the specified data type, but with no restrictions on readability or writeability.- Specified by:
add
in interfaceMutableDynaClass
- Parameters:
name
- Name of the new dynamic propertytype
- Data type of the new dynamic property (null for no restrictions)- Throws:
java.lang.IllegalArgumentException
- if name is nulljava.lang.IllegalStateException
- if this DynaClass is currently restricted, so no new properties can be added
-
add
public void add(java.lang.String name, java.lang.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
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.- Specified by:
add
in interfaceMutableDynaClass
- Parameters:
name
- Name of the new dynamic propertytype
- Data type of the new dynamic property (null for no restrictions)readable
- Set totrue
if this property value should be readablewriteable
- Set totrue
if this property value should be writeable- Throws:
java.lang.UnsupportedOperationException
- anytime this method is called
-
add
protected void add(DynaProperty property)
Add a new dynamic property.- Parameters:
property
- Property the new dynamic property to add.- Throws:
java.lang.IllegalArgumentException
- if name is null
-
remove
public void remove(java.lang.String name)
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:
remove
in interfaceMutableDynaClass
- Parameters:
name
- Name of the dynamic property to remove- Throws:
java.lang.IllegalArgumentException
- if name is nulljava.lang.IllegalStateException
- if this DynaClass is currently restricted, so no properties can be removed
-
isReturnNull
public boolean isReturnNull()
Should this DynaClass return anull
from thegetDynaProperty(name)
method if the property doesn't exist.- Returns:
true
if anull
DynaProperty
should be returned if the property doesn't exist, otherwisefalse
if a newDynaProperty
should be created.
-
setReturnNull
public void setReturnNull(boolean returnNull)
Set whether this DynaClass should return anull
from thegetDynaProperty(name)
method if the property doesn't exist.- Parameters:
returnNull
-true
if anull
DynaProperty
should be returned if the property doesn't exist, otherwisefalse
if a newDynaProperty
should be created.
-
isDynaProperty
protected boolean isDynaProperty(java.lang.String name)
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 thereturnNull
indicator).- Overrides:
isDynaProperty
in classLazyDynaBean
- Parameters:
name
- Name of the dynamic property- Returns:
true
if the property exists, otherwisefalse
- Throws:
java.lang.IllegalArgumentException
- if no property name is specified
-
-