Package org.apache.commons.beanutils2

# Class LazyDynaClass

java.lang.Object
org.apache.commons.beanutils2.BasicDynaClass
org.apache.commons.beanutils2.LazyDynaClass

All Implemented Interfaces:
  `DynaClass`, `MutableDynaClass`

public class LazyDynaClass extends BasicDynaClass implements 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:
  - `LazyDynaBean`

- ## Field Summary

  Fields
  Modifier and Type
  Field
  Description
  `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.

  ### Fields inherited from class org.apache.commons.beanutils2.BasicDynaClass

  `constructor, constructorValues, dynaBeanClass, name, properties, propertiesMap`

- ## Constructor Summary

  Constructors
  Constructor
  Description
  `LazyDynaClass()`
  Constructs 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 Summary

  Modifier and Type
  Method
  Description
  `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 writable)`
  Add a new dynamic property with the specified data type, readability, and writeability.
  `protected void`
  `add(DynaProperty property)`
  Add a new dynamic property.
  `DynaProperty`
  `getDynaProperty(String name)`
  Return a property descriptor for the specified property.
  `boolean`
  `isDynaProperty(String name)`
  Indicate whether a property actually exists.
  `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.
  `void`
  `remove(String name)`
  Remove the specified dynamic property, and any associated data type, readability, and writeability, from this dynamic class.
  `void`
  `setRestricted(boolean restricted)`
  Set whether this DynaClass is currently restricted.
  `void`
  `setReturnNull(boolean returnNull)`
  Sets whether this DynaClass should return a `null` from the `getDynaProperty(name)` method if the property doesn't exist.

  ### Methods inherited from class org.apache.commons.beanutils2.BasicDynaClass

  `getDynaBeanClass, getDynaProperties, getName, newInstance, setDynaBeanClass, setProperties`

  ### Methods inherited from class java.lang.Object

  `clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

  ### Methods inherited from interface org.apache.commons.beanutils2.DynaClass

  `getDynaProperties, getName, newInstance`

- ## Field Details

  - ### 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 Details

  - ### LazyDynaClass

    public LazyDynaClass()
    Constructs a new LazyDynaClass with default parameters.

  - ### LazyDynaClass

    public LazyDynaClass(String name)
    Constructs a new LazyDynaClass with the specified name.
    Parameters:
      `name` - Name of this DynaBean class

  - ### LazyDynaClass

    public LazyDynaClass(String name, Class<?> dynaBeanClass)
    Constructs a new LazyDynaClass with the specified name and DynaBean class.
    Parameters:
      `name` - Name of this DynaBean class
      `dynaBeanClass` - The implementation class for new instances

  - ### LazyDynaClass

    public LazyDynaClass(String name, Class<?> dynaBeanClass, DynaProperty[] properties)
    Constructs 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

  - ### LazyDynaClass

    public LazyDynaClass(String name, DynaProperty[] properties)
    Constructs 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

  - ### add

    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
      `IllegalStateException` - if this DynaClass is currently restricted, so no new properties can be added

  - ### add

    public void add(String name)
    Add a new dynamic property with no restrictions on data type, readability, or writeability.
    Specified by:
      `add` in 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

  - ### add

    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.
    Specified by:
      `add` in 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

  - ### add

    public void add(String name, Class<?> type, boolean readable, boolean writable)

    Add 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 `DynaProperty` class (which they are not) and is the reason this method has not been implemented.

    Specified by:
      `add` in 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 `true` if this property value should be readable
      `writable` - Set to `true` if this property value should be writable
    Throws:
      `UnsupportedOperationException` - anytime this method is called

  - ### getDynaProperty

    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</code>, this method always returns <code>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 behavior.

    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 Lazy implementations automatically add any new properties when they are set, returning `null` from this method would defeat their purpose.

    Specified by:
      `getDynaProperty` in interface `DynaClass`
    Overrides:
      `getDynaProperty` in 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

  - ### isDynaProperty

    public 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` - The name of the property to check
    Returns:
      `true` if there is a property of the specified name, otherwise `false`
    Throws:
      `IllegalArgumentException` - if no property name is specified

  - ### 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 interface `MutableDynaClass`
    Returns:
      `true` if this `MutableDynaClass` cannot be changed otherwise `false`

  - ### isReturnNull

    public boolean isReturnNull()
    Should this DynaClass return a `null` from the `getDynaProperty(name)` method if the property doesn't exist.
    Returns:
      `true</code> if a <code>null` `DynaProperty` should be returned if the property doesn't exist, otherwise `false` if a new `DynaProperty` should be created.

  - ### remove

    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.
    Specified by:
      `remove` in 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

  - ### 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 interface `MutableDynaClass`
    Parameters:
      `restricted` - `true` if this `MutableDynaClass` cannot be changed otherwise `false`

  - ### setReturnNull

    public void setReturnNull(boolean returnNull)
    Sets whether this DynaClass should return a `null` from the `getDynaProperty(name)` method if the property doesn't exist.
    Parameters:
      `returnNull` - `true</code> if a <code>null` `DynaProperty` should be returned if the property doesn't exist, otherwise `false` if a new `DynaProperty` should be created.