mirror of
https://github.com/eclipse-cdt/cdt
synced 2025-07-24 17:35:35 +02:00
[226561][apidoc] Add API markup to RSE Javadocs where extend / implement is allowed
https://bugs.eclipse.org/bugs/show_bug.cgi?id=226561
This commit is contained in:
David Dykstal
parent
1d82ed5997
commit
e629ff7634
38 changed files with 182 additions and 58 deletions
|
|
@ -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.
|
||||
* David Dykstal (IBM) - [226561] Add API markup to RSE javadocs for extend / implement
|
||||
*******************************************************************************/
|
||||
|
||||
package org.eclipse.rse.core.model;
|
||||
|
|
@ -23,11 +23,10 @@ import java.util.List;
|
|||
import org.eclipse.rse.services.clientserver.messages.SystemMessage;
|
||||
|
||||
/**
|
||||
* The common abstract implementation of a ISystemResourceSet. Extenders
|
||||
* can use this to inherit the basic implementations.
|
||||
*
|
||||
* The common abstract implementation of a ISystemResourceSet.
|
||||
* Extenders can use this to inherit the basic implementations.
|
||||
*/
|
||||
public class AbstractSystemResourceSet implements ISystemResourceSet {
|
||||
public abstract class AbstractSystemResourceSet implements ISystemResourceSet {
|
||||
private List _resourceSet;
|
||||
private SystemMessage _message;
|
||||
private long _byteSize;
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
/********************************************************************************
|
||||
* Copyright (c) 2006, 2007 IBM Corporation and others. All rights reserved.
|
||||
* 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 http://www.eclipse.org/legal/epl-v10.html
|
||||
|
|
@ -13,6 +13,7 @@
|
|||
* Contributors:
|
||||
* Martin Oberhuber (Wind River) - [175262] IHost.getSystemType() should return IRSESystemType
|
||||
* David Dykstal (IBM) - 142806: refactoring persistence framework
|
||||
* David Dykstal (IBM) - [226561] Add API markup to RSE javadocs for extend / implement
|
||||
********************************************************************************/
|
||||
|
||||
package org.eclipse.rse.core.model;
|
||||
|
|
@ -21,6 +22,10 @@ import org.eclipse.rse.core.IRSESystemType;
|
|||
import org.eclipse.rse.core.subsystems.IConnectorService;
|
||||
import org.eclipse.rse.core.subsystems.ISubSystem;
|
||||
|
||||
/**
|
||||
* A DummyHost is used as a placeholder during the construction of hosts by wizards.
|
||||
* @noextend This class is not intended to be subclassed by clients.
|
||||
*/
|
||||
public class DummyHost extends PlatformObject implements IHost
|
||||
{
|
||||
protected String _hostName;
|
||||
|
|
|
|||
|
|
@ -15,6 +15,7 @@
|
|||
* Martin Oberhuber (Wind River) - [175262] IHost.getSystemType() should return IRSESystemType
|
||||
* Martin Oberhuber (Wind River) - [206742] Make SystemHostPool thread-safe
|
||||
* David Dykstal (IBM) - [197036] cleaned javddoc for getConnectorServices()
|
||||
* David Dykstal (IBM) - [226561] Add API markup to RSE javadocs for extend / implement
|
||||
*******************************************************************************/
|
||||
|
||||
package org.eclipse.rse.core.model;
|
||||
|
|
@ -30,6 +31,9 @@ import org.eclipse.rse.core.subsystems.ISubSystem;
|
|||
* An IHost holds information identifying a remote system. It also logically contains
|
||||
* ISubSystem objects, although this containment is achievable programmatically versus via
|
||||
* object oriented containment.
|
||||
* @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.
|
||||
*/
|
||||
public interface IHost extends IAdaptable, IRSEModelObject {
|
||||
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
/********************************************************************************
|
||||
* Copyright (c) 2006, 2007 IBM Corporation. All rights reserved.
|
||||
* 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
|
||||
* available at http://www.eclipse.org/legal/epl-v10.html
|
||||
|
|
@ -13,6 +13,7 @@
|
|||
* Contributors:
|
||||
* David Dykstal (IBM) - added javadoc
|
||||
* David Dykstal (IBM) - [150939] added read-only attribute
|
||||
* David Dykstal (IBM) - [226561] Add API markup to RSE javadocs for extend / implement
|
||||
********************************************************************************/
|
||||
|
||||
package org.eclipse.rse.core.model;
|
||||
|
|
@ -22,6 +23,9 @@ 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 {
|
||||
|
||||
|
|
|
|||
|
|
@ -14,6 +14,7 @@
|
|||
* Contributors:
|
||||
* Martin Oberhuber (Wind River) - Added Javadoc.
|
||||
* David McKnight (IBM) - [217715] [api] RSE property sets should support nested property sets
|
||||
* David Dykstal (IBM) - [226561] Add API markup to RSE javadocs for extend / implement
|
||||
*******************************************************************************/
|
||||
|
||||
package org.eclipse.rse.core.model;
|
||||
|
|
@ -31,6 +32,9 @@ import java.util.Map;
|
|||
*
|
||||
* 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 {
|
||||
/**
|
||||
|
|
|
|||
|
|
@ -13,6 +13,7 @@
|
|||
*
|
||||
* Contributors:
|
||||
* Johann Draschwandtner (Wind River) - [227509][apidoc] Add note how to persist property sets
|
||||
* David Dykstal (IBM) - [226561] Add API markup to RSE javadocs for extend / implement
|
||||
*******************************************************************************/
|
||||
|
||||
package org.eclipse.rse.core.model;
|
||||
|
|
@ -21,6 +22,9 @@ 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.
|
||||
*/
|
||||
public interface IPropertySetContainer {
|
||||
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
/********************************************************************************
|
||||
* Copyright (c) 2006, 2007 IBM Corporation. All rights reserved.
|
||||
* 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
|
||||
* available at http://www.eclipse.org/legal/epl-v10.html
|
||||
|
|
@ -12,12 +12,16 @@
|
|||
*
|
||||
* Contributors:
|
||||
* David Dykstal (IBM) - added javadoc
|
||||
* David Dykstal (IBM) - [226561] Add API markup to RSE javadocs for extend / implement
|
||||
********************************************************************************/
|
||||
|
||||
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.
|
||||
*/
|
||||
public interface IPropertyType {
|
||||
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
/********************************************************************************
|
||||
* Copyright (c) 2007 IBM Corporation. All rights reserved.
|
||||
* Copyright (c) 2007, 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
|
||||
* available at http://www.eclipse.org/legal/epl-v10.html
|
||||
|
|
@ -9,12 +9,16 @@
|
|||
* component that contains this file: David McKnight.
|
||||
*
|
||||
* Contributors:
|
||||
* {Name} (company) - description of contribution.
|
||||
* David Dykstal (IBM) - [226561] Add API markup to RSE javadocs for extend / implement
|
||||
********************************************************************************/
|
||||
package org.eclipse.rse.core.model;
|
||||
|
||||
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 {
|
||||
|
||||
public void done(IStatus status, Object result);
|
||||
|
|
|
|||
|
|
@ -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,14 +12,21 @@
|
|||
* Emily Bruner, Mazen Faraj, Adrian Storisteanu, Li Ding, and Kent Hawley.
|
||||
*
|
||||
* Contributors:
|
||||
* {Name} (company) - description of contribution.
|
||||
* David Dykstal (IBM) - [226561] Add API markup to RSE javadocs for extend / implement
|
||||
*******************************************************************************/
|
||||
|
||||
package org.eclipse.rse.core.model;
|
||||
|
||||
|
||||
/**
|
||||
* IRSEModelObject is the root type of all objects in the RSE model.
|
||||
* @noimplement This interface is not intended to be implemented by clients.
|
||||
* The standard implementations are included in the framework.
|
||||
*/
|
||||
public interface IRSEModelObject extends IPropertySetContainer, IRSEPersistableContainer {
|
||||
|
||||
String getName();
|
||||
|
||||
String getDescription();
|
||||
|
||||
}
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
/********************************************************************************
|
||||
* Copyright (c) 2006, 2007 IBM Corporation. All rights reserved.
|
||||
* 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
|
||||
* available at http://www.eclipse.org/legal/epl-v10.html
|
||||
|
|
@ -13,6 +13,7 @@
|
|||
* Contributors:
|
||||
* David Dykstal (IBM) - adding new persistence support
|
||||
* David Dykstal (IBM) - 142806: refactoring persistence framework
|
||||
* David Dykstal (IBM) - [226561] Add API markup to RSE javadocs for extend / implement
|
||||
********************************************************************************/
|
||||
|
||||
package org.eclipse.rse.core.model;
|
||||
|
|
@ -24,6 +25,10 @@ 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.
|
||||
*/
|
||||
public interface IRSEPersistableContainer {
|
||||
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
/*******************************************************************************
|
||||
* Copyright (c) 2000, 2007 IBM Corporation and others.
|
||||
* Copyright (c) 2000, 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.
|
||||
* David Dykstal (IBM) - [226561] Add API markup to RSE javadocs for extend / implement
|
||||
*******************************************************************************/
|
||||
|
||||
package org.eclipse.rse.core.model;
|
||||
|
|
@ -20,6 +20,9 @@ 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.
|
||||
* @noimplement This interface is not intended to be implemented by clients.
|
||||
* This is a constant interface. The individual items should be referenced directly.
|
||||
*/
|
||||
public interface ISubSystemConfigurationCategories {
|
||||
/**
|
||||
|
|
|
|||
|
|
@ -13,6 +13,7 @@
|
|||
*
|
||||
* 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
|
||||
*******************************************************************************/
|
||||
|
||||
package org.eclipse.rse.core.model;
|
||||
|
|
@ -22,8 +23,9 @@ 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
|
||||
* subclasses.
|
||||
* @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.
|
||||
*/
|
||||
public interface ISubSystemConfigurator {
|
||||
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
/*******************************************************************************
|
||||
* Copyright (c) 2004, 2007 IBM Corporation and others.
|
||||
* Copyright (c) 2004, 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,13 +12,18 @@
|
|||
* Emily Bruner, Mazen Faraj, Adrian Storisteanu, Li Ding, and Kent Hawley.
|
||||
*
|
||||
* Contributors:
|
||||
* {Name} (company) - description of contribution.
|
||||
* David Dykstal (IBM) - [226561] Add API markup to RSE javadocs for extend / implement
|
||||
*******************************************************************************/
|
||||
|
||||
package org.eclipse.rse.core.model;
|
||||
|
||||
/**
|
||||
* @author dmcknigh
|
||||
* 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.
|
||||
*/
|
||||
public interface ISystemContainer {
|
||||
|
||||
|
|
|
|||
|
|
@ -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,14 +12,15 @@
|
|||
* Emily Bruner, Mazen Faraj, Adrian Storisteanu, Li Ding, and Kent Hawley.
|
||||
*
|
||||
* Contributors:
|
||||
* {Name} (company) - description of contribution.
|
||||
* David Dykstal (IBM) - [226561] Add API markup to RSE javadocs for extend / implement
|
||||
*******************************************************************************/
|
||||
|
||||
package org.eclipse.rse.core.model;
|
||||
|
||||
/*
|
||||
/**
|
||||
* Common interface for representing different contents types of
|
||||
* artifacts that can be stored in an IRemoteContainer
|
||||
* artifacts that can be stored in an IRemoteContainer.
|
||||
* @noextend This interface is not intended to be extended by clients.
|
||||
*/
|
||||
public interface ISystemContentsType {
|
||||
/*
|
||||
|
|
|
|||
|
|
@ -14,6 +14,7 @@
|
|||
* Martin Oberhuber (Wind River) - [184095] Replace systemTypeName by IRSESystemType
|
||||
* Martin Oberhuber (Wind River) - [210534] Remove ISystemHostPool.getHostList() and setName()
|
||||
* David Dykstal (IBM) - [210537] removed exception signalling from this interface, no longer needed
|
||||
* David Dykstal (IBM) - [226561] Add API markup to RSE javadocs for extend / implement
|
||||
********************************************************************************/
|
||||
|
||||
package org.eclipse.rse.core.model;
|
||||
|
|
@ -29,7 +30,9 @@ 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.
|
||||
*/
|
||||
public interface ISystemHostPool extends IRSEPersistableContainer {
|
||||
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
/*******************************************************************************
|
||||
* Copyright (c) 2002, 2007 IBM Corporation and others.
|
||||
* 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 available at
|
||||
|
|
@ -12,13 +12,16 @@
|
|||
* Emily Bruner, Mazen Faraj, Adrian Storisteanu, Li Ding, and Kent Hawley.
|
||||
*
|
||||
* Contributors:
|
||||
* {Name} (company) - description of contribution.
|
||||
* David Dykstal (IBM) - [226561] Add API markup to RSE javadocs for extend / implement
|
||||
*******************************************************************************/
|
||||
|
||||
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.
|
||||
*/
|
||||
public interface ISystemMessageObject {
|
||||
/**
|
||||
|
|
|
|||
|
|
@ -6,12 +6,16 @@
|
|||
*
|
||||
* 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
|
||||
*********************************************************************************/
|
||||
|
||||
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.
|
||||
*/
|
||||
public interface ISystemModifiableContainer extends ISystemContainer {
|
||||
|
||||
|
|
|
|||
|
|
@ -18,6 +18,7 @@
|
|||
* cleaned javadoc for getFilterPools()
|
||||
* David Dykstal (IBM) - [202630] getDefaultPrivateProfile() and ensureDefaultPrivateProfile() are inconsistent
|
||||
* David Dykstal (IBM) - [200735][Persistence] Delete a profile that contains a connection and restart, profile is back without connections
|
||||
* David Dykstal (IBM) - [226561] Add API markup to RSE javadocs for extend / implement
|
||||
*******************************************************************************/
|
||||
|
||||
package org.eclipse.rse.core.model;
|
||||
|
|
@ -37,7 +38,9 @@ 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.
|
||||
*/
|
||||
public interface ISystemProfile extends IRSEModelObject {
|
||||
|
||||
|
|
|
|||
|
|
@ -15,6 +15,7 @@
|
|||
* David Dykstal (IBM) - [197036] added commitSystemProfile operation to interface
|
||||
* David Dykstal (IBM) - [202630] getDefaultPrivateProfile() and ensureDefaultPrivateProfile() are inconsistent
|
||||
* Martin Oberhuber (Wind River) - [cleanup] Add API "since" Javadoc tags
|
||||
* David Dykstal (IBM) - [226561] Add API markup to RSE javadocs for extend / implement
|
||||
*******************************************************************************/
|
||||
|
||||
package org.eclipse.rse.core.model;
|
||||
|
|
@ -27,7 +28,9 @@ 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.
|
||||
*/
|
||||
public interface ISystemProfileManager {
|
||||
|
||||
|
|
|
|||
|
|
@ -27,6 +27,7 @@
|
|||
* David Dykstal (IBM) - [202630] getDefaultPrivateProfile() and ensureDefaultPrivateProfile() are inconsistent
|
||||
* Martin Oberhuber (Wind River) - [cleanup] Add API "since" Javadoc tags
|
||||
* David Dykstal (IBM) - [168976][api] move ISystemNewConnectionWizardPage from core to UI
|
||||
* David Dykstal (IBM) - [226561] Add API markup to RSE javadocs for extend / implement
|
||||
********************************************************************************/
|
||||
|
||||
package org.eclipse.rse.core.model;
|
||||
|
|
@ -63,6 +64,7 @@ import org.eclipse.rse.internal.core.RSECoreRegistry;
|
|||
* each active profile are worked with.
|
||||
* </p>
|
||||
* @noimplement This interface is not intended to be implemented by clients.
|
||||
* The standard implementations are included in the framework.
|
||||
*/
|
||||
public interface ISystemRegistry extends ISchedulingRule, IAdaptable, ISystemViewInputProvider {
|
||||
|
||||
|
|
|
|||
|
|
@ -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.
|
||||
* David Dykstal (IBM) - [226561] Add API markup to RSE javadocs for extend / implement
|
||||
*******************************************************************************/
|
||||
|
||||
package org.eclipse.rse.core.model;
|
||||
|
|
@ -25,7 +25,9 @@ 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.
|
||||
*/
|
||||
public interface ISystemResourceSet {
|
||||
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
/********************************************************************************
|
||||
* Copyright (c) 2006, 2007 IBM Corporation. All rights reserved.
|
||||
* 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
|
||||
* available at http://www.eclipse.org/legal/epl-v10.html
|
||||
|
|
@ -13,12 +13,18 @@
|
|||
* Contributors:
|
||||
* David Dykstal (IBM) - added javadoc
|
||||
* David Dykstal (IBM) - [150939] added read-only attribute
|
||||
* David Dykstal (IBM) - [226561] Add API markup to RSE javadocs for extend / implement
|
||||
********************************************************************************/
|
||||
|
||||
package org.eclipse.rse.core.model;
|
||||
|
||||
import java.util.Observable;
|
||||
|
||||
/**
|
||||
* A Property is used in PropertySets and may be persisted as a result of persisting the
|
||||
* containing set. Each property has a type, a label, a key and a value.
|
||||
* @noextend This class is not intended to be subclassed by clients.
|
||||
*/
|
||||
public class Property extends Observable implements IProperty {
|
||||
|
||||
private String _name;
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
/*******************************************************************************
|
||||
* Copyright (c) 2007 IBM Corporation and others.
|
||||
* Copyright (c) 2007, 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
|
||||
|
|
@ -7,6 +7,7 @@
|
|||
*
|
||||
* Contributors:
|
||||
* IBM Corporation - initial API and implementation
|
||||
* David Dykstal (IBM) - [226561] Add API markup to RSE javadocs for extend / implement
|
||||
*******************************************************************************/
|
||||
package org.eclipse.rse.core.model;
|
||||
|
||||
|
|
@ -15,8 +16,9 @@ import java.util.List;
|
|||
import java.util.Map;
|
||||
|
||||
/**
|
||||
* A property list is an ordered property set. As items are added and removed their arrival order is
|
||||
* maintained.
|
||||
* A property list is an ordered property set.
|
||||
* As items are added and removed their arrival order is maintained.
|
||||
* @noextend This class is not intended to be subclassed by clients.
|
||||
*/
|
||||
public class PropertyList extends PropertySet {
|
||||
|
||||
|
|
|
|||
|
|
@ -14,6 +14,7 @@
|
|||
* Contributors:
|
||||
* Martin Oberhuber (Wind River) - Added Javadoc.
|
||||
* David McKnight (IBM) - [217715] [api] RSE property sets should support nested property sets
|
||||
* David Dykstal (IBM) - [226561] Add API markup to RSE javadocs for extend / implement
|
||||
*******************************************************************************/
|
||||
|
||||
package org.eclipse.rse.core.model;
|
||||
|
|
@ -30,6 +31,8 @@ import java.util.Set;
|
|||
*
|
||||
* Not thread-safe since the underlying {@link java.util.HashMap} is
|
||||
* not thread-safe.
|
||||
* @noextend This class is not intended to be subclassed by clients.
|
||||
* The standard extensions are included in the framework.
|
||||
*/
|
||||
public class PropertySet extends RSEModelObject implements IPropertySet, IRSEModelObject, ILabeledObject, Observer {
|
||||
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
/********************************************************************************
|
||||
* Copyright (c) 2006, 2007 IBM Corporation. All rights reserved.
|
||||
* 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
|
||||
* available at http://www.eclipse.org/legal/epl-v10.html
|
||||
|
|
@ -12,6 +12,7 @@
|
|||
*
|
||||
* Contributors:
|
||||
* David Dykstal (IBM) - 142806: refactoring persistence framework
|
||||
* David Dykstal (IBM) - [226561] Add API markup to RSE javadocs for extend / implement
|
||||
********************************************************************************/
|
||||
|
||||
package org.eclipse.rse.core.model;
|
||||
|
|
@ -22,6 +23,11 @@ import java.util.Iterator;
|
|||
import java.util.List;
|
||||
import java.util.Map;
|
||||
|
||||
/**
|
||||
* A PropertySetContainer is capable of holding multiple named property sets.
|
||||
* @noextend This class is not intended to be subclassed by clients.
|
||||
* The standard extensions are included in the framework.
|
||||
*/
|
||||
public abstract class PropertySetContainer extends RSEPersistableObject implements IPropertySetContainer {
|
||||
private Map _propertySets;
|
||||
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
|
@ -13,12 +13,15 @@
|
|||
*
|
||||
* Contributors:
|
||||
* David Dykstal (IBM) - added javadoc, minor changes
|
||||
* David Dykstal (IBM) - [226561] Add API markup to RSE javadocs for extend / implement
|
||||
*******************************************************************************/
|
||||
|
||||
package org.eclipse.rse.core.model;
|
||||
|
||||
/**
|
||||
* The standard implementation of {@link IPropertyType}.
|
||||
* @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.
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
/********************************************************************************
|
||||
* Copyright (c) 2006, 2007 IBM Corporation and others. All rights reserved.
|
||||
* 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 http://www.eclipse.org/legal/epl-v10.html
|
||||
|
|
@ -13,6 +13,7 @@
|
|||
* Contributors:
|
||||
* David Dykstal (IBM) - 142806: refactoring persistence framework
|
||||
* Martin Oberhuber (Wind River) - [184095] Replace systemTypeName by IRSESystemType
|
||||
* David Dykstal (IBM) - [226561] Add API markup to RSE javadocs for extend / implement
|
||||
********************************************************************************/
|
||||
|
||||
package org.eclipse.rse.core.model;
|
||||
|
|
@ -20,10 +21,8 @@ package org.eclipse.rse.core.model;
|
|||
import org.eclipse.rse.internal.core.RSECoreMessages;
|
||||
|
||||
/**
|
||||
* Provides common support for local RSE model objects
|
||||
* Extenders inherit property set support
|
||||
* @author dmcknigh
|
||||
*
|
||||
* Provides common support for local RSE model objects.
|
||||
* Extenders inherit property set support.
|
||||
*/
|
||||
public abstract class RSEModelObject extends PropertySetContainer implements IRSEModelObject {
|
||||
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
/*******************************************************************************
|
||||
* Copyright (c) 2007 IBM Corporation and others.
|
||||
* Copyright (c) 2007, 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
|
||||
|
|
@ -7,9 +7,17 @@
|
|||
*
|
||||
* Contributors:
|
||||
* IBM Corporation - initial API and implementation
|
||||
* David Dykstal (IBM) - [226561] Add API markup to RSE javadocs for extend / implement
|
||||
*******************************************************************************/
|
||||
package org.eclipse.rse.core.model;
|
||||
|
||||
/**
|
||||
* An object that keeps track of its persistable state:
|
||||
* whether it is dirty or not and whether or not
|
||||
* any of its progeny are marked dirty.
|
||||
* @noextend This class is not intended to be subclassed by clients.
|
||||
* The standard extensions are included in the framework.
|
||||
*/
|
||||
public abstract class RSEPersistableObject implements IRSEPersistableContainer {
|
||||
|
||||
private boolean _isDirty = false;
|
||||
|
|
|
|||
|
|
@ -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,13 +12,16 @@
|
|||
* Emily Bruner, Mazen Faraj, Adrian Storisteanu, Li Ding, and Kent Hawley.
|
||||
*
|
||||
* Contributors:
|
||||
* {Name} (company) - description of contribution.
|
||||
* David Dykstal (IBM) - [226561] Add API markup to RSE javadocs for extend / implement
|
||||
*******************************************************************************/
|
||||
|
||||
package org.eclipse.rse.core.model;
|
||||
|
||||
/**
|
||||
* Represents contents that are children of a container
|
||||
* Represents contents that are children of a container.
|
||||
* This is a singleton class representing a contents type.
|
||||
* @noextend This class is not intended to be subclassed by clients.
|
||||
* @noinstantiate This class is not intended to be instantiated by clients.
|
||||
*/
|
||||
public class SystemChildrenContentsType implements ISystemContentsType {
|
||||
public static String CONTENTS_TYPE_CHILDREN = "contents_children"; //$NON-NLS-1$
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
/********************************************************************************
|
||||
* Copyright (c) 2002, 2007 IBM Corporation and others. All rights reserved.
|
||||
* 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
|
||||
* available at http://www.eclipse.org/legal/epl-v10.html
|
||||
|
|
@ -12,10 +12,15 @@
|
|||
*
|
||||
* Contributors:
|
||||
* Martin Oberhuber (Wind River) - [168975] Move RSE Events API to Core
|
||||
* David Dykstal (IBM) - [226561] Add API markup to RSE javadocs for extend / implement
|
||||
********************************************************************************/
|
||||
|
||||
package org.eclipse.rse.core.model;
|
||||
|
||||
/**
|
||||
* This is a utility class used in the construction of file names.
|
||||
* @noextend This class is not intended to be subclassed by clients.
|
||||
*/
|
||||
public class SystemEscapeCharHelper {
|
||||
|
||||
private static char ESCAPE_CHAR = '#';
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
/*******************************************************************************
|
||||
* Copyright (c) 2004, 2007 IBM Corporation and others.
|
||||
* Copyright (c) 2004, 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,13 +12,16 @@
|
|||
* Emily Bruner, Mazen Faraj, Adrian Storisteanu, Li Ding, and Kent Hawley.
|
||||
*
|
||||
* Contributors:
|
||||
* {Name} (company) - description of contribution.
|
||||
* David Dykstal (IBM) - [226561] Add API markup to RSE javadocs for extend / implement
|
||||
*******************************************************************************/
|
||||
|
||||
package org.eclipse.rse.core.model;
|
||||
|
||||
/**
|
||||
* Represents contents that are children of a container
|
||||
* Represents contents that are children of a container.
|
||||
* This is a singleton class representing a contents type.
|
||||
* @noextend This class is not intended to be subclassed by clients.
|
||||
* @noinstantiate This class is not intended to be instantiated by clients.
|
||||
*/
|
||||
public class SystemFilterStringContentsType implements ISystemContentsType {
|
||||
public static String CONTENTS_TYPE_CHILDREN_PARENTS = "contents_children_parents"; //$NON-NLS-1$
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
/*******************************************************************************
|
||||
* Copyright (c) 2002, 2007 IBM Corporation and others.
|
||||
* 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 available at
|
||||
|
|
@ -12,7 +12,7 @@
|
|||
* Emily Bruner, Mazen Faraj, Adrian Storisteanu, Li Ding, and Kent Hawley.
|
||||
*
|
||||
* Contributors:
|
||||
* {Name} (company) - description of contribution.
|
||||
* David Dykstal (IBM) - [226561] Add API markup to RSE javadocs for extend / implement
|
||||
*******************************************************************************/
|
||||
|
||||
package org.eclipse.rse.core.model;
|
||||
|
|
@ -23,6 +23,7 @@ import org.eclipse.rse.services.clientserver.messages.SystemMessage;
|
|||
|
||||
/**
|
||||
* This class captures a message we wish to display as child node in the tree view.
|
||||
* @noextend This class is not intended to be subclassed by clients.
|
||||
*/
|
||||
public class SystemMessageObject implements ISystemMessageObject, IAdaptable, Comparable {
|
||||
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
/********************************************************************************
|
||||
* Copyright (c) 2004, 2007 IBM Corporation and others. All rights reserved.
|
||||
* Copyright (c) 2004, 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 http://www.eclipse.org/legal/epl-v10.html
|
||||
|
|
@ -12,6 +12,7 @@
|
|||
*
|
||||
* Contributors:
|
||||
* Martin Oberhuber (Wind River) - [168975] Move RSE Events API to Core
|
||||
* David Dykstal (IBM) - [226561] Add API markup to RSE javadocs for extend / implement
|
||||
********************************************************************************/
|
||||
|
||||
package org.eclipse.rse.core.model;
|
||||
|
|
@ -22,6 +23,10 @@ import org.eclipse.rse.core.subsystems.ISubSystem;
|
|||
import org.eclipse.rse.core.subsystems.ISystemDragDropAdapter;
|
||||
|
||||
|
||||
/**
|
||||
* An ISystemResourceSet containing remote resources.
|
||||
* @noextend This class is not intended to be subclassed by clients.
|
||||
*/
|
||||
public class SystemRemoteResourceSet extends AbstractSystemResourceSet
|
||||
{
|
||||
private ISubSystem _subSystem;
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
/********************************************************************************
|
||||
* Copyright (c) 2002, 2007 IBM Corporation and others. All rights reserved.
|
||||
* 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
|
||||
* available at http://www.eclipse.org/legal/epl-v10.html
|
||||
|
|
@ -14,6 +14,7 @@
|
|||
* David Dykstal (IBM) - 168977: refactoring IConnectorService and ServerLauncher hierarchies
|
||||
* Martin Oberhuber (Wind River) - [175262] IHost.getSystemType() should return IRSESystemType
|
||||
* Martin Oberhuber (Wind River) - [184095] Replace systemTypeName by IRSESystemType
|
||||
* David Dykstal (IBM) - [226561] Add API markup to RSE javadocs for extend / implement
|
||||
********************************************************************************/
|
||||
|
||||
package org.eclipse.rse.core.model;
|
||||
|
|
@ -26,6 +27,7 @@ import org.eclipse.rse.core.subsystems.ICredentials;
|
|||
* must be secure and never disclose the password for the remote system in its unencrypted form.
|
||||
* However the encrypted form of the password is not considered secret information and can be
|
||||
* accessed by anyone.
|
||||
* @noextend This class is not intended to be subclassed by clients.
|
||||
*/
|
||||
public final class SystemSignonInformation implements ICredentials {
|
||||
|
||||
|
|
|
|||
|
|
@ -17,6 +17,7 @@
|
|||
* Martin Oberhuber (Wind River) - [186640] Add IRSESystemType.testProperty()
|
||||
* Martin Oberhuber (Wind River) - [175680] Deprecate obsolete ISystemRegistry methods
|
||||
* Martin Oberhuber (Wind River) - [cleanup] Avoid using SystemStartHere in production code
|
||||
* David Dykstal (IBM) - [226561] Add API markup to RSE javadocs for extend / implement
|
||||
********************************************************************************/
|
||||
|
||||
package org.eclipse.rse.core.model;
|
||||
|
|
@ -28,7 +29,9 @@ import org.eclipse.rse.core.subsystems.ISubSystemConfiguration;
|
|||
|
||||
|
||||
/**
|
||||
* It all begins RIGHT HERE!
|
||||
* A utility class, composed of static methods, that can be used to begin RSE processing.
|
||||
* @noextend This class is not intended to be subclassed by clients.
|
||||
* @noinstantiate This class is not intended to be instantiated by clients.
|
||||
*/
|
||||
public class SystemStartHere
|
||||
{
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
/*******************************************************************************
|
||||
* Copyright (c) 2004, 2007 IBM Corporation and others.
|
||||
* Copyright (c) 2004, 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.
|
||||
* David Dykstal (IBM) - [226561] Add API markup to RSE javadocs for extend / implement
|
||||
*******************************************************************************/
|
||||
|
||||
package org.eclipse.rse.core.model;
|
||||
|
|
@ -21,6 +21,10 @@ import java.util.List;
|
|||
|
||||
import org.eclipse.core.resources.IResource;
|
||||
|
||||
/**
|
||||
* An ISystemResourceSet containing workspace resources.
|
||||
* @noextend This class is not intended to be subclassed by clients.
|
||||
*/
|
||||
public class SystemWorkspaceResourceSet extends AbstractSystemResourceSet {
|
||||
|
||||
public SystemWorkspaceResourceSet() {
|
||||
|
|
|
|||
|
|
@ -14,6 +14,7 @@
|
|||
* Contributors:
|
||||
* Martin Oberhuber (Wind River) - [190271] Move ISystemViewInputProvider to Core
|
||||
* David McKnight (IBM) - [225506] [api][breaking] RSE UI leaks non-API types
|
||||
* David Dykstal (IBM) - [226561] Add API markup to RSE javadocs for extend / implement
|
||||
*******************************************************************************/
|
||||
|
||||
package org.eclipse.rse.internal.ui.view;
|
||||
|
|
@ -28,7 +29,6 @@ import org.eclipse.rse.ui.view.SystemAbstractAPIProvider;
|
|||
*/
|
||||
public class SystemEmptyListAPIProviderImpl
|
||||
extends SystemAbstractAPIProvider
|
||||
implements ISystemViewInputProvider
|
||||
{
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -15,6 +15,7 @@
|
|||
* Tobias Schwarz (Wind River) - [173267] "empty list" should not be displayed
|
||||
* Martin Oberhuber (Wind River) - [190271] Move ISystemViewInputProvider to Core
|
||||
* David McKnight (IBM) - [225506] [api][breaking] RSE UI leaks non-API types
|
||||
* David Dykstal (IBM) - [226561] Add API markup to RSE javadocs for extend / implement
|
||||
********************************************************************************/
|
||||
|
||||
package org.eclipse.rse.internal.ui.view;
|
||||
|
|
@ -32,7 +33,6 @@ import org.eclipse.rse.ui.view.SystemAbstractAPIProvider;
|
|||
*/
|
||||
public class SystemTestFilterStringAPIProviderImpl
|
||||
extends SystemAbstractAPIProvider
|
||||
implements ISystemViewInputProvider
|
||||
{
|
||||
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue