|
RSE Release 3.2 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IPropertySet
A Property Set stores key/value pairs, where the keys are Strings and the
values are an IProperty
, of a type declared by an
IPropertyType
.
The Property Set is identified by a name. By default, the type of each
property is of type String, and in fact each value can be retrieved in String
representation.
The key "description"
is reserved for internal use, to store the
description of the Property set.
Field Summary | |
---|---|
static String |
DESCRIPTION_KEY
The key used to store the description of the Property Set. |
Method Summary | |
---|---|
IProperty |
addProperty(String key,
String value)
Add a Property with String value to the set. |
IProperty |
addProperty(String key,
String value,
IPropertyType type)
Add a typed Property to the set. |
IPropertySetContainer |
getContainer()
|
String |
getDescription()
Return the description of this Property Set. |
String |
getName()
Return the name of this Property Set. |
IProperty |
getProperty(String key)
Return the IProperty associated with the given key. |
String[] |
getPropertyKeys()
Return the list of Property Keys in this Set. |
IPropertyType |
getPropertyType(String key)
Return the type of the property identified by the given key. |
String |
getPropertyValue(String key)
Return the String representation of a Property. |
boolean |
removeProperty(String key)
Remove a Property from the set. |
void |
setContainer(IPropertySetContainer container)
Sets the container of this property set. |
void |
setDescription(String description)
Sets the description property of the property set. |
void |
setName(String name)
Set the name of this Property Set. |
void |
setProperties(Map map)
Set all the Properties of this set. |
Methods inherited from interface org.eclipse.rse.core.model.IPropertySetContainer |
---|
addPropertySet, addPropertySets, createPropertySet, createPropertySet, getPropertySet, getPropertySets, removePropertySet |
Field Detail |
---|
static final String DESCRIPTION_KEY
Method Detail |
---|
String getName()
String getDescription()
addProperty(IPropertySet.DESCRIPTION_KEY, "Description");
null
in case no description has been set.void setDescription(String description)
addProperty(IPropertySet.DESCRIPTION_KEY, description);
description
- the string describing this property set.IProperty getProperty(String key)
IProperty
associated with the given key.
If the key is not in the set, null
is returned.
key
- String key for Property
null
if the key is not found in the set.String getPropertyValue(String key)
null
is returned.
key
- String key for Property
null
if the key is not found in the set.String[] getPropertyKeys()
IPropertyType getPropertyType(String key)
key
- String key for Property
null
if the key is not found in the set.void setName(String name)
name
- the name to set. Must not be null
void setProperties(Map map)
map
- a Map of String to IProperty
associations.IProperty addProperty(String key, String value)
key
- Key to addvalue
- Value to add
IProperty addProperty(String key, String value, IPropertyType type)
key
- Key to addvalue
- Value to addtype
- Type of the Property to add
boolean removeProperty(String key)
key
- The key to remove
true
if the Property has been removed,
or false
if the key has not been part of the set.void setContainer(IPropertySetContainer container)
container
- the property set containerIPropertySetContainer getContainer()
|
RSE Release 3.2 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |