mirror of
https://github.com/eclipse-cdt/cdt
synced 2025-07-03 23:25:26 +02:00
[cleanup] Get rid of @noextend on interfaces
This commit is contained in:
Martin Oberhuber
parent
86a6dd5d70
commit
3a3006d128
29 changed files with 200 additions and 214 deletions
|
|
@ -1,15 +1,15 @@
|
|||
/********************************************************************************
|
||||
* Copyright (c) 2006, 2008 IBM Corporation. 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
|
||||
* of the Eclipse Public License v1.0 which accompanies this distribution, and is
|
||||
* available at http://www.eclipse.org/legal/epl-v10.html
|
||||
*
|
||||
*
|
||||
* Initial Contributors:
|
||||
* The following IBM employees contributed to the Remote System Explorer
|
||||
* component that contains this file: David McKnight, Kushal Munir,
|
||||
* Michael Berger, David Dykstal, Phil Coulthard, Don Yantzi, Eric Simpson,
|
||||
* component that contains this file: David McKnight, Kushal Munir,
|
||||
* Michael Berger, David Dykstal, Phil Coulthard, Don Yantzi, Eric Simpson,
|
||||
* Emily Bruner, Mazen Faraj, Adrian Storisteanu, Li Ding, and Kent Hawley.
|
||||
*
|
||||
*
|
||||
* Contributors:
|
||||
* David Dykstal (IBM) - added javadoc
|
||||
* David Dykstal (IBM) - [150939] added read-only attribute
|
||||
|
|
@ -23,17 +23,16 @@ package org.eclipse.rse.core.model;
|
|||
* implement {@link IPropertySetContainer}. These would typically be model objects.
|
||||
* Properties also have a type (see {@link IPropertyType}).
|
||||
* @see IRSEModelObject
|
||||
* @noextend This interface is not intended to be extended by clients.
|
||||
* @noimplement This interface is not intended to be implemented by clients.
|
||||
* Use {@link Property} directly.
|
||||
*/
|
||||
public interface IProperty {
|
||||
|
||||
public interface IProperty {
|
||||
|
||||
/**
|
||||
* @return the name of the property.
|
||||
*/
|
||||
public String getKey();
|
||||
|
||||
|
||||
/**
|
||||
* Sets the displayable label of the property.
|
||||
* @param label the label for this property.
|
||||
|
|
@ -47,22 +46,22 @@ public interface IProperty {
|
|||
|
||||
/**
|
||||
* Sets the value of this property.
|
||||
* May raise a runtime exception if the new value of the property is
|
||||
* May raise a runtime exception if the new value of the property is
|
||||
* not compatible with its type.
|
||||
* @param value the new value for this property.
|
||||
*/
|
||||
public void setValue(String value);
|
||||
|
||||
public void setValue(String value);
|
||||
|
||||
/**
|
||||
* @return the value of this property
|
||||
*/
|
||||
public String getValue();
|
||||
|
||||
/**
|
||||
* Sets the type of this property.
|
||||
* May raise an runtime exception if the value of the property is not compatible
|
||||
* with the new type.
|
||||
* @param type
|
||||
* Sets the type of this property. May raise an runtime exception if the
|
||||
* value of the property is not compatible with the new type.
|
||||
*
|
||||
* @param type the property type
|
||||
*/
|
||||
public void setType(IPropertyType type);
|
||||
|
||||
|
|
@ -73,16 +72,16 @@ public interface IProperty {
|
|||
|
||||
/**
|
||||
* Sets the "enabled" presentation attribute of this property.
|
||||
* This is an attribute that can be used to drive the presentation of this
|
||||
* This is an attribute that can be used to drive the presentation of this
|
||||
* property and does not otherwise affect how this property can be used.
|
||||
* Properties are enabled by default.
|
||||
* @param flag true if the property is to be enabled.
|
||||
* @param flag true if the property is to be enabled.
|
||||
*/
|
||||
public void setEnabled(boolean flag);
|
||||
|
||||
/**
|
||||
* Retrieves the "enabled" presentation attribute of this property.
|
||||
* This is an attribute that can be used to drive the presentation of this
|
||||
* This is an attribute that can be used to drive the presentation of this
|
||||
* property and does not otherwise affect how this property can be used.
|
||||
* @return true if the property is enabled.
|
||||
*/
|
||||
|
|
@ -90,7 +89,7 @@ public interface IProperty {
|
|||
|
||||
/**
|
||||
* Sets the "read-only" presentation attribute of this property.
|
||||
* This is an attribute that can be used to drive the presentation of this
|
||||
* This is an attribute that can be used to drive the presentation of this
|
||||
* property and does not otherwise affect how this property can be used.
|
||||
* Properties are read-write by default.
|
||||
* @param flag true if the property is to be read-only.
|
||||
|
|
@ -99,7 +98,7 @@ public interface IProperty {
|
|||
|
||||
/**
|
||||
* Retrieves the "read-only" presentation attribute of this property.
|
||||
* This is an attribute that can be used to drive the presentation of this
|
||||
* This is an attribute that can be used to drive the presentation of this
|
||||
* property and does not otherwise affect how this property can be used.
|
||||
* @return true if the property is read-only.
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -7,10 +7,10 @@
|
|||
*
|
||||
* Initial Contributors:
|
||||
* The following IBM employees contributed to the Remote System Explorer
|
||||
* component that contains this file: David McKnight, Kushal Munir,
|
||||
* Michael Berger, David Dykstal, Phil Coulthard, Don Yantzi, Eric Simpson,
|
||||
* component that contains this file: David McKnight, Kushal Munir,
|
||||
* Michael Berger, David Dykstal, Phil Coulthard, Don Yantzi, Eric Simpson,
|
||||
* Emily Bruner, Mazen Faraj, Adrian Storisteanu, Li Ding, and Kent Hawley.
|
||||
*
|
||||
*
|
||||
* Contributors:
|
||||
* Martin Oberhuber (Wind River) - Added Javadoc.
|
||||
* David McKnight (IBM) - [217715] [api] RSE property sets should support nested property sets
|
||||
|
|
@ -23,91 +23,90 @@ import java.util.Map;
|
|||
|
||||
/**
|
||||
* A Property Set stores key/value pairs, where the keys
|
||||
* are Strings and the values are an {@link IProperty},
|
||||
* of a type declared by an {@link IPropertyType}.
|
||||
*
|
||||
* are Strings and the values are an {@link IProperty},
|
||||
* of a type declared by an {@link 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 <code>"description"</code> is reserved for internal
|
||||
* use, to store the description of the Property set.
|
||||
* @noextend This interface is not intended to be extended by clients.
|
||||
* @noimplement This interface is not intended to be implemented by clients.
|
||||
* Use {@link PropertySet} directly.
|
||||
*/
|
||||
public interface IPropertySet extends IPropertySetContainer {
|
||||
/**
|
||||
* The key used to store the description of the Property Set.
|
||||
* This is no longer used and should not be referenced except for
|
||||
/**
|
||||
* The key used to store the description of the Property Set.
|
||||
* This is no longer used and should not be referenced except for
|
||||
* compatibility reasons.
|
||||
*/
|
||||
public static final String DESCRIPTION_KEY = "description"; //$NON-NLS-1$
|
||||
public static final String DESCRIPTION_KEY = "description"; //$NON-NLS-1$
|
||||
|
||||
/**
|
||||
/**
|
||||
* Return the name of this Property Set.
|
||||
* @return String name of the Property Set.
|
||||
*/
|
||||
public String getName();
|
||||
|
||||
/**
|
||||
/**
|
||||
* Return the description of this Property Set.
|
||||
*
|
||||
*
|
||||
* Note that in order to set the description, you need to call
|
||||
* <code>addProperty(IPropertySet.DESCRIPTION_KEY, "Description");</code>
|
||||
*
|
||||
* @return Description of the Property Set,
|
||||
*
|
||||
* @return Description of the Property Set,
|
||||
* or <code>null</code> in case no description has been set.
|
||||
*/
|
||||
public String getDescription();
|
||||
|
||||
|
||||
/**
|
||||
* Sets the description property of the property set.
|
||||
* Fully equivalent to
|
||||
* Fully equivalent to
|
||||
* <code>addProperty(IPropertySet.DESCRIPTION_KEY, description);</code>
|
||||
* @param description the string describing this property set.
|
||||
*/
|
||||
public void setDescription(String description);
|
||||
|
||||
/**
|
||||
public void setDescription(String description);
|
||||
|
||||
/**
|
||||
* Return the {@link IProperty} associated with the given key.
|
||||
*
|
||||
*
|
||||
* If the key is not in the set, <code>null</code> is returned.
|
||||
*
|
||||
*
|
||||
* @param key String key for Property
|
||||
* @return requested Property,
|
||||
* or <code>null</code> if the key is not found in the set.
|
||||
* @return requested Property,
|
||||
* or <code>null</code> if the key is not found in the set.
|
||||
*/
|
||||
public IProperty getProperty(String key);
|
||||
|
||||
/**
|
||||
* Return the String representation of a Property.
|
||||
*
|
||||
* Provided that the key is found in the set, this is a shortcut
|
||||
/**
|
||||
* 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,
|
||||
* <code>null</code> is returned.
|
||||
*
|
||||
*
|
||||
* @param key String key for Property
|
||||
* @return String value of requested Property,
|
||||
* or <code>null</code> if the key is not found in the set.
|
||||
* or <code>null</code> if the key is not found in the set.
|
||||
*/
|
||||
public String getPropertyValue(String key);
|
||||
|
||||
/**
|
||||
* Return the list of Property Keys in this Set.
|
||||
*
|
||||
* Provided that the Set has a description, the
|
||||
*
|
||||
* Provided that the Set has a description, the
|
||||
* @link{DESCRIPTION_KEY} key will also be in the list.
|
||||
* The interface defines no particular ordering for the
|
||||
* The interface defines no particular ordering for the
|
||||
* keys.
|
||||
*
|
||||
*
|
||||
* @return String array of Property keys.
|
||||
*/
|
||||
public String[] getPropertyKeys();
|
||||
|
||||
/**
|
||||
* Return the type of the property identified by the given key.
|
||||
*
|
||||
*
|
||||
* @param key String key for Property
|
||||
* @return Type of requested Property,
|
||||
* or <code>null</code> if the key is not found in the set.
|
||||
|
|
@ -122,22 +121,22 @@ public interface IPropertySet extends IPropertySetContainer {
|
|||
|
||||
/**
|
||||
* Set all the Properties of this set.
|
||||
*
|
||||
*
|
||||
* @param map a Map of String to {@link IProperty} associations.
|
||||
*/
|
||||
public void setProperties(Map map);
|
||||
|
||||
/**
|
||||
* 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 <b>not</b> 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".
|
||||
*
|
||||
*
|
||||
* @param key Key to add
|
||||
* @param value Value to add
|
||||
* @return The added Property
|
||||
|
|
@ -146,10 +145,10 @@ public interface IPropertySet extends IPropertySetContainer {
|
|||
|
||||
/**
|
||||
* Add a typed Property to the set.
|
||||
*
|
||||
* In case a Property already exists for the given key, it will be
|
||||
*
|
||||
* In case a Property already exists for the given key, it will be
|
||||
* removed and replaced by the new one.
|
||||
*
|
||||
*
|
||||
* @param key Key to add
|
||||
* @param value Value to add
|
||||
* @param type Type of the Property to add
|
||||
|
|
@ -159,17 +158,18 @@ public interface IPropertySet extends IPropertySetContainer {
|
|||
|
||||
/**
|
||||
* Remove a Property from the set.
|
||||
*
|
||||
*
|
||||
* @param key The key to remove
|
||||
* @return <code>true</code> if the Property has been removed,
|
||||
* or <code>false</code> if the key has not been part of the set.
|
||||
*/
|
||||
public boolean removeProperty(String key);
|
||||
|
||||
|
||||
/**
|
||||
* Sets the container of this property set. Used to notify the
|
||||
* container of a change in a property.
|
||||
* @param container
|
||||
* Sets the container of this property set. Used to notify the container of
|
||||
* a change in a property.
|
||||
*
|
||||
* @param container the property set container
|
||||
*/
|
||||
public void setContainer(IPropertySetContainer container);
|
||||
|
||||
|
|
|
|||
|
|
@ -22,7 +22,6 @@ package org.eclipse.rse.core.model;
|
|||
* A property set container is capable of containing property sets. This interface allows for the
|
||||
* addition, retrieval, and deletion of property sets from the container. A property set may have only
|
||||
* one container.
|
||||
* @noextend This interface is not intended to be extended by clients.
|
||||
* @noimplement This interface is not intended to be implemented by clients.
|
||||
* The standard implementations are included in the framework.
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -19,7 +19,6 @@ package org.eclipse.rse.core.model;
|
|||
|
||||
/**
|
||||
* Property types are used to type instances of {@link IProperty}.
|
||||
* @noextend This interface is not intended to be extended by clients.
|
||||
* @noimplement This interface is not intended to be implemented by clients.
|
||||
* Use {@link PropertyType} directly.
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -17,7 +17,6 @@ import org.eclipse.core.runtime.IStatus;
|
|||
|
||||
/**
|
||||
* Implement this class to create callbacks.
|
||||
* @noextend This interface is not intended to be extended by clients.
|
||||
*/
|
||||
public interface IRSECallback {
|
||||
|
||||
|
|
|
|||
|
|
@ -25,8 +25,6 @@ package org.eclipse.rse.core.model;
|
|||
* An example of this is the SytemFilterPoolManager, which is itself not persisted, but
|
||||
* has this interface since it can be reconstructed from its ordering and exists
|
||||
* in the parent chain from SystemFilterPool to SystemProfile.
|
||||
* @noextend This interface is not intended to be extended by clients.
|
||||
* The standard extensions are included in the framework.
|
||||
* @noimplement This interface is not intended to be implemented by clients.
|
||||
* The standard implementations are included in the framework.
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -7,10 +7,10 @@
|
|||
*
|
||||
* Initial Contributors:
|
||||
* The following IBM employees contributed to the Remote System Explorer
|
||||
* component that contains this file: David McKnight, Kushal Munir,
|
||||
* Michael Berger, David Dykstal, Phil Coulthard, Don Yantzi, Eric Simpson,
|
||||
* component that contains this file: David McKnight, Kushal Munir,
|
||||
* Michael Berger, David Dykstal, Phil Coulthard, Don Yantzi, Eric Simpson,
|
||||
* Emily Bruner, Mazen Faraj, Adrian Storisteanu, Li Ding, and Kent Hawley.
|
||||
*
|
||||
*
|
||||
* Contributors:
|
||||
* David Dykstal (IBM) - [226561] Add API markup to RSE javadocs for extend / implement
|
||||
*******************************************************************************/
|
||||
|
|
@ -18,23 +18,24 @@
|
|||
package org.eclipse.rse.core.model;
|
||||
|
||||
/**
|
||||
* Constants for pre-defined subsystem factory categories.
|
||||
* Use these in calls to {@link org.eclipse.rse.core.model.ISystemRegistry#getHostsBySubSystemConfigurationCategory(String)}.
|
||||
* @noextend This interface is not intended to be extended by clients.
|
||||
* Constants for predefined subsystem factory categories. Use these in calls to
|
||||
* {@link org.eclipse.rse.core.model.ISystemRegistry#getHostsBySubSystemConfigurationCategory(String)}.
|
||||
*
|
||||
* @noimplement This interface is not intended to be implemented by clients.
|
||||
* This is a constant interface. The individual items should be referenced directly.
|
||||
* This is a constant interface. The individual items should be
|
||||
* referenced directly.
|
||||
*/
|
||||
public interface ISubSystemConfigurationCategories {
|
||||
/**
|
||||
* Job subsystems
|
||||
* Job subsystems
|
||||
*/
|
||||
public static final String SUBSYSTEM_CATEGORY_JOBS = "jobs"; //$NON-NLS-1$
|
||||
/**
|
||||
* File subsystems
|
||||
* File subsystems
|
||||
*/
|
||||
public static final String SUBSYSTEM_CATEGORY_FILES = "files"; //$NON-NLS-1$
|
||||
/**
|
||||
* Command subsystems
|
||||
* Command subsystems
|
||||
*/
|
||||
public static final String SUBSYSTEM_CATEGORY_CMDS = "commands"; //$NON-NLS-1$
|
||||
|
||||
|
|
|
|||
|
|
@ -7,10 +7,10 @@
|
|||
*
|
||||
* Initial Contributors:
|
||||
* The following IBM employees contributed to the Remote System Explorer
|
||||
* component that contains this file: David McKnight, Kushal Munir,
|
||||
* Michael Berger, David Dykstal, Phil Coulthard, Don Yantzi, Eric Simpson,
|
||||
* component that contains this file: David McKnight, Kushal Munir,
|
||||
* Michael Berger, David Dykstal, Phil Coulthard, Don Yantzi, Eric Simpson,
|
||||
* Emily Bruner, Mazen Faraj, Adrian Storisteanu, Li Ding, and Kent Hawley.
|
||||
*
|
||||
*
|
||||
* Contributors:
|
||||
* David Dykstal (IBM) - [168976][api] move ISystemNewConnectionWizardPage from core to UI
|
||||
* David Dykstal (IBM) - [226561] Add API markup to RSE javadocs for extend / implement
|
||||
|
|
@ -23,9 +23,11 @@ import org.eclipse.rse.core.subsystems.ISubSystemConfiguration;
|
|||
|
||||
/**
|
||||
* An interface used to drive properties into a subsystem during host creation.
|
||||
*
|
||||
* @noimplement This is an internal interface for use in the framework.
|
||||
* Potential clients should extend one of the implementations
|
||||
* or implement one of the extensions.
|
||||
* Potential clients should extend one of the implementations or
|
||||
* implement one of the extensions.
|
||||
* @since org.eclipse.rse.core 3.0
|
||||
*/
|
||||
public interface ISubSystemConfigurator {
|
||||
|
||||
|
|
@ -33,7 +35,7 @@ public interface ISubSystemConfigurator {
|
|||
* Return the subsystem configuration associated with these properties.
|
||||
*/
|
||||
public ISubSystemConfiguration getSubSystemConfiguration();
|
||||
|
||||
|
||||
/**
|
||||
* Apply the values herein to a subsystem.
|
||||
* @param ss the subystem to be affected.
|
||||
|
|
|
|||
|
|
@ -19,8 +19,6 @@ package org.eclipse.rse.core.model;
|
|||
|
||||
/**
|
||||
* ISystemContainer is an interface implemented by objects that can contain remote resources.
|
||||
* @noextend This interface is not intended to be extended by clients.
|
||||
* The standard extensions are included in the framework.
|
||||
* @noimplement This interface is not intended to be implemented by clients.
|
||||
* The standard implementations are included in the framework.
|
||||
* These can be extended by clients.
|
||||
|
|
|
|||
|
|
@ -30,7 +30,6 @@ import org.eclipse.rse.core.IRSEUserIdConstants;
|
|||
* that integrity of the host list is maintained even if multiple threads call
|
||||
* multiple methods in this interface concurrently.
|
||||
* </p>
|
||||
* @noextend This interface is not intended to be extended by clients.
|
||||
* @noimplement This interface is not intended to be implemented by clients.
|
||||
* The standard implementations are included in the framework.
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -19,7 +19,6 @@ package org.eclipse.rse.core.model;
|
|||
|
||||
/**
|
||||
* This interface represents a message we wish to display as child node in the tree view.
|
||||
* @noextend This interface is not intended to be extended by clients.
|
||||
* @noimplement This interface is not intended to be implemented by clients.
|
||||
* The standard implementations are included in the framework.
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -1,9 +1,9 @@
|
|||
/*********************************************************************************
|
||||
* Copyright (c) 2008 IBM Corporation. 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
|
||||
* of the Eclipse Public License v1.0 which accompanies this distribution, and is
|
||||
* available at http://www.eclipse.org/legal/epl-v10.html
|
||||
*
|
||||
*
|
||||
* Contributors:
|
||||
* David Dykstal (IBM) - [224671] [api] org.eclipse.rse.core API leaks non-API types
|
||||
* David Dykstal (IBM) - [226561] Add API markup to RSE javadocs for extend / implement
|
||||
|
|
@ -13,12 +13,14 @@ package org.eclipse.rse.core.model;
|
|||
|
||||
/**
|
||||
* A modifiable container allows its contents to be set directly.
|
||||
* @noextend This interface is not intended to be extended by clients.
|
||||
* @noimplement This interface is not intended to be implemented by clients.
|
||||
* The standard implementations are included in the framework.
|
||||
*
|
||||
* @noimplement This interface is not intended to be implemented by clients. The
|
||||
* standard implementations are included in the framework.
|
||||
*
|
||||
* @since org.eclipse.rse.core 3.0
|
||||
*/
|
||||
public interface ISystemModifiableContainer extends ISystemContainer {
|
||||
|
||||
|
||||
/**
|
||||
* Cache contents of a certain type.
|
||||
* @param type the contents type.
|
||||
|
|
|
|||
|
|
@ -38,7 +38,6 @@ import org.eclipse.rse.persistence.IRSEPersistenceProvider;
|
|||
* definitions to RSE. When made inactive, it those definition are no longer
|
||||
* available for use.
|
||||
* <p>
|
||||
* @noextend This interface is not intended to be extended by clients.
|
||||
* @noimplement This interface is not intended to be implemented by clients.
|
||||
* The standard implementations are included in the framework.
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -28,7 +28,6 @@ import org.eclipse.core.runtime.IStatus;
|
|||
* processing is not desired. If events are necessary then the system registry
|
||||
* should be used.
|
||||
*
|
||||
* @noextend This interface is not intended to be extended by clients.
|
||||
* @noimplement This interface is not intended to be implemented by clients.
|
||||
* The standard implementations are included in the framework.
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -25,7 +25,6 @@ import org.eclipse.rse.services.clientserver.messages.SystemMessage;
|
|||
/**
|
||||
* This interface is refers to a collection of any type of resources. The resources
|
||||
* may be remote RSE resources, or local workspace resources.
|
||||
* @noextend This interface is not intended to be extended by clients.
|
||||
* @noimplement This interface is not intended to be implemented by clients.
|
||||
* Extend {@link AbstractSystemResourceSet} instead.
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -7,10 +7,10 @@
|
|||
*
|
||||
* Initial Contributors:
|
||||
* The following IBM employees contributed to the Remote System Explorer
|
||||
* component that contains this file: David McKnight, Kushal Munir,
|
||||
* Michael Berger, David Dykstal, Phil Coulthard, Don Yantzi, Eric Simpson,
|
||||
* component that contains this file: David McKnight, Kushal Munir,
|
||||
* Michael Berger, David Dykstal, Phil Coulthard, Don Yantzi, Eric Simpson,
|
||||
* Emily Bruner, Mazen Faraj, Adrian Storisteanu, Li Ding, and Kent Hawley.
|
||||
*
|
||||
*
|
||||
* Contributors:
|
||||
* David Dykstal (IBM) - added javadoc, minor changes
|
||||
* David Dykstal (IBM) - [226561] Add API markup to RSE javadocs for extend / implement
|
||||
|
|
@ -19,11 +19,10 @@
|
|||
package org.eclipse.rse.core.model;
|
||||
|
||||
/**
|
||||
* The standard implementation of {@link IPropertyType}.
|
||||
* The standard implementation of {@link IPropertyType}. Use the static factory
|
||||
* methods to return instances.
|
||||
*
|
||||
* @noextend This class is not intended to be subclassed by clients.
|
||||
* @noinstantiate This class is not intended to be instantiated by clients.
|
||||
* The constructors are private.
|
||||
* Use the static factory methods to return instances.
|
||||
*/
|
||||
public class PropertyType implements IPropertyType {
|
||||
|
||||
|
|
@ -39,7 +38,7 @@ public class PropertyType implements IPropertyType {
|
|||
private PropertyType(int type) {
|
||||
_type = type;
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Returns an instance of boolean property type.
|
||||
* @return IPropertyType
|
||||
|
|
@ -47,7 +46,7 @@ public class PropertyType implements IPropertyType {
|
|||
public static IPropertyType getBooleanPropertyType() {
|
||||
return _booleanPropertyType;
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Returns an instance of integer property type.
|
||||
* @return IPropertyType
|
||||
|
|
@ -66,7 +65,7 @@ public class PropertyType implements IPropertyType {
|
|||
|
||||
/**
|
||||
* Returns an instance of enum property type.
|
||||
* @param values String[] array of allowed enumerator values.
|
||||
* @param values String[] array of allowed enumerator values.
|
||||
* @return IPropertyType
|
||||
*/
|
||||
public static IPropertyType getEnumPropertyType(String[] values) {
|
||||
|
|
|
|||
|
|
@ -48,8 +48,6 @@ package org.eclipse.rse.core.references;
|
|||
* and restore methods. If using MOF, and the containment of the manager class is modelled in
|
||||
* your own containing class, this will happen automatically when you use mof to save
|
||||
* your containing class instance.
|
||||
* @noextend This interface is not intended to be extended by clients.
|
||||
* The standard extensions are included in the framework.
|
||||
* @noimplement This interface is not intended to be implemented by clients.
|
||||
* The standard implementations are included in the framework.
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -1,15 +1,15 @@
|
|||
/********************************************************************************
|
||||
* Copyright (c) 2002, 2008 IBM Corporation. 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
|
||||
* of the Eclipse Public License v1.0 which accompanies this distribution, and is
|
||||
* available at http://www.eclipse.org/legal/epl-v10.html
|
||||
*
|
||||
*
|
||||
* Initial Contributors:
|
||||
* The following IBM employees contributed to the Remote System Explorer
|
||||
* component that contains this file: David McKnight, Kushal Munir,
|
||||
* Michael Berger, David Dykstal, Phil Coulthard, Don Yantzi, Eric Simpson,
|
||||
* component that contains this file: David McKnight, Kushal Munir,
|
||||
* Michael Berger, David Dykstal, Phil Coulthard, Don Yantzi, Eric Simpson,
|
||||
* Emily Bruner, Mazen Faraj, Adrian Storisteanu, Li Ding, and Kent Hawley.
|
||||
*
|
||||
*
|
||||
* Contributors:
|
||||
* David Dykstal (IBM) - [226561] Add API markup for noextend / noimplement where needed
|
||||
********************************************************************************/
|
||||
|
|
@ -17,30 +17,30 @@
|
|||
package org.eclipse.rse.core.references;
|
||||
|
||||
/**
|
||||
* Referenced objects are objects that have shadow objects (referencing objects) of them.
|
||||
* Typically, references are created to enable a UI which does not allow the same
|
||||
* real object to appear multiple times. In these cases, a unique reference object
|
||||
* is created for each unique instance of the real object.
|
||||
* Referenced objects are objects that have shadow objects (referencing objects)
|
||||
* of them. Typically, references are created to enable a UI which does not
|
||||
* allow the same real object to appear multiple times. In these cases, a unique
|
||||
* reference object is created for each unique instance of the real object.
|
||||
* <p>
|
||||
* The parent interface IRSEReferencedObject captures the simple set of methods
|
||||
* The parent interface IRSEReferencedObject captures the simple set of methods
|
||||
* an object that supports such a real object implement.
|
||||
* <p>
|
||||
* This interface specializes that for the case of real objects that support references
|
||||
* that must be persisted.
|
||||
* Typically, we build the references in memory at runtime to satisfy the UI.
|
||||
* However, occassionally we build the list of references for a more permanent reason,
|
||||
* such as when we let a user choose a subset from a master list.
|
||||
* This interface specializes that for the case of real objects that support
|
||||
* references that must be persisted. Typically, we build the references in
|
||||
* memory at runtime to satisfy the UI. However, occasionally we build the list
|
||||
* of references for a more permanent reason, such as when we let a user choose
|
||||
* a subset from a master list.
|
||||
* <p>
|
||||
* When we persist such a reference, we can't persist the memory reference to the master
|
||||
* object. Instead, we persist the unique name of that object, and upon restoring
|
||||
* from disk we then resolve that into a runtime reference to a real memory object.
|
||||
* When we persist such a reference, we can't persist the memory reference to
|
||||
* the master object. Instead, we persist the unique name of that object, and
|
||||
* upon restoring from disk we then resolve that into a runtime reference to a
|
||||
* real memory object.
|
||||
* <p>
|
||||
* This interface supplies the method to allow a referencing object to
|
||||
* query that unique name or key from this real object.
|
||||
* @noextend This interface is not intended to be extended by clients.
|
||||
* The standard extensions are included in the framework.
|
||||
* @noimplement This interface is not intended to be implemented by clients.
|
||||
* The standard implementations are included in the framework.
|
||||
* This interface supplies the method to allow a referencing object to query
|
||||
* that unique name or key from this real object.
|
||||
*
|
||||
* @noimplement This interface is not intended to be implemented by clients. The
|
||||
* standard implementations are included in the framework.
|
||||
*/
|
||||
public interface IRSEBasePersistableReferencedObject extends IRSEBaseReferencedObject {
|
||||
|
||||
|
|
|
|||
|
|
@ -7,10 +7,10 @@
|
|||
*
|
||||
* Initial Contributors:
|
||||
* The following IBM employees contributed to the Remote System Explorer
|
||||
* component that contains this file: David McKnight, Kushal Munir,
|
||||
* Michael Berger, David Dykstal, Phil Coulthard, Don Yantzi, Eric Simpson,
|
||||
* component that contains this file: David McKnight, Kushal Munir,
|
||||
* Michael Berger, David Dykstal, Phil Coulthard, Don Yantzi, Eric Simpson,
|
||||
* Emily Bruner, Mazen Faraj, Adrian Storisteanu, Li Ding, and Kent Hawley.
|
||||
*
|
||||
*
|
||||
* Contributors:
|
||||
* David Dykstal (IBM) - [226561] Add API markup for noextend / noimplement where needed
|
||||
*******************************************************************************/
|
||||
|
|
@ -18,28 +18,29 @@
|
|||
package org.eclipse.rse.core.references;
|
||||
|
||||
/**
|
||||
* Referencing objects are shadows of real objects. Typically, shadows are created
|
||||
* to enable a GUI which does not allow the same real object to appear multiple times.
|
||||
* In these cases, a unique shadow object is created for each unique instance of the
|
||||
* real object.
|
||||
* Referencing objects are shadows of real objects. Typically, shadows are
|
||||
* created to enable a GUI which does not allow the same real object to appear
|
||||
* multiple times. In these cases, a unique shadow object is created for each
|
||||
* unique instance of the real object.
|
||||
* <p>
|
||||
* The parent interface ISystemReferencingObject captures the simple set of methods
|
||||
* such a shadow must implement.
|
||||
* The parent interface ISystemReferencingObject captures the simple set of
|
||||
* methods such a shadow must implement.
|
||||
* <p>
|
||||
* This interface specializes that for the case of references that must be persisted.
|
||||
* Typically, we build the references in memory at runtime just to satisfy the GUI.
|
||||
* However, occassionally we build the list of references for a more permanent reason,
|
||||
* such as when we let a user choose a subset from a master list.
|
||||
* This interface specializes that for the case of references that must be
|
||||
* persisted. Typically, we build the references in memory at runtime just to
|
||||
* satisfy the GUI. However, occasionally we build the list of references for a
|
||||
* more permanent reason, such as when we let a user choose a subset from a
|
||||
* master list.
|
||||
* <p>
|
||||
* When we persist such a reference, we can't persist the memory reference to the master
|
||||
* object. Instead, we persist the unique name or key of that object, and upon restoring
|
||||
* from disk we then resolve that into a runtime reference to a real memory object.
|
||||
* When we persist such a reference, we can't persist the memory reference to
|
||||
* the master object. Instead, we persist the unique name or key of that object,
|
||||
* and upon restoring from disk we then resolve that into a runtime reference to
|
||||
* a real memory object.
|
||||
* <p>
|
||||
* This interface captures the methods to set and query that name or key.
|
||||
* @noextend This interface is not intended to be extended by clients.
|
||||
* The standard extensions are included in the framework.
|
||||
* @noimplement This interface is not intended to be implemented by clients.
|
||||
* The standard implementations are included in the framework.
|
||||
*
|
||||
* @noimplement This interface is not intended to be implemented by clients. The
|
||||
* standard implementations are included in the framework.
|
||||
*/
|
||||
public interface IRSEBasePersistableReferencingObject extends IRSEBaseReferencingObject {
|
||||
/**
|
||||
|
|
|
|||
|
|
@ -19,8 +19,6 @@ package org.eclipse.rse.core.references;
|
|||
|
||||
/**
|
||||
* Interface that any master object that is referenced must implement.
|
||||
* @noextend This interface is not intended to be extended by clients.
|
||||
* The standard extensions are included in the framework.
|
||||
* @noimplement This interface is not intended to be implemented by clients.
|
||||
* The standard implementations are included in the framework.
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -24,8 +24,6 @@ package org.eclipse.rse.core.references;
|
|||
* real object.
|
||||
* <p>
|
||||
* This interface captures the simple set of methods such a shadow must implement.
|
||||
* @noextend This interface is not intended to be extended by clients.
|
||||
* The standard extensions are included in the framework.
|
||||
* @noimplement This interface is not intended to be implemented by clients.
|
||||
* The standard implementations are included in the framework.
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -19,8 +19,6 @@ package org.eclipse.rse.core.references;
|
|||
/**
|
||||
* This is an object that can have shadow (reference) objects, which simply
|
||||
* point to this object, and a copy of this object's unique name or key (for storing on disk).
|
||||
* @noextend This interface is not intended to be extended by clients.
|
||||
* The standard extensions are included in the framework.
|
||||
* @noimplement This interface is not intended to be implemented by clients.
|
||||
* The standard implementations are included in the framework.
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -34,8 +34,6 @@ package org.eclipse.rse.core.references;
|
|||
* and manage the saving/restoring of that list.
|
||||
* <p>
|
||||
* <b>YOU MUST OVERRIDE resolveReferencesAfterRestore IN YOUR REFERENCE MANAGER SUBCLASS</b>
|
||||
* @noextend This interface is not intended to be extended by clients.
|
||||
* The standard extensions are included in the framework.
|
||||
* @noimplement This interface is not intended to be implemented by clients.
|
||||
* The standard implementations are included in the framework.
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -25,8 +25,6 @@ package org.eclipse.rse.core.references;
|
|||
* <p>
|
||||
* These references are not persistent. Persistent references are managed
|
||||
* by the subtype IRSEPersistableReferencedObject.
|
||||
* @noextend This interface is not intended to be extended by clients.
|
||||
* The standard extensions are included in the framework.
|
||||
* @noimplement This interface is not intended to be implemented by clients.
|
||||
* The standard implementations are included in the framework.
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -27,8 +27,6 @@ package org.eclipse.rse.core.references;
|
|||
* <p>
|
||||
* These references are not persistent. Persistent references are managed
|
||||
* by the subclass SystemPersistableReferencingObject.
|
||||
* @noextend This interface is not intended to be extended by clients.
|
||||
* The standard extensions are included in the framework.
|
||||
* @noimplement This interface is not intended to be implemented by clients.
|
||||
* The standard implementations are included in the framework.
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -1,15 +1,15 @@
|
|||
/********************************************************************************
|
||||
* Copyright (c) 2002, 2008 IBM Corporation. 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
|
||||
* of the Eclipse Public License v1.0 which accompanies this distribution, and is
|
||||
* available at http://www.eclipse.org/legal/epl-v10.html
|
||||
*
|
||||
*
|
||||
* Initial Contributors:
|
||||
* The following IBM employees contributed to the Remote System Explorer
|
||||
* component that contains this file: David McKnight, Kushal Munir,
|
||||
* Michael Berger, David Dykstal, Phil Coulthard, Don Yantzi, Eric Simpson,
|
||||
* component that contains this file: David McKnight, Kushal Munir,
|
||||
* Michael Berger, David Dykstal, Phil Coulthard, Don Yantzi, Eric Simpson,
|
||||
* Emily Bruner, Mazen Faraj, Adrian Storisteanu, Li Ding, and Kent Hawley.
|
||||
*
|
||||
*
|
||||
* Contributors:
|
||||
* David Dykstal (IBM) - [224671] [api] org.eclipse.rse.core API leaks non-API types
|
||||
* David Dykstal (IBM) - [226561] Add API markup for noextend / noimplement where needed
|
||||
|
|
@ -20,13 +20,15 @@ package org.eclipse.rse.core.references;
|
|||
import org.eclipse.rse.core.model.RSEModelObject;
|
||||
|
||||
/**
|
||||
* A class to encapsulate the operations required of an object which
|
||||
* supports references to it by other objects ({@link SystemReferencingObject}).
|
||||
* This type of class needs to support maintaining an in-memory list of
|
||||
* all who reference it so that list can be following on delete and
|
||||
* rename operations.
|
||||
* @noextend This class is not intended to be subclassed by clients.
|
||||
* The standard extensions are included in the framework.
|
||||
* A class to encapsulate the operations required of an object which supports
|
||||
* references to it by other objects ({@link SystemReferencingObject}). This
|
||||
* type of class needs to support maintaining an in-memory list of all who
|
||||
* reference it so that list can be following on delete and rename operations.
|
||||
*
|
||||
* @noextend This class is not intended to be subclassed by clients. The
|
||||
* standard extensions are included in the framework.
|
||||
*
|
||||
* @since org.eclipse.rse.core 3.0
|
||||
*/
|
||||
public abstract class SystemReferencedObject extends RSEModelObject implements IRSEReferencedObject {
|
||||
|
||||
|
|
|
|||
|
|
@ -7,10 +7,10 @@
|
|||
*
|
||||
* Initial Contributors:
|
||||
* The following IBM employees contributed to the Remote System Explorer
|
||||
* component that contains this file: David McKnight, Kushal Munir,
|
||||
* Michael Berger, David Dykstal, Phil Coulthard, Don Yantzi, Eric Simpson,
|
||||
* component that contains this file: David McKnight, Kushal Munir,
|
||||
* Michael Berger, David Dykstal, Phil Coulthard, Don Yantzi, Eric Simpson,
|
||||
* Emily Bruner, Mazen Faraj, Adrian Storisteanu, Li Ding, and Kent Hawley.
|
||||
*
|
||||
*
|
||||
* Contributors:
|
||||
* David Dykstal (IBM) - [224671] [api] org.eclipse.rse.core API leaks non-API types
|
||||
* David Dykstal (IBM) - [226561] Add API markup for noextend / noimplement where needed
|
||||
|
|
@ -21,11 +21,12 @@ package org.eclipse.rse.core.references;
|
|||
import java.util.Vector;
|
||||
|
||||
/**
|
||||
* The class should be used by subclasses of {@link SystemReferencedObject} by instantiating it and delegating to it.
|
||||
* @noextend This class is not intended to be subclassed by clients.
|
||||
* The standard extensions are included in the framework.
|
||||
* @noinstantiate This class is not intended to be instantiated by clients.
|
||||
* The standard instances are created by the framework.
|
||||
* The class should be used by subclasses of {@link SystemReferencedObject} by
|
||||
* instantiating it and delegating to it.
|
||||
*
|
||||
* @noextend This class is not intended to be subclassed by clients. The
|
||||
* standard extensions are included in the framework.
|
||||
* @since org.eclipse.rse.core 3.0
|
||||
*/
|
||||
public class SystemReferencedObjectHelper {
|
||||
|
||||
|
|
|
|||
|
|
@ -1,15 +1,15 @@
|
|||
/********************************************************************************
|
||||
* Copyright (c) 2002, 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
|
||||
* of the Eclipse Public License v1.0 which accompanies this distribution, and is
|
||||
* available at http://www.eclipse.org/legal/epl-v10.html
|
||||
*
|
||||
*
|
||||
* Initial Contributors:
|
||||
* The following IBM employees contributed to the Remote System Explorer
|
||||
* component that contains this file: David McKnight, Kushal Munir,
|
||||
* Michael Berger, David Dykstal, Phil Coulthard, Don Yantzi, Eric Simpson,
|
||||
* component that contains this file: David McKnight, Kushal Munir,
|
||||
* Michael Berger, David Dykstal, Phil Coulthard, Don Yantzi, Eric Simpson,
|
||||
* Emily Bruner, Mazen Faraj, Adrian Storisteanu, Li Ding, and Kent Hawley.
|
||||
*
|
||||
*
|
||||
* Contributors:
|
||||
* Martin Oberhuber (Wind River) - [184095] Replace systemTypeName by IRSESystemType
|
||||
* David Dykstal (IBM) - [224671] [api] org.eclipse.rse.core API leaks non-API types
|
||||
|
|
@ -22,14 +22,16 @@ import org.eclipse.rse.core.model.RSEModelObject;
|
|||
import org.eclipse.rse.internal.core.RSECoreMessages;
|
||||
|
||||
/**
|
||||
* A class to encapsulate the operations required of an object which
|
||||
* is merely a reference to another object, something we call a shadow.
|
||||
* Such shadows are needed to support a UI which displays the same
|
||||
* object in multiple places. To enable that, it is necessary not to
|
||||
* use the same physical object in each UI representation as the UI
|
||||
* will only know how to update/refresh the first one it finds.
|
||||
* @noextend This class is not intended to be subclassed by clients.
|
||||
* The standard extensions are included in the framework.
|
||||
* A class to encapsulate the operations required of an object which is merely a
|
||||
* reference to another object, something we call a shadow. Such shadows are
|
||||
* needed to support a UI which displays the same object in multiple places. To
|
||||
* enable that, it is necessary not to use the same physical object in each UI
|
||||
* representation as the UI will only know how to update/refresh the first one
|
||||
* it finds.
|
||||
*
|
||||
* @noextend This class is not intended to be subclassed by clients. The
|
||||
* standard extensions are included in the framework.
|
||||
* @since org.eclipse.rse.core 3.0
|
||||
*/
|
||||
public abstract class SystemReferencingObject extends RSEModelObject implements IRSEReferencingObject {
|
||||
private SystemReferencingObjectHelper helper = null;
|
||||
|
|
|
|||
|
|
@ -7,10 +7,10 @@
|
|||
*
|
||||
* Initial Contributors:
|
||||
* The following IBM employees contributed to the Remote System Explorer
|
||||
* component that contains this file: David McKnight, Kushal Munir,
|
||||
* Michael Berger, David Dykstal, Phil Coulthard, Don Yantzi, Eric Simpson,
|
||||
* component that contains this file: David McKnight, Kushal Munir,
|
||||
* Michael Berger, David Dykstal, Phil Coulthard, Don Yantzi, Eric Simpson,
|
||||
* Emily Bruner, Mazen Faraj, Adrian Storisteanu, Li Ding, and Kent Hawley.
|
||||
*
|
||||
*
|
||||
* Contributors:
|
||||
* David Dykstal (IBM) - [224671] [api] org.eclipse.rse.core API leaks non-API types
|
||||
* David Dykstal (IBM) - [226561] Add API markup for noextend / noimplement where needed
|
||||
|
|
@ -20,11 +20,14 @@ package org.eclipse.rse.core.references;
|
|||
|
||||
|
||||
/**
|
||||
* The class should be used by subclasses of {@link SystemReferencingObject} by instantiating it and delegating to it.
|
||||
* @noextend This class is not intended to be subclassed by clients.
|
||||
* The standard extensions are included in the framework.
|
||||
* @noinstantiate This class is not intended to be instantiated by clients.
|
||||
* The standard instances are created by the framework.
|
||||
* The class should be used by subclasses of {@link SystemReferencingObject} by
|
||||
* instantiating it and delegating to it.
|
||||
*
|
||||
* @noextend This class is not intended to be subclassed by clients. The
|
||||
* standard extensions are included in the framework.
|
||||
* @noinstantiate This class is not intended to be instantiated by clients. The
|
||||
* standard instances are created by the framework.
|
||||
* @since org.eclipse.rse.core 3.0
|
||||
*/
|
||||
public class SystemReferencingObjectHelper {
|
||||
|
||||
|
|
@ -33,7 +36,7 @@ public class SystemReferencingObjectHelper {
|
|||
|
||||
/**
|
||||
* Default constructor.
|
||||
* @param caller the reference that this object is helping.
|
||||
* @param caller the reference that this object is helping.
|
||||
*/
|
||||
public SystemReferencingObjectHelper(IRSEBaseReferencingObject caller) {
|
||||
super();
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue