java.lang.Object
- io.github.mmm.event.AbstractEventSource<ObservableEvent<V>,ObservableEventListener<? super V>>
- - io.github.mmm.value.observable.AbstractObservableValue<V>
  - - io.github.mmm.value.observable.AbstractWritableObservableValue<V>
    - - io.github.mmm.property.Property<V>
      - io.github.mmm.property.container.ContainerProperty<Map<K,V>,V>
        
        io.github.mmm.property.container.map.MapProperty<K,V>

Type Parameters:

K - type of the keys.

V - type of the values.

All Implemented Interfaces:

EventSource<ObservableEvent<Map<K,V>>,ObservableEventListener<? super Map<K,V>>>, MarshallableObject, Marshaller<Object>, Marshalling<Object>, MarshallingObject, UnmarshallableObject, Unmarshaller<Object>, ReadableMapProperty<K,V>, WritableMapProperty<K,V>, ReadableContainerProperty<Map<K,V>,V>, WritableContainerProperty<Map<K,V>,V>, ReadableProperty<Map<K,V>>, WritableProperty<Map<K,V>>, Validatable, ObservableMapValue<K,V>, ReadableMapValue<K,V>, WritableMapValue<K,V>, ObservableContainerValue<Map<K,V>,V>, ReadableContainerValue<Map<K,V>,V>, WritableContainerValue<Map<K,V>,V>, ReadableObjectValue<Map<K,V>>, ReadableTypedObjectValue<Map<K,V>>, WritableObjectValue<Map<K,V>>, ObservableValue<Map<K,V>>, WritableObservableValue<Map<K,V>>, PropertyPath<Map<K,V>>, ReadableTypedValue<Map<K,V>>, ReadableValue<Map<K,V>>, TypedPropertyPath<Map<K,V>>, WritableValue<Map<K,V>>, Cloneable, Supplier<Map<K,V>>
```
public class MapProperty<K,V>
extends ContainerProperty<Map<K,V>,V>
implements WritableMapProperty<K,V>
```
Implementation of WritableMapProperty.

Since:

1.0.0

Field Summary
- Fields inherited from class io.github.mmm.property.container.ContainerProperty
  valueProperty
- Fields inherited from interface io.github.mmm.property.container.ReadableContainerProperty
  METADATA_KEY_COMPONENT_PROPERTY
- Fields inherited from interface io.github.mmm.property.container.map.ReadableMapProperty
  METADATA_KEY_KEY_PROPERTY
- Fields inherited from interface io.github.mmm.property.WritableProperty
  NO_PROPERTIES

Constructor Summary

Constructors
Constructor	Description
`MapProperty(String name, SimpleProperty<K> keyProperty, Property<V> valueProperty)`	The constructor.
`MapProperty(String name, SimpleProperty<K> keyProperty, Property<V> valueProperty, PropertyMetadata<Map<K,V>> metadata)`	The constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected Map<K,V>`	`doGet()`
`protected void`	`doSet(Map<K,V> newValue)`
`protected ValidationResult`	`doValidate(Map<K,V> map, String source)`	Called from `Property.validate()` in case re-validation is required.
`ChangeAwareMap<K,V>`	`getChangeAwareValue()`
`SimpleProperty<K>`	`getKeyProperty()`
`boolean`	`isChangeAware()`
`void`	`read(StructuredReader reader)`
`void`	`write(StructuredWriter writer)`
`protected void`	`writeKey(StructuredWriter writer, K key)`	Implementation of `write(StructuredWriter)` for a `map key`.
`protected void`	`writeValue(StructuredWriter writer, V mapValue)`	Implementation of `write(StructuredWriter)` for a `map value`.

Methods inherited from class io.github.mmm.property.container.ContainerProperty
emptyProperty, getValueProperty, invalidateProperties, isValueEqual, isValueMutable, sizeProperty

Methods inherited from class io.github.mmm.property.Property
clearValidationResult, clone, copy, doValidate, equals, get, getMetadata, getName, getReadOnly, hashCode, isReadOnly, isValid, readObject, requireWritable, setWithChange, toString, validate, writeObject

Methods inherited from class io.github.mmm.value.observable.AbstractWritableObservableValue
bindInternal, bindOneWay, bindTwoWay, isBoundOneWay, set, unbindOneWay, unbindTwoWay

Methods inherited from class io.github.mmm.value.observable.AbstractObservableValue
addListener, fireChange, fireEvent, fireEvent, fireEventFor, fireEventFor, fireEventWithOldValue, hasChangeAwareListeners, invalidate, removeListener, toString

Methods inherited from class io.github.mmm.event.AbstractEventSource
getEventAdapter, hasListeners

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface io.github.mmm.event.EventSource
addListener, addListener, addWeakListener, removeListener

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

Methods inherited from interface io.github.mmm.value.observable.ObservableValue
toString

Methods inherited from interface io.github.mmm.property.container.ReadableContainerProperty
emptyProperty, sizeProperty

Methods inherited from interface io.github.mmm.value.observable.container.ReadableContainerValue
isEmpty

Methods inherited from interface io.github.mmm.value.observable.container.map.ReadableMapValue
getValueClass, size

Methods inherited from interface io.github.mmm.value.observable.object.ReadableObjectValue
getSafe, getValue

Methods inherited from interface io.github.mmm.property.ReadableProperty
getMetadata, getName, isReadOnly, isTransient, isValid

Methods inherited from interface io.github.mmm.value.ReadableValue
get

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

Methods inherited from interface io.github.mmm.validation.Validatable
validate

Methods inherited from interface io.github.mmm.property.container.WritableContainerProperty
getValueProperty

Methods inherited from interface io.github.mmm.value.observable.container.map.WritableMapValue
getOrCreate

Methods inherited from interface io.github.mmm.value.observable.object.WritableObjectValue
setValue

Methods inherited from interface io.github.mmm.value.observable.WritableObservableValue
bindOneWay, bindTwoWay, isBoundOneWay, unbindOneWay, unbindTwoWay

Methods inherited from interface io.github.mmm.property.WritableProperty
copy, getReadOnly

Methods inherited from interface io.github.mmm.value.WritableValue
set

- Constructor Detail
  - MapProperty
```
public MapProperty(String name,
                   SimpleProperty<K> keyProperty,
                   Property<V> valueProperty)
```
    The constructor.
    
    Parameters:
    
    name - the name.
    
    keyProperty - the key property.
    
    valueProperty - the value property.
  - MapProperty
```
public MapProperty(String name,
                   SimpleProperty<K> keyProperty,
                   Property<V> valueProperty,
                   PropertyMetadata<Map<K,V>> metadata)
```
    The constructor.
    
    Parameters:
    
    name - the name.
    
    keyProperty - the key property.
    
    valueProperty - the value property.
    
    metadata - the metadata.
- Method Detail
  - getKeyProperty
```
public SimpleProperty<K> getKeyProperty()
```
    Specified by:
    
    getKeyProperty in interface ReadableMapProperty<K,V>
    
    Returns:
    
    the ReadableProperty representing the type of the keys of the Map value.
  - doGet
```
protected Map<K,V> doGet()
```
    Specified by:
    
    doGet in class AbstractWritableObservableValue<Map<K,V>>
    
    Returns:
    
    the internal value.
  - doSet
```
protected void doSet(Map<K,V> newValue)
```
    Specified by:
    
    doSet in class AbstractWritableObservableValue<Map<K,V>>
    
    Parameters:
    
    newValue - the new value to set.
    
    See Also:
    
    AbstractWritableObservableValue.set(Object)
  - doValidate
```
protected ValidationResult doValidate(Map<K,V> map,
                                      String source)
```
    Description copied from class: Property
    
    Called from Property.validate() in case re-validation is required.
    
    Overrides:
    
    doValidate in class Property<Map<K,V>>
    
    Parameters:
    
    map - the value to validate.
    
    source - the validation source.
    
    Returns:
    
    the result of the validation.
  - isChangeAware
```
public boolean isChangeAware()
```
    Specified by:
    
    isChangeAware in interface WritableContainerProperty<K,V>
    
    Returns:
    
    true if change aware value has been initialized, false otherwise.
  - getChangeAwareValue
```
public ChangeAwareMap<K,V> getChangeAwareValue()
```
    Specified by:
    
    getChangeAwareValue in interface WritableContainerProperty<K,V>
    
    Specified by:
    
    getChangeAwareValue in interface WritableMapProperty<K,V>
    
    Returns:
    
    the value as ChangeAwareContainer. Will be initialized on the first call of this method. Unless initialized, a container property is lightweight just as other regular properties. Once this method was called, the ChangeAwareContainer is initialized and triggers change events for modifications of the container instance itself. Calls to WritableValue.set(Object) will implicitly change this ChangeAwareContainer such that in only contains what the provided new value contains. The instance of the ChangeAwareContainer returned by this method always remains the same.
  - read
```
public void read(StructuredReader reader)
```
    Specified by:
    
    read in interface UnmarshallableObject
    
    Overrides:
    
    read in class Property<Map<K,V>>
    
    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.
  - write
```
public void write(StructuredWriter writer)
```
    Specified by:
    
    write in interface MarshallableObject
    
    Overrides:
    
    write in class Property<Map<K,V>>
    
    Parameters:
    
    writer - the StructuredWriter where to marshall (serialize) the data of this object to.
    
    See Also:
    
    MarshallableObject.writeObject(StructuredWriter, Object)
  - writeKey
```
protected void writeKey(StructuredWriter writer,
                        K key)
```
    Implementation of write(StructuredWriter) for a map key.
    
    Parameters:
    
    writer - the StructuredWriter.
    
    key - the map key to marshall.
  - writeValue
```
protected void writeValue(StructuredWriter writer,
                          V mapValue)
```
    Implementation of write(StructuredWriter) for a map value.
    
    Parameters:
    
    writer - the StructuredWriter.
    
    mapValue - the map value to marshall.

Class MapProperty<K,​V>

Field Summary

Fields inherited from class io.github.mmm.property.container.ContainerProperty

Fields inherited from interface io.github.mmm.property.container.ReadableContainerProperty

Fields inherited from interface io.github.mmm.property.container.map.ReadableMapProperty

Fields inherited from interface io.github.mmm.property.WritableProperty

Constructor Summary

Method Summary

Methods inherited from class io.github.mmm.property.container.ContainerProperty

Methods inherited from class io.github.mmm.property.Property

Methods inherited from class io.github.mmm.value.observable.AbstractWritableObservableValue

Methods inherited from class io.github.mmm.value.observable.AbstractObservableValue

Methods inherited from class io.github.mmm.event.AbstractEventSource

Methods inherited from class java.lang.Object

Methods inherited from interface io.github.mmm.event.EventSource

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

Methods inherited from interface io.github.mmm.value.observable.ObservableValue

Methods inherited from interface io.github.mmm.property.container.ReadableContainerProperty

Methods inherited from interface io.github.mmm.value.observable.container.ReadableContainerValue

Methods inherited from interface io.github.mmm.value.observable.container.map.ReadableMapValue

Methods inherited from interface io.github.mmm.value.observable.object.ReadableObjectValue

Methods inherited from interface io.github.mmm.property.ReadableProperty

Methods inherited from interface io.github.mmm.value.ReadableValue

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

Methods inherited from interface io.github.mmm.validation.Validatable

Methods inherited from interface io.github.mmm.property.container.WritableContainerProperty

Methods inherited from interface io.github.mmm.value.observable.container.map.WritableMapValue

Methods inherited from interface io.github.mmm.value.observable.object.WritableObjectValue

Methods inherited from interface io.github.mmm.value.observable.WritableObservableValue

Methods inherited from interface io.github.mmm.property.WritableProperty

Methods inherited from interface io.github.mmm.value.WritableValue

Constructor Detail

MapProperty

MapProperty

Method Detail

getKeyProperty

doGet

doSet

doValidate

isChangeAware

getChangeAwareValue

read

write

writeKey

writeValue

Class MapProperty<K,V>