Joda System API

org.joda.property.type
Interface MapProperty

All Superinterfaces:
java.util.Map, ModelElement, Property, java.io.Serializable
All Known Subinterfaces:
DataMapProperty, LinkMapProperty
All Known Implementing Classes:
AbstractMapProperty, DefaultDataMapProperty, DefaultLinkMapProperty

public interface MapProperty
extends Property, java.util.Map

Interface for a typed updateable map of objects.

Ideally, the keys and values in the map should be immutable. (In fact mutable keys are a really bad idea.) When this is not possible, if you update a key or value which is in the map, the firePropertyValueChanged() method should be called to send out the correct events.

Author:
Stephen Colebourne

Nested Class Summary
 
Nested classes inherited from class org.joda.property.Property
Property.Internal
 
Method Summary
 java.lang.Class getMapKeyType()
          Get the type of each of the keys in the map
 java.util.Map toMap()
          Get the map underlying the property.
 
Methods inherited from interface org.joda.property.Property
addPropertyChangeListener, bean, equals, equalsValue, firePropertyChange, getContentName, getContentType, getPropertyName, getPropertyType, hashCode, isModifiable, isNull, isReadOnly, removePropertyChangeListener, set, setModifiable, setReadOnly, toObject, toString
 
Methods inherited from interface org.joda.property.ModelElement
getAttribute, getAttributeCount, getAttributeMap, setAttribute
 
Methods inherited from interface java.util.Map
clear, containsKey, containsValue, entrySet, equals, get, hashCode, isEmpty, keySet, put, putAll, remove, size, values
 

Method Detail

getMapKeyType

public java.lang.Class getMapKeyType()
Get the type of each of the keys in the map

Returns:
the type of the keys in the map

toMap

public java.util.Map toMap()
Get the map underlying the property.

Returns:
the map (a copy of the data)

Joda System API

Copyright © 2001-2003 Stephen Colebourne. All Rights Reserved.