org.eclipse.rse.core.model
Class PropertyList

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

All Implemented Interfaces:

Observer, ILabeledObject, IPropertySet, IRSEPersistableContainer

public class PropertyList
extends PropertySet

A property list is an ordered property set. As items are added and removed their arrival order is maintained.

Field Summary

Fields inherited from class org.eclipse.rse.core.model.PropertySet

_defaultType

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

DESCRIPTION_KEY

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

NO_CHILDREN

Constructor Summary

PropertyList(String name)

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[]	getPropertyKeys() Return the list of Property Keys in this Set.
boolean	removeProperty(String key) Remove a Property from the set.
void	setProperties(Map map) Set all the Properties of this set.

Methods inherited from class org.eclipse.rse.core.model.PropertySet

commit, getContainer, getDescription, getLabel, getName, getPersistableChildren, getPersistableParent, getProperty, getPropertyType, getPropertyValue, setContainer, setDescription, setLabel, setName, update

Methods inherited from class org.eclipse.rse.core.model.RSEPersistableObject

compareStrings, isDirty, isTainted, setDirty, setTainted, setWasRestored, wasRestored

Methods inherited from class java.lang.Object

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

Constructor Detail

PropertyList

public PropertyList(String name)

Method Detail

addProperty

public IProperty addProperty(String key,
                             IProperty property)

Description copied from class: PropertySet

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

Overrides:

addProperty in class PropertySet

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

Overrides:

addProperty in class PropertySet

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

Overrides:

addProperty in class PropertySet

Parameters:

key - Key to add

value - Value to add

type - Type of the Property to add

Returns:

The added Property

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

Overrides:

getPropertyKeys in class PropertySet

Returns:

String array of Property keys.

removeProperty

public boolean removeProperty(String key)

Description copied from interface: IPropertySet

Remove a Property from the set.

Specified by:

removeProperty in interface IPropertySet

Overrides:

removeProperty in class PropertySet

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.

setProperties

public void setProperties(Map map)

Description copied from interface: IPropertySet

Set all the Properties of this set.

Specified by:

setProperties in interface IPropertySet

Overrides:

setProperties in class PropertySet

Parameters:

map - a Map of String to IProperty associations.