Module io.github.mmm.property

Package io.github.mmm.property.container.map

Class MapProperty<K,V>

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:

io.github.mmm.event.EventSource<ObservableEvent<Map<K,V>>,ObservableEventListener<? super Map<K,V>>>, io.github.mmm.marshall.MarshallableObject, io.github.mmm.marshall.Marshaller<Object>, io.github.mmm.marshall.Marshalling<Object>, io.github.mmm.marshall.MarshallingObject, io.github.mmm.marshall.UnmarshallableObject, io.github.mmm.marshall.Unmarshaller<Object>, AttributeReadOnly, 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, io.github.mmm.value.CriteriaObject<Map<K,V>>, 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>>, io.github.mmm.value.PropertyPath<Map<K,V>>, io.github.mmm.value.ReadablePath, io.github.mmm.value.ReadableTypedValue<Map<K,V>>, io.github.mmm.value.ReadableValue<Map<K,V>>, io.github.mmm.value.TypedPropertyPath<Map<K,V>>, io.github.mmm.value.WritableValue<Map<K,V>>, Cloneable, Comparable<ReadableProperty<?>>, 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

Nested Class Summary

Nested classes/interfaces inherited from interface io.github.mmm.value.ReadablePath

io.github.mmm.value.ReadablePath.PathBuilder

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, WritableSimpleProperty<K> keyProperty, WritableProperty<V> valueProperty)	The constructor.
MapProperty(String name, WritableSimpleProperty<K> keyProperty, WritableProperty<V> valueProperty, PropertyMetadata<Map<K,V>> metadata)	The constructor.

Method Summary

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()
WritableSimpleProperty<K>	getKeyProperty()
boolean	isChangeAware()
void	read(io.github.mmm.marshall.StructuredReader reader)
void	write(io.github.mmm.marshall.StructuredWriter writer)
protected void	writeKey(io.github.mmm.marshall.StructuredWriter writer, K key)	Implementation of write(StructuredWriter) for a map key.
protected void	writeValue(io.github.mmm.marshall.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, compareTo, copy, doValidate, equals, get, getMetadata, getName, getReadOnly, hashCode, isReadOnly, isSensitive, 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.property.AttributeReadOnly

isReadOnly

Methods inherited from interface java.lang.Comparable

compareTo

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.value.PropertyPath

pathSegment

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.value.ReadablePath

path, path, path

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

computeSize, count, eq, eq, getMetadata, getName, getQualifiedName, getQualifiedName, getTypeMapper, isMandatory, isTransient, isValid, neq, neq, parentPath

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, validateOrThrow

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 Details

MapProperty

public MapProperty(String name,
 WritableSimpleProperty<K> keyProperty,
 WritableProperty<V> valueProperty)

The constructor.

Parameters:

name - the name.

keyProperty - the key property.

valueProperty - the value property.

MapProperty

public MapProperty(String name,
 WritableSimpleProperty<K> keyProperty,
 WritableProperty<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 Details

getKeyProperty

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

doSet

protected void doSet(Map<K,V> newValue)

Specified by:

doSet in class AbstractWritableObservableValue<Map<K,V>>

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(io.github.mmm.marshall.StructuredReader reader)

Specified by:

read in interface io.github.mmm.marshall.UnmarshallableObject

Overrides:

read in class Property<Map<K,V>>

write

public void write(io.github.mmm.marshall.StructuredWriter writer)

Specified by:

write in interface io.github.mmm.marshall.MarshallableObject

Overrides:

write in class Property<Map<K,V>>

writeKey

protected void writeKey(io.github.mmm.marshall.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(io.github.mmm.marshall.StructuredWriter writer,
 V mapValue)

Implementation of write(StructuredWriter) for a map value.

Parameters:

writer - the StructuredWriter.

mapValue - the map value to marshall.