org.eclipse.rse.core.model
Class PropertySet

java.lang.Object
  org.eclipse.rse.core.model.PropertySet

All Implemented Interfaces:

IPropertySet

public class PropertySet

extends Object

implements IPropertySet

A Hashmap based implementation of the IPropertySet interface. Not thread-safe since the underlying HashMap is not thread-safe.

Field Summary

protected static IPropertyType

_defaultType

Fields inherited from interface org.eclipse.rse.core.model.IPropertySet

DESCRIPTION_KEY

Constructor Summary

PropertySet(IPropertySet propertySet)
Construct a new PropertySet based on an existing one (i.e. clone it).

PropertySet(String name)
Construct a new empty PropertySet.

Method Summary

IProperty	addProperty(String key, IProperty property) Add a typed Property to the set.
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.
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	setName(String name) Set the name of this Property Set.
void	setProperties(Map map) Set all the Properties of this set.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

_defaultType

protected static IPropertyType _defaultType

Constructor Detail

PropertySet

public PropertySet(IPropertySet propertySet)

Construct a new PropertySet based on an existing one (i.e. clone it).

Parameters:

propertySet - existing Property Set to clone

PropertySet

public PropertySet(String name)

Construct a new empty PropertySet.

Parameters:

name - of the new PropertySet

Method Detail

getName

public String getName()

Description copied from interface: IPropertySet

Return the name of this Property Set.

Specified by:

getName in interface IPropertySet

Returns:

String name of the Property Set.

getDescription

public String getDescription()

Description copied from interface: IPropertySet

Return the description of this Property Set. Note that in order to set the description, you need to call setProperty(IPropertySet.DESCRIPTION_KEY, "Description");

Specified by:

getDescription in interface IPropertySet

Returns:

Description of the Property Set, or null in case no description has been set.

getPropertyKeys

public String[] getPropertyKeys()

Description copied from interface: IPropertySet

Return the list of Property Keys in this Set. Provided that the Set has a description, the

Specified by:

getPropertyKeys in interface IPropertySet

Returns:

String array of Property keys.

setName

public void setName(String name)

Description copied from interface: IPropertySet

Set the name of this Property Set.

Specified by:

setName in interface IPropertySet

Parameters:

name - the name to set. Must not be null

setProperties

public void setProperties(Map map)

Description copied from interface: IPropertySet

Set all the Properties of this set.

Specified by:

setProperties in interface IPropertySet

Parameters:

map - a Map of String to IProperty associations.

addProperty

public IProperty addProperty(String key,
                             IProperty property)

Add a typed Property to the set. In case a Property already exists for the given key, it will be overwritten.

Parameters:

key - Key to add

property - The Property to add

Returns:

The added Property

addProperty

public IProperty addProperty(String key,
                             String value)

Description copied from interface: IPropertySet

Add a Property with String value to the set. In case a Property already exist for the given key, it will be overwritten by the new value, note that this will not change the Property's type, so if the key identifies an integer Property but you set it to String value "foo" the resulting Property Set will be inconsistent. If the Property does not yet exist in the set, a new key will be added and the new Property will be of type "String".

Specified by:

addProperty in interface IPropertySet

Parameters:

key - Key to add

value - Value to add

Returns:

The added Property

addProperty

public IProperty addProperty(String key,
                             String value,
                             IPropertyType type)

Description copied from interface: IPropertySet

Add a typed Property to the set. In case a Property already exists for the given key, it will be removed and replaced by the new one.

Specified by:

addProperty in interface IPropertySet

Parameters:

key - Key to add

value - Value to add

type - Type of the Property to add

Returns:

The added Property

removeProperty

public boolean removeProperty(String key)

Description copied from interface: IPropertySet

Remove a Property from the set.

Specified by:

removeProperty in interface IPropertySet

Parameters:

key - The key to remove

Returns:

true if the Property has been removed, or false if the key has not been part of the set.

getProperty

public IProperty getProperty(String key)

Description copied from interface: IPropertySet

Return the IProperty associated with the given key. If the key is not in the set, null is returned.

Specified by:

getProperty in interface IPropertySet

Parameters:

key - String key for Property

Returns:

requested Property, or null if the key is not found in the set.

getPropertyValue

public String getPropertyValue(String key)

Description copied from interface: IPropertySet

Return the String representation of a Property. Provided that the key is found in the set, this is a shortcut for getProperty(key).getValue(). If the key is not in the set, null is returned.

Specified by:

getPropertyValue in interface IPropertySet

Parameters:

key - String key for Property

Returns:

String value of requested Property, or null if the key is not found in the set.

getPropertyType

public IPropertyType getPropertyType(String key)

Description copied from interface: IPropertySet

Return the type of the property identified by the given key.

Specified by:

getPropertyType in interface IPropertySet

Parameters:

key - String key for Property

Returns:

Type of requested Property, or null if the key is not found in the set.