| org.eclipse.ui.internal.preferences.IPropertyMap
All known Subclasses: org.eclipse.ui.internal.preferences.PropertyMapUnion,
| IPropertyMap | | public interface IPropertyMap (Code) | | Eclipse provides many different classes and interfaces that map ids onto values and
send property change notifications (some examples are themes, preference stores,
xml nodes, property providers, and others). This interface is intended to provide
interoperability between these various classes.
since:
3.1 |
| Method Summary | |
| public Object | getValue(String propertyId, Class propertyType)
Returns the value of the given property. | | public boolean | isCommonProperty(String propertyId)
If this map represents the union of multiple property maps, this
returns true iff the property existed in every map in the union.
Always returns true if this map was not computed from the union
of multiple maps. | | public Set | keySet()
Returns the set of keys that are recognized by this property map
(optional operation). | | public boolean | propertyExists(String propertyId)
Returns true iff the given property exists. | | public void | setValue(String propertyId, Object newValue)
Sets the value of the given property to the given value (optional
operation). |
| getValue | | public Object getValue(String propertyId, Class propertyType)(Code) | | Returns the value of the given property. Returns null if the given
property does not exist, cannot be converted into the expected type,
or if the value of the property is null.
Parameters:
propertyId - property ID to query
Parameters:
propertyType - type of the expected return value an object of the given propertyType or null if the propertydoes not exist or has the wrong type
since:
3.1 |
| isCommonProperty | | public boolean isCommonProperty(String propertyId)(Code) | | If this map represents the union of multiple property maps, this
returns true iff the property existed in every map in the union.
Always returns true if this map was not computed from the union
of multiple maps.
Parameters:
propertyId - true iff the given property existed in every child map
since:
3.1 |
| keySet | | public Set keySet()(Code) | | Returns the set of keys that are recognized by this property map
(optional operation).
the set of valid keys for this map
throws:
UnsupportedOperationException - if this type of property mapcannot compute the set of valid keys
since:
3.1 |
| propertyExists | | public boolean propertyExists(String propertyId)(Code) | | Returns true iff the given property exists.
Parameters:
propertyId - true iff the given property exists in this map
since:
3.1 |
| setValue | | public void setValue(String propertyId, Object newValue)(Code) | | Sets the value of the given property to the given value (optional
operation).
Parameters:
propertyId -
Parameters:
newValue -
throws:
UnsupportedOperationException - if this type of property mapis read-only
since:
3.1 |
|
|