All Superinterfaces:

MarshallableObject, Marshaller<Object>, Marshalling<Object>, MarshallingObject, ReadableBean, UnmarshallableObject, Unmarshaller<Object>, Validatable

All Known Subinterfaces:

EntityBean, VirtualBean

All Known Implementing Classes:

AbstractBean, AbstractVirtualBean, AdvancedBean, Bean, DynamicBean, SimpleEntityBean
```
public interface WritableBean
extends ReadableBean, MarshallingObject
```
Writable interface of ReadableBean.

Field Summary
- Fields inherited from interface io.github.mmm.bean.ReadableBean
  PROPERTY_TYPE

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method	Description
`<P extends WritableProperty<?>> P`	`addProperty(P property)`	Adds the given `WritableProperty` to this bean.
`default <V> WritableProperty<V>`	`createProperty(String name, Class<V> valueClass)`	Creates and `adds` a `WritableProperty` with the given `value class` dynamically.
`<V> WritableProperty<V>`	`createProperty(String name, Class<V> valueClass, Type valueType)`	Creates and `adds` a `WritableProperty` with the given `value class` dynamically.
`default <V> WritableProperty<V>`	`getOrCreateProperty(String name, Class<V> valueClass)`	`Gets` or `creates` the specified property.
`default <V> WritableProperty<V>`	`getOrCreateProperty(String name, Class<V> valueClass, Type valueType)`	`Gets` or `creates` the specified property.
`Iterable<? extends WritableProperty<?>>`	`getProperties()`
`WritableProperty<?>`	`getProperty(String name)`
`default WritableProperty<?>`	`getRequiredProperty(String name)`
`default void`	`read(StructuredReader reader)`
`default void`	`set(String name, Object value)`	Sets the value of the `required property` with the given `name` to the given value.
`default <V> void`	`set(String name, V value, Class<V> valueClass)`	/** Sets the value of the `existing or newly created property` with the given `name` to the given value.
`default <V> void`	`set(String name, V value, Class<V> valueClass, Type valueType)`	/** Sets the value of the `existing or newly created property` with the given `name` to the given value.

Methods inherited from interface io.github.mmm.marshall.MarshallableObject
writeObject

Methods inherited from interface io.github.mmm.bean.ReadableBean
copy, copy, get, getPropertyCount, getPropertyNameForAlias, getType, isDynamic, isEqualTo, isPolymorphic, isPrototype, isReadOnly, newInstance, validate, write

Methods inherited from interface io.github.mmm.marshall.UnmarshallableObject
readObject

- Method Detail
  - getProperty
```
WritableProperty<?> getProperty(String name)
```
    Specified by:
    
    getProperty in interface ReadableBean
    
    Parameters:
    
    name - the name of the requested property or a potential alias of the property.
    
    Returns:
    
    the requested WritableProperty or null if no such property exists.
    
    See Also:
    
    addProperty(WritableProperty), getOrCreateProperty(String, Class)
  - getProperties
```
Iterable<? extends WritableProperty<?>> getProperties()
```
    Specified by:
    
    getProperties in interface ReadableBean
    
    Returns:
    
    an Iterable of all properties of this bean.
  - getRequiredProperty
```
default WritableProperty<?> getRequiredProperty(String name)
```
    Specified by:
    
    getRequiredProperty in interface ReadableBean
    
    Parameters:
    
    name - the name of the requested property.
    
    Returns:
    
    the requested property.
  - set
```
default void set(String name,
                 Object value)
```
    Sets the value of the required property with the given name to the given value.
    
    Parameters:
    
    name - the name of the property.
    
    value - new value of the specified property.
  - set
```
default <V> void set(String name,
                     V value,
                     Class<V> valueClass)
```
    /** Sets the value of the existing or newly created property with the given name to the given value.
    
    Type Parameters:
    
    V - the generic type of the value class.
    
    Parameters:
    
    name - the property name.
    
    value - new value of the specified property.
    
    valueClass - the value class.
    
    See Also:
    
    set(String, Object)
  - set
```
default <V> void set(String name,
                     V value,
                     Class<V> valueClass,
                     Type valueType)
```
    /** Sets the value of the existing or newly created property with the given name to the given value.
    
    Type Parameters:
    
    V - the generic type of the value class.
    
    Parameters:
    
    name - the property name.
    
    value - new value of the specified property.
    
    valueClass - the value class.
    
    valueType - the Type reflecting the property value.
    
    See Also:
    
    set(String, Object)
  - addProperty
```
<P extends WritableProperty<?>> P addProperty(P property)
```
    Adds the given WritableProperty to this bean.
    
    Type Parameters:
    
    P - type of the WritableProperty to add.
    
    Parameters:
    
    property - the WritableProperty to add.
    
    Returns:
    
    the given property.
    
    Throws:
    
    IllegalStateException - if this WritableBean is read-only or not dynamic.
  - createProperty
```
default <V> WritableProperty<V> createProperty(String name,
                                               Class<V> valueClass)
```
    Creates and adds a WritableProperty with the given value class dynamically.
    
    Type Parameters:
    
    V - the generic type of the value class.
    
    Parameters:
    
    name - the property name.
    
    valueClass - the value class.
    
    Returns:
    
    the newly created and added property.
    
    Throws:
    
    IllegalStateException - if this WritableBean already has such property, is read-only, or not dynamic.
  - createProperty
```
<V> WritableProperty<V> createProperty(String name,
                                       Class<V> valueClass,
                                       Type valueType)
```
    Creates and adds a WritableProperty with the given value class dynamically.
    
    Type Parameters:
    
    V - the generic type of the value class.
    
    Parameters:
    
    name - the property name.
    
    valueClass - the value class.
    
    valueType - the Type reflecting the property value.
    
    Returns:
    
    the newly created and added property.
    
    Throws:
    
    IllegalStateException - if this WritableBean already has such property, is read-only, or not dynamic.
  - getOrCreateProperty
```
default <V> WritableProperty<V> getOrCreateProperty(String name,
                                                    Class<V> valueClass)
```
    Gets or creates the specified property.
    
    Type Parameters:
    
    V - the generic type of the property value.
    
    Parameters:
    
    name - the property name.
    
    valueClass - the value class of the requested property.
    
    Returns:
    
    the requested property. Will be created if it does not already exist.
    
    Throws:
    
    IllegalArgumentException - if the requested property already exists but has an incompatible value class.
    
    IllegalStateException - if the requested property does not exist but this WritableBean is read-only, or not dynamic.
  - getOrCreateProperty
```
default <V> WritableProperty<V> getOrCreateProperty(String name,
                                                    Class<V> valueClass,
                                                    Type valueType)
```
    Gets or creates the specified property.
    
    Type Parameters:
    
    V - the generic type of the property value.
    
    Parameters:
    
    name - the property name.
    
    valueClass - the Class reflecting the property value.
    
    valueType - the Type reflecting the property value.
    
    Returns:
    
    the requested property. Will be created if it does not already exist.
    
    Throws:
    
    IllegalArgumentException - if the requested property already exists but has an incompatible value class.
    
    IllegalStateException - if the requested property does not exist but this WritableBean is read-only, or not dynamic.
  - read
```
default void read(StructuredReader reader)
```
    Specified by:
    
    read in interface UnmarshallableObject
    
    Parameters:
    
    reader - the StructuredReader where to read the data from. This object will be modified such that the read data will be applied. For complex objects (e.g. beans with multiple properties) those properties not defined in the data that is read will not be overwritten. In order to get a clean representation of the data from the given reader you should invoke this method on an empty object.

Interface WritableBean

Field Summary

Fields inherited from interface io.github.mmm.bean.ReadableBean

Method Summary

Methods inherited from interface io.github.mmm.marshall.MarshallableObject

Methods inherited from interface io.github.mmm.bean.ReadableBean

Methods inherited from interface io.github.mmm.marshall.UnmarshallableObject

Method Detail

getProperty

getProperties

getRequiredProperty

set

set

set

addProperty

createProperty

createProperty

getOrCreateProperty

getOrCreateProperty

read