org.eclipse.rse.core.model
Class PropertySetContainer
java.lang.Object
org.eclipse.rse.core.model.RSEPersistableObject
org.eclipse.rse.core.model.PropertySetContainer
-
All Implemented Interfaces:
-
IPropertySetContainer,
IRSEPersistableContainer
-
Direct Known Subclasses:
-
RSEModelObject
-
public abstract class PropertySetContainer
- extends
RSEPersistableObject
- implements
IPropertySetContainer
A PropertySetContainer is capable of holding multiple named property sets.
Methods inherited from class java.lang.
Object
|
clone,
equals,
finalize,
getClass,
hashCode,
notify,
notifyAll,
toString,
wait,
wait,
wait
|
PropertySetContainer
public PropertySetContainer()
getPropertySets
public
IPropertySet[] getPropertySets()
-
Description copied from interface:
IPropertySetContainer
- Retrieves an array all property sets known to this container. It will return an empty array if this
container has property sets. The order of these property sets is not dictated by the interface.
-
-
Specified by:
-
getPropertySets
in interface
IPropertySetContainer
-
-
Returns:
- an array of property sets.
getPropertySet
public
IPropertySet getPropertySet(
String name)
-
Description copied from interface:
IPropertySetContainer
- Retrieves a particular property set by its name.
-
-
Specified by:
-
getPropertySet
in interface
IPropertySetContainer
-
-
Parameters:
-
name
- the name of the property set.
-
Returns:
- the named property set or null if one by that name does not exist.
createPropertySet
public
IPropertySet createPropertySet(
String name,
String description)
-
Description copied from interface:
IPropertySetContainer
- Creates a new property set of a particular name and description in this
container. If one already exists by this name it is replaced with a new
empty property set.
In order to have the property set persisted, the implementing class
should also implement
IRSEPersistableContainer
. The
IRSEPersistableContainer.commit()
method must then be used to
commit any changes into persistent storage.
-
-
Specified by:
-
createPropertySet
in interface
IPropertySetContainer
-
-
Parameters:
-
name
- the name of the property set. -
description
- the description (usually already localized) for this
property set.
-
Returns:
- the newly created property set.
createPropertySet
public
IPropertySet createPropertySet(
String name)
-
Description copied from interface:
IPropertySetContainer
- Creates a new property set of a particular name in this container.
If one already exists by this name, it is replaced with a new empty
property set.
In order to have the property set persisted, the implementing class
should also implement
IRSEPersistableContainer
. The
IRSEPersistableContainer.commit()
method must then be used to
commit any changes into persistent storage.
-
-
Specified by:
-
createPropertySet
in interface
IPropertySetContainer
-
-
Parameters:
-
name
- the name of the property set.
-
Returns:
- The property set.
addPropertySet
public boolean addPropertySet(
IPropertySet set)
-
Description copied from interface:
IPropertySetContainer
- Adds an existing property set to this container. If the property set already has a container
it is removed from that container and added to this one. If this container already
has a property set by this name, this one replaces it.
-
-
Specified by:
-
addPropertySet
in interface
IPropertySetContainer
-
-
Parameters:
-
set
- the property set to be added.
-
Returns:
- true if the property set was added.
addPropertySets
public boolean addPropertySets(
IPropertySet[] sets)
-
Description copied from interface:
IPropertySetContainer
- Adds a number of existing property sets to this container.
-
-
Specified by:
-
addPropertySets
in interface
IPropertySetContainer
-
-
Parameters:
-
sets
- the sets to be added
-
Returns:
- true if all property sets were added.
-
See Also:
-
IPropertySetContainer.addPropertySet(IPropertySet)
removePropertySet
public boolean removePropertySet(
String name)
-
Description copied from interface:
IPropertySetContainer
- Removes a particular property set from this container.
-
-
Specified by:
-
removePropertySet
in interface
IPropertySetContainer
-
-
Parameters:
-
name
- the name of the property set to be removed
-
Returns:
- true if the property set was removed;
false if a property set was not removed, usually if it does not exist in the container.
Copyright (c) IBM Corporation and others 2000, 2008. All Rights Reserved.