public class

LazyDynaMap

extends LazyDynaBean
implements MutableDynaClass

java.lang.Object
↳	org.apache.commons.beanutils.LazyDynaBean
	↳	org.apache.commons.beanutils.LazyDynaMap

Class Overview

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:

Properties don't need to be pre-defined in a DynaClass
Indexed properties (Lists or 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 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.

Summary

Fields
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 `getDynaProperty()` method returns null if a property doesn't exist - or creates a new one.

[Expand]

Inherited Fields

From class org.apache.commons.beanutils.LazyDynaBean

Public Constructors
	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

Public Methods
void	add(String name, Class type, boolean readable, boolean writeable) Add a new dynamic property with the specified data type, readability, and 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) Add a new dynamic property with no restrictions on data type, readability, or writeability.
DynaProperty[]	getDynaProperties() Return an array of `ProperyDescriptors` for the properties currently defined in this DynaClass.
DynaProperty	getDynaProperty(String name) Return a property descriptor for the specified property.
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`
boolean	isRestricted() Is this DynaClass currently restricted.
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.
void	setReturnNull(boolean returnNull) Set whether this DynaClass should return a `null` from the `getDynaProperty(name)` method if the property doesn't exist.

Protected Methods
void	add(DynaProperty property) Add a new dynamic property.
boolean	isDynaProperty(String name) Indicate whether a property actually exists.

[Expand]

Inherited Methods

From class org.apache.commons.beanutils.LazyDynaBean

boolean	contains(String name, String key) Does the specified mapped property contain a value for the specified key value?
Object	createDynaBeanProperty(String name, Class type) Create a new Instance of a 'DynaBean' Property.
Object	createIndexedProperty(String name, Class type) Create a new Instance of an 'Indexed' Property
Object	createMappedProperty(String name, Class type) Create a new Instance of a 'Mapped' Property
Object	createNumberProperty(String name, Class type) Create a new Instance of a `java.lang.Number` Property.
Object	createOtherProperty(String name, Class type) Create a new Instance of other Property types
Object	createPrimitiveProperty(String name, Class type) Create a new Instance of a 'Primitive' Property.
Object	createProperty(String name, Class type) Create a new Instance of a Property
Object	defaultIndexedProperty(String name) Creates a new `ArrayList` for an 'indexed' property which doesn't exist.
Map	defaultMappedProperty(String name) Creates a new `HashMap` for a 'mapped' property which doesn't exist.
Object	get(String name, int index) Return the value of an indexed property with the specified name.
Object	get(String name, String key) Return the value of a mapped property with the specified name.
Object	get(String name) Return the value of a simple property with the specified name.
DynaClass	getDynaClass() Return the `DynaClass` instance that describes the set of properties available for this DynaBean.
Map	getMap() Return a Map representation of this DynaBean.
Object	growIndexedProperty(String name, Object indexedProperty, int index) Grow the size of an indexed property
boolean	isAssignable(Class dest, Class source) Is an object of the source class assignable to the destination class?
boolean	isDynaProperty(String name) Indicates if there is a property with the specified name.
Map	newMap() Creates a new instance of the `Map`.
void	remove(String name, String key) Remove any existing value for the specified key on the specified mapped property.
void	set(String name, int index, Object value) Set the value of an indexed property with the specified name.
void	set(String name, String key, Object value) Set the value of a mapped property with the specified name.
void	set(String name, Object value) Set the value of a simple property with the specified name.
int	size(String name) Return the size of an indexed or mapped property.

From class java.lang.Object

From interface org.apache.commons.beanutils.DynaBean

abstract boolean	contains(String name, String key) Does the specified mapped property contain a value for the specified key value?
abstract Object	get(String name) Return the value of a simple property with the specified name.
abstract Object	get(String name, int index) Return the value of an indexed property with the specified name.
abstract Object	get(String name, String key) Return the value of a mapped property with the specified name, or `null` if there is no value for the specified key.
abstract DynaClass	getDynaClass() Return the `DynaClass` instance that describes the set of properties available for this DynaBean.
abstract void	remove(String name, String key) Remove any existing value for the specified key on the specified mapped property.
abstract void	set(String name, String key, Object value) Set the value of a mapped property with the specified name.
abstract void	set(String name, int index, Object value) Set the value of an indexed property with the specified name.
abstract void	set(String name, Object value) Set the value of a simple property with the specified name.

From interface org.apache.commons.beanutils.DynaClass

From interface org.apache.commons.beanutils.MutableDynaClass

Fields

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 getDynaProperty() method returns null if a property doesn't exist - or creates a new one.

Default is false.

Public Constructors

public LazyDynaMap ()

Default Constructor.

public LazyDynaMap (String name)

Construct a new LazyDynaMap with the specified name.

Parameters

name	Name of this DynaBean class

public LazyDynaMap (Map values)

Construct a new LazyDynaMap with the specified Map.

Parameters

values	The Map backing this `LazyDynaMap`

public LazyDynaMap (String name, Map values)

Construct a new LazyDynaMap with the specified name and Map.

Parameters

name	Name of this DynaBean class
values	The Map backing this `LazyDynaMap`

public LazyDynaMap (DynaProperty[] properties)

Construct a new LazyDynaMap with the specified properties.

Parameters

properties	Property descriptors for the supported properties

public LazyDynaMap (String name, DynaProperty[] properties)

Construct a new LazyDynaMap with the specified name and properties.

Parameters

name	Name of this DynaBean class
properties	Property descriptors for the supported properties

public LazyDynaMap (DynaClass dynaClass)

Construct a new LazyDynaMap based on an exisiting DynaClass

Parameters

dynaClass	DynaClass to copy the name and properties from

Public Methods

public 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 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

public void add (String name, Class type)

Add a new dynamic property with the specified data type, but with no restrictions on readability or writeability.

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

public void add (String name)

Add a new dynamic property with no restrictions on data type, readability, or writeability.

Parameters

name	Name of the new dynamic property

Throws

IllegalArgumentException	if name is null

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?

Returns

the set of properties for this DynaClass

public DynaProperty getDynaProperty (String name)

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

public Map getMap ()

Return the underlying Map backing this DynaBean

Returns

the underlying Map

public String getName ()

Return the name of this DynaClass (analogous to the getName() method of java.lang.Class


  
      Returns
      the name of the DynaClass






 
    
      
        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.

  
      Returns
      true if this Mutable DynaClass is restricted,
 otherwise false

  

    





 
    
      
        public 
         
         
         
         
        boolean
      
      isReturnNull
      ()
    
      
        


        
  

      
    
      
  Should this DynaClass return a 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.

  


    






 
    
      
        public 
         
         
         
         
        DynaBean
      
      newInstance
      ()
    
      
        


        
  

      
    
      
  Instantiate and return a new DynaBean instance, associated
 with this DynaClass.
  
      Returns
      A new DynaBean instance

  

    





 
    
      
        public 
         
         
         
         
        void
      
      remove
      (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.
  
      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

        
      
  

    





 
    
      
        public 
         
         
         
         
        void
      
      set
      (String name, Object value)
    
      
        


        
  

      
    
      
  Set the value of a simple property with the specified name.
  
      Parameters
      
        
          name
          Name of the property whose value is to be set
        
        
          value
          Value to which this property is to be set

        
      
  

    





 
    
      
        public 
         
         
         
         
        void
      
      setMap
      (Map values)
    
      
        


        
  

      
    
      
  Set the Map backing this DynaBean
  
      Parameters
      
        
          values
          The new Map of values

        
      
  

    





 
    
      
        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.

  
      Parameters
      
        
          restricted
          The new restricted state

        
      
  

    





 
    
      
        public 
         
         
         
         
        void
      
      setReturnNull
      (boolean returnNull)
    
      
        


        
  

      
    
      
  Set whether this DynaClass should return a 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.

        
      
  

    








Protected Methods





 
    
      
        protected 
         
         
         
         
        void
      
      add
      (DynaProperty property)
    
      
        


        
  

      
    
      
  Add a new dynamic property.
  
      Parameters
      
        
          property
          Property the new dynamic property to add.
        
      
  
  
      Throws
        
        
            IllegalArgumentException
            if name is null

        
      
  

    





 
    
      
        protected 
         
         
         
         
        boolean
      
      isDynaProperty
      (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 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

        
      
  

    










Generated by Doclava.

name	Name of the property whose value is to be set
value	Value to which this property is to be set

Interfaces

Classes

Exceptions

LazyDynaMap

Class Overview

Summary

Fields

protected String name

protected boolean restricted

protected boolean returnNull

Public Constructors

public LazyDynaMap ()

public LazyDynaMap (String name)

Parameters

public LazyDynaMap (Map values)

Parameters

public LazyDynaMap (String name, Map values)

Parameters

public LazyDynaMap (DynaProperty[] properties)

Parameters

public LazyDynaMap (String name, DynaProperty[] properties)

Parameters

public LazyDynaMap (DynaClass dynaClass)

Parameters

Public Methods

public void add (String name, Class type, boolean readable, boolean writeable)

Parameters

Throws

public void add (String name, Class type)

Parameters

Throws

public void add (String name)

Parameters

Throws

public DynaProperty[] getDynaProperties ()

Returns

public DynaProperty getDynaProperty (String name)

Parameters

Returns

Throws

public Map getMap ()

Returns

public String getName ()

Returns

public boolean isRestricted ()

Returns

public boolean isReturnNull ()

Returns

public DynaBean newInstance ()

Returns

public void remove (String name)

Parameters

Throws

public void set (String name, Object value)

Parameters

public void setMap (Map values)

Parameters

public void setRestricted (boolean restricted)

Parameters

public void setReturnNull (boolean returnNull)

Parameters

Protected Methods

protected void add (DynaProperty property)

Parameters

Throws

protected boolean isDynaProperty (String name)

Parameters

Returns

Throws