mirrors/cdt
1
0
Fork 0
mirror of https://github.com/eclipse-cdt/cdt synced 2025-07-14 12:35:22 +02:00
Code Issues Wiki Activity

[227509][apidoc] Add note how to persist property sets

Browse source
This commit is contained in:
Martin Oberhuber 2008-04-17 10:25:24 +00:00
parent c5e8c11303
commit 2e1af7f493
1 changed files with 29 additions and 15 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

30
rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/model/IPropertySetContainer.java
View file

@ -1,5 +1,5 @@
/*******************************************************************************
* Copyright (c) 2006, 2007 IBM Corporation and others.
* Copyright (c) 2006, 2008 IBM Corporation and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
@ -12,7 +12,7 @@
* Emily Bruner, Mazen Faraj, Adrian Storisteanu, Li Ding, and Kent Hawley.
*
* Contributors:
* {Name} (company) - description of contribution.
* Johann Draschwandtner (Wind River) - [227509][apidoc] Add note how to persist property sets
*******************************************************************************/
package org.eclipse.rse.core.model;
@ -40,19 +40,33 @@ public 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.
*
* 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 {@link IRSEPersistableContainer}. The
* {@link IRSEPersistableContainer#commit()} method must then be used to
* commit any changes into persistent storage.
*
* @param name the name of the property set.
* @return The property set.
*/
public IPropertySet createPropertySet(String name);
/**
* 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.
* 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 {@link IRSEPersistableContainer}. The
* {@link IRSEPersistableContainer#commit()} method must then be used to
* commit any changes into persistent storage.
*
* @param name the name of the property set.
* @param description the description (usually already localized) for this property set.
* @param description the description (usually already localized) for this
* property set.
* @return the newly created property set.
*/
public IPropertySet createPropertySet(String name, String description);