- * The IClassByteStreamHandler interface is used to abstract file read and write operations
- * across the network.
- *
+ * The IClassByteStreamHandler interface is used to abstract file read and write
+ * operations across the network.
+ *
* @noimplement This interface is not intended to be implemented by clients.
+ * @noextend This interface is not intended to be extended by clients.
*/
public interface IClassByteStreamHandler
{
@@ -31,7 +33,7 @@ public interface IClassByteStreamHandler
* @return the unique id
*/
public String getIdentifier();
-
+
/**
* Receive a class and load it. This method is called by the
* DataStore when the communication layer receives a class file transfer
@@ -43,10 +45,10 @@ public interface IClassByteStreamHandler
* @param size the number of bytes in the class
*/
public void receiveBytes(String className, byte[] buffer, int size);
-
+
/**
* Save a class instance in the specified location. Invokes the operation in a new thread. This method is called by the
- * DataStore when the communication layer receives a class file transfer
+ * DataStore when the communication layer receives a class file transfer
*
* @param buffer the bytes to insert in the class instance
* @param size the number of bytes to insert
diff --git a/rse/plugins/org.eclipse.dstore.core/src/org/eclipse/dstore/core/java/IRemoteClassInstance.java b/rse/plugins/org.eclipse.dstore.core/src/org/eclipse/dstore/core/java/IRemoteClassInstance.java
index e600bbbee2e..76b5890bc55 100644
--- a/rse/plugins/org.eclipse.dstore.core/src/org/eclipse/dstore/core/java/IRemoteClassInstance.java
+++ b/rse/plugins/org.eclipse.dstore.core/src/org/eclipse/dstore/core/java/IRemoteClassInstance.java
@@ -1,17 +1,18 @@
/********************************************************************************
- * Copyright (c) 2006, 2008 IBM Corporation. All rights reserved.
+ * Copyright (c) 2006, 2009 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:
* David McKnight (IBM) - [226561] [apidoc] Add API markup to RSE Javadocs where extend / implement is allowed
+ * Martin Oberhuber (Wind River) - [261486][api][cleanup] Mark @noimplement interfaces as @noextend
********************************************************************************/
package org.eclipse.dstore.core.java;
@@ -20,6 +21,7 @@ import java.io.Serializable;
/**
* @noimplement This interface is not intended to be implemented by clients.
+ * @noextend This interface is not intended to be extended by clients.
*/
public interface IRemoteClassInstance extends Serializable
{
diff --git a/rse/plugins/org.eclipse.dstore.extra/META-INF/MANIFEST.MF b/rse/plugins/org.eclipse.dstore.extra/META-INF/MANIFEST.MF
index cec256ce4f4..45108565be1 100644
--- a/rse/plugins/org.eclipse.dstore.extra/META-INF/MANIFEST.MF
+++ b/rse/plugins/org.eclipse.dstore.extra/META-INF/MANIFEST.MF
@@ -2,7 +2,7 @@ Manifest-Version: 1.0
Bundle-ManifestVersion: 2
Bundle-Name: %pluginName
Bundle-SymbolicName: org.eclipse.dstore.extra
-Bundle-Version: 2.1.0.qualifier
+Bundle-Version: 2.1.100.qualifier
Bundle-Activator: org.eclipse.dstore.extra.Activator
Bundle-Localization: plugin
Require-Bundle: org.eclipse.ui,
diff --git a/rse/plugins/org.eclipse.dstore.extra/src/org/eclipse/dstore/extra/IDomainNotifier.java b/rse/plugins/org.eclipse.dstore.extra/src/org/eclipse/dstore/extra/IDomainNotifier.java
index 2aff9a0511a..b8906a2962e 100644
--- a/rse/plugins/org.eclipse.dstore.extra/src/org/eclipse/dstore/extra/IDomainNotifier.java
+++ b/rse/plugins/org.eclipse.dstore.extra/src/org/eclipse/dstore/extra/IDomainNotifier.java
@@ -1,5 +1,5 @@
/*******************************************************************************
- * Copyright (c) 2002, 2008 IBM Corporation and others.
+ * Copyright (c) 2002, 2009 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,20 +7,22 @@
*
* 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 McKnight (IBM) - [225507][api][breaking] RSE dstore API leaks non-API types
+ * David McKnight (IBM) - [225507][api][breaking] RSE dstore API leaks non-API types
+ * Martin Oberhuber (Wind River) - [261486][api][cleanup] Mark @noimplement interfaces as @noextend
*******************************************************************************/
package org.eclipse.dstore.extra;
/**
* For DataStore domain notification
- *
+ *
* @noimplement This interface is not intended to be implemented by clients.
+ * @noextend This interface is not intended to be extended by clients.
*/
public interface IDomainNotifier {
public void addDomainListener(IDomainListener listener);
diff --git a/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/IRSECoreRegistry.java b/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/IRSECoreRegistry.java
index 07a03cc331d..ce43afc5e9d 100644
--- a/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/IRSECoreRegistry.java
+++ b/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/IRSECoreRegistry.java
@@ -1,5 +1,5 @@
/*******************************************************************************
- * Copyright (c) 2006, 2008 IBM Corporation and others.
+ * Copyright (c) 2006, 2009 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,16 +13,17 @@
*
* Contributors:
* Uwe Stieber (Wind River) - Added system types provider extension.
+ * Martin Oberhuber (Wind River) - [261486][api][cleanup] Mark @noimplement interfaces as @noextend
*******************************************************************************/
package org.eclipse.rse.core;
-
/**
* Interface for RSE core registry. Clients should use this interface as the
* starting point for querying and manipulating model objects in the RSE
* framework.
- *
+ *
* @noimplement This interface is not intended to be implemented by clients.
+ * @noextend This interface is not intended to be extended by clients.
*/
public interface IRSECoreRegistry {
@@ -32,24 +33,24 @@ public interface IRSECoreRegistry {
/**
* Returns all defined system types.
- *
+ *
* @return an array of all defined system types.
*/
public IRSESystemType[] getSystemTypes();
/**
* Returns a system type object given the name.
- *
+ *
* @param name the name of the system type
* @return the system type object with the given name, or null if none is found
- *
+ *
* @deprecated Use {@link #getSystemTypeById(String)}.
*/
public IRSESystemType getSystemType(String name);
/**
* Returns a system type object given by the id.
- *
+ *
* @param systemTypeId The system type id.
* @return The system type object with the given id, or null if none is found
*/
diff --git a/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/IRSECoreStatusCodes.java b/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/IRSECoreStatusCodes.java
index b082ee2a326..e990e56ac79 100644
--- a/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/IRSECoreStatusCodes.java
+++ b/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/IRSECoreStatusCodes.java
@@ -1,5 +1,5 @@
/*********************************************************************************
- * Copyright (c) 2008 IBM Corporation. All rights reserved.
+ * Copyright (c) 2008, 2009 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
@@ -7,6 +7,7 @@
* Contributors:
* David Dykstal (IBM) - [225988] need API to mark persisted profiles as migrated
* David Dykstal (IBM) - [226561] Add API markup to RSE Javadocs where extend / implement is allowed
+ * Martin Oberhuber (Wind River) - [261486][api][cleanup] Mark @noimplement interfaces as @noextend
*********************************************************************************/
package org.eclipse.rse.core;
@@ -17,6 +18,7 @@ package org.eclipse.rse.core;
*
* @since org.eclipse.rse.core 3.0
* @noimplement this interface is not intended to be implemented by clients
+ * @noextend This interface is not intended to be extended by clients.
*/
public interface IRSECoreStatusCodes {
diff --git a/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/IRSEPreferenceNames.java b/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/IRSEPreferenceNames.java
index 720192e2871..4c9a5253732 100644
--- a/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/IRSEPreferenceNames.java
+++ b/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/IRSEPreferenceNames.java
@@ -1,5 +1,5 @@
/********************************************************************************
- * Copyright (c) 2006, 2008 IBM Corporation and others. All rights reserved.
+ * Copyright (c) 2006, 2009 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
@@ -9,6 +9,7 @@
* David Dykstal (IBM) - updated with comments, removed keys that are not to be used globally
* David Dykstal (IBM) - [197167] adding notification and waiting for RSE model
* Martin Oberhuber (Wind River) - [cleanup] Add API "since" Javadoc tags
+ * Martin Oberhuber (Wind River) - [261486][api][cleanup] Mark @noimplement interfaces as @noextend
********************************************************************************/
package org.eclipse.rse.core;
@@ -16,6 +17,7 @@ package org.eclipse.rse.core;
* These constants define the set of preference names that the RSE core uses.
*
* @noimplement This interface is not intended to be implemented by clients.
+ * @noextend This interface is not intended to be extended by clients.
*/
/*
@@ -57,7 +59,7 @@ public interface IRSEPreferenceNames {
* The key for the string containing the list of active user profiles in
* alphabetical order. As profiles are activated, deactivated, or renamed
* this string must be modified. This value is not part of the API.
- *
+ *
* This field is not intended to be referenced by clients.
*/
public static final String ACTIVEUSERPROFILES = "activeuserprofiles"; //$NON-NLS-1$
diff --git a/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/IRSESystemType.java b/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/IRSESystemType.java
index e27eaa09c75..927b7e379d1 100644
--- a/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/IRSESystemType.java
+++ b/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/IRSESystemType.java
@@ -1,5 +1,5 @@
/********************************************************************************
- * Copyright (c) 2000, 2008 IBM Corporation and others. All rights reserved.
+ * Copyright (c) 2000, 2009 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
@@ -17,6 +17,7 @@
* Martin Oberhuber (Wind River) - [218655][api] Provide SystemType enablement info in non-UI
* Martin Oberhuber (Wind River) - [cleanup] Add API "since" Javadoc tags
* Martin Oberhuber (Wind River) - [226574][api] Add ISubSystemConfiguration#supportsEncoding()
+ * Martin Oberhuber (Wind River) - [261486][api][cleanup] Mark @noimplement interfaces as @noextend
********************************************************************************/
package org.eclipse.rse.core;
@@ -32,11 +33,12 @@ import org.osgi.framework.Bundle;
* Interface for a system type. Constants are defined for various system types.
* These constants are kept in sync with definitions in plugin.xml.
*
+ * * @noimplement This interface is not intended to be implemented by clients. - * System type implementations must subclass - * {@link AbstractRSESystemType} rather than implementing this - * interface directly. - *
+ * @noextend This interface is not intended to be extended by clients. System + * type implementations must subclass {@link AbstractRSESystemType} + * rather than implementing this interface directly. + * */ public interface IRSESystemType extends IAdaptable { diff --git a/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/IRSESystemTypeConstants.java b/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/IRSESystemTypeConstants.java index 1501e39e768..e53297e2959 100644 --- a/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/IRSESystemTypeConstants.java +++ b/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/IRSESystemTypeConstants.java @@ -1,5 +1,5 @@ /******************************************************************************** - * Copyright (c) 2006, 2008 IBM Corporation and others. All rights reserved. + * Copyright (c) 2006, 2009 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 @@ -7,15 +7,17 @@ * Contributors: * Kushal Munir (IBM) - Initial API and implementation. * Martin Oberhuber (Wind River) - [cleanup] Add API "since" Javadoc tags + * Martin Oberhuber (Wind River) - [261486][api][cleanup] Mark @noimplement interfaces as @noextend ********************************************************************************/ package org.eclipse.rse.core; /** * These constants define the set of properties that the UI expects to be * available viaIRSESystemType.getProperty(String).
- *
+ *
* @see org.eclipse.rse.core.IRSESystemType#getProperty(String)
* @noimplement This interface is not intended to be implemented by clients.
+ * @noextend This interface is not intended to be extended by clients.
*/
public interface IRSESystemTypeConstants {
diff --git a/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/IRSEUserIdConstants.java b/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/IRSEUserIdConstants.java
index 3965bf400ff..fbbef55f91b 100644
--- a/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/IRSEUserIdConstants.java
+++ b/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/IRSEUserIdConstants.java
@@ -1,17 +1,18 @@
/********************************************************************************
- * Copyright (c) 2000, 2008 IBM Corporation. All rights reserved.
+ * Copyright (c) 2000, 2009 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
- *
+ *
* 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,
* Emily Bruner, Mazen Faraj, Adrian Storisteanu, Li Ding, and Kent Hawley.
- *
+ *
* Contributors:
* Martin Oberhuber (Wind River) - [cleanup] Add API "since" Javadoc tags
+ * Martin Oberhuber (Wind River) - [261486][api][cleanup] Mark @noimplement interfaces as @noextend
********************************************************************************/
package org.eclipse.rse.core;
@@ -19,8 +20,9 @@ package org.eclipse.rse.core;
/**
* Constants for user id management. Used when specifying the scope of a user id
* when setting a user id.
- *
+ *
* @noimplement This interface is not intended to be implemented by clients.
+ * @noextend This interface is not intended to be extended by clients.
*/
public interface IRSEUserIdConstants {
diff --git a/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/events/ISystemModelChangeEvents.java b/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/events/ISystemModelChangeEvents.java
index 391c85f613f..0b85781e548 100644
--- a/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/events/ISystemModelChangeEvents.java
+++ b/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/events/ISystemModelChangeEvents.java
@@ -1,36 +1,42 @@
/********************************************************************************
- * Copyright (c) 2002, 2008 IBM Corporation and others. All rights reserved.
+ * Copyright (c) 2002, 2009 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
- *
+ *
* 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,
* Emily Bruner, Mazen Faraj, Adrian Storisteanu, Li Ding, and Kent Hawley.
- *
+ *
* Contributors:
* Martin Oberhuber (Wind River) - [168975] Move RSE Events API to Core
* David Dykstal (IBM) - [186589] Move User Actions events to the user actions plugin
* Martin Oberhuber (Wind River) - [cleanup] Add API "since" Javadoc tags
+ * Martin Oberhuber (Wind River) - [261486][api][cleanup] Mark @noimplement interfaces as @noextend
********************************************************************************/
package org.eclipse.rse.core.events;
/**
- * The event IDs sent when local resources in the RSE model change.
- * You should monitor for these events in your view if you display any of the resource types listed here.
+ * The event IDs sent when local resources in the RSE model change. You should
+ * monitor for these events in your view if you display any of the resource
+ * types listed here.
* - * To monitor, implement interface {@link org.eclipse.rse.core.events.ISystemModelChangeListener} and - * call {@link org.eclipse.rse.core.model.ISystemRegistry#addSystemModelChangeListener(ISystemModelChangeListener)} - * and in your dispose method, call {@link org.eclipse.rse.core.model.ISystemRegistry#removeSystemModelChangeListener(ISystemModelChangeListener)}. + * To monitor, implement interface + * {@link org.eclipse.rse.core.events.ISystemModelChangeListener} and call + * {@link org.eclipse.rse.core.model.ISystemRegistry#addSystemModelChangeListener(ISystemModelChangeListener)} + * and in your dispose method, call + * {@link org.eclipse.rse.core.model.ISystemRegistry#removeSystemModelChangeListener(ISystemModelChangeListener)}. *
* If you are interesting in firing model change events, see - * {@link org.eclipse.rse.core.model.ISystemRegistry#fireModelChangeEvent(int, int, Object, String)}. - * These events will typically be signaled in an implementation of ISystemRegistry. - * + * {@link org.eclipse.rse.core.model.ISystemRegistry#fireModelChangeEvent(int, int, Object, String)} + * . These events will typically be signaled in an implementation of + * ISystemRegistry. + * * @noimplement This interface is not intended to be implemented by clients. + * @noextend This interface is not intended to be extended by clients. */ public interface ISystemModelChangeEvents { diff --git a/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/events/ISystemPreferenceChangeEvents.java b/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/events/ISystemPreferenceChangeEvents.java index e8a0a7cd537..4962210a726 100644 --- a/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/events/ISystemPreferenceChangeEvents.java +++ b/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/events/ISystemPreferenceChangeEvents.java @@ -1,26 +1,28 @@ /******************************************************************************** - * Copyright (c) 2002, 2008 IBM Corporation and others. All rights reserved. + * Copyright (c) 2002, 2009 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 - * + * * 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, * Emily Bruner, Mazen Faraj, Adrian Storisteanu, Li Ding, and Kent Hawley. - * + * * Contributors: * Martin Oberhuber (Wind River) - [168975] Move RSE Events API to Core * Martin Oberhuber (Wind River) - [cleanup] Add API "since" Javadoc tags + * Martin Oberhuber (Wind River) - [261486][api][cleanup] Mark @noimplement interfaces as @noextend ********************************************************************************/ package org.eclipse.rse.core.events; /** * Interface of event ID constants for preferences changed - * + * * @noimplement This interface is not intended to be implemented by clients. + * @noextend This interface is not intended to be extended by clients. */ public interface ISystemPreferenceChangeEvents { /** diff --git a/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/events/ISystemRemoteChangeEvents.java b/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/events/ISystemRemoteChangeEvents.java index a18d35ae185..28831a311a0 100644 --- a/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/events/ISystemRemoteChangeEvents.java +++ b/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/events/ISystemRemoteChangeEvents.java @@ -1,19 +1,20 @@ /******************************************************************************** - * Copyright (c) 2002, 2008 IBM Corporation and others. All rights reserved. + * Copyright (c) 2002, 2009 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 - * + * * 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, * Emily Bruner, Mazen Faraj, Adrian Storisteanu, Li Ding, and Kent Hawley. - * + * * Contributors: * Martin Oberhuber (Wind River) - [168975] Move RSE Events API to Core * David McKnight (IBM) - [207100] Events for after a resource is downloaded and uploaded * Martin Oberhuber (Wind River) - [cleanup] Add API "since" Javadoc tags + * Martin Oberhuber (Wind River) - [261486][api][cleanup] Mark @noimplement interfaces as @noextend ********************************************************************************/ package org.eclipse.rse.core.events; @@ -21,14 +22,15 @@ package org.eclipse.rse.core.events; /** * The event IDs sent when remote resources in the model change These IDs are * used when creating ISystemRemoteChangeEvent objects. - * + * * @noimplement This interface is not intended to be implemented by clients. + * @noextend This interface is not intended to be extended by clients. */ public interface ISystemRemoteChangeEvents { /** * Event Type: a remote resource was added - * + * * The event stores the following event parameters: *
"description" is reserved for internal use, to store the
+ * description of the Property set.
*
- * The key "description" is reserved for internal
- * use, to store the description of the Property set.
* @noimplement This interface is not intended to be implemented by clients.
- * Use {@link PropertySet} directly.
+ * @noextend This interface is not intended to be extended by clients. Use
+ * {@link PropertySet} directly.
*/
public interface IPropertySet extends IPropertySetContainer {
/**
@@ -168,7 +171,7 @@ public interface IPropertySet extends IPropertySetContainer {
/**
* 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);
diff --git a/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/model/IPropertyType.java b/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/model/IPropertyType.java
index 98328071751..7946ab8c3bf 100644
--- a/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/model/IPropertyType.java
+++ b/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/model/IPropertyType.java
@@ -1,29 +1,32 @@
/********************************************************************************
- * Copyright (c) 2006, 2008 IBM Corporation. All rights reserved.
+ * Copyright (c) 2006, 2009 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:
* David Dykstal (IBM) - added javadoc
* David Dykstal (IBM) - [226561] Add API markup to RSE javadocs for extend / implement
+ * Martin Oberhuber (Wind River) - [261486][api][cleanup] Mark @noimplement interfaces as @noextend
********************************************************************************/
package org.eclipse.rse.core.model;
/**
- * Property types are used to type instances of {@link IProperty}.
+ * Property types are used to type instances of {@link IProperty}.
+ *
* @noimplement This interface is not intended to be implemented by clients.
- * Use {@link PropertyType} directly.
+ * @noextend This interface is not intended to be extended by clients. Use
+ * {@link PropertyType} directly.
*/
public interface IPropertyType {
-
+
public static final int TYPE_STRING = 0;
public static final int TYPE_INTEGER = 1;
public static final int TYPE_ENUM = 2;
@@ -48,7 +51,7 @@ public interface IPropertyType {
* @return true if the property is of TYPE_BOOLEAN
*/
public boolean isBoolean();
-
+
/**
* @return the integer value of the property type
*/
diff --git a/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/model/ISubSystemConfigurationCategories.java b/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/model/ISubSystemConfigurationCategories.java
index a8a7ac0c0cc..7bbcbbf2d69 100644
--- a/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/model/ISubSystemConfigurationCategories.java
+++ b/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/model/ISubSystemConfigurationCategories.java
@@ -1,5 +1,5 @@
/*******************************************************************************
- * Copyright (c) 2000, 2008 IBM Corporation and others.
+ * Copyright (c) 2000, 2009 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,17 +13,19 @@
*
* Contributors:
* David Dykstal (IBM) - [226561] Add API markup to RSE javadocs for extend / implement
+ * Martin Oberhuber (Wind River) - [261486][api][cleanup] Mark @noimplement interfaces as @noextend
*******************************************************************************/
package org.eclipse.rse.core.model;
/**
* Constants for predefined subsystem factory categories. Use these in calls to
- * {@link org.eclipse.rse.core.model.ISystemRegistry#getHostsBySubSystemConfigurationCategory(String)}.
- *
+ * {@link org.eclipse.rse.core.model.ISystemRegistry#getHostsBySubSystemConfigurationCategory(String)}
+ * . This is a constant interface. The individual items should be referenced
+ * directly.
+ *
* @noimplement This interface is not intended to be implemented by clients.
- * This is a constant interface. The individual items should be
- * referenced directly.
+ * @noextend This interface is not intended to be extended by clients.
*/
public interface ISubSystemConfigurationCategories {
/**
diff --git a/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/model/ISystemMessageObject.java b/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/model/ISystemMessageObject.java
index 11e9d6dd655..40bcbefdecb 100644
--- a/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/model/ISystemMessageObject.java
+++ b/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/model/ISystemMessageObject.java
@@ -1,5 +1,5 @@
/*******************************************************************************
- * Copyright (c) 2002, 2008 IBM Corporation and others.
+ * Copyright (c) 2002, 2009 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,20 +7,24 @@
*
* 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
+ * Martin Oberhuber (Wind River) - [261486][api][cleanup] Mark @noimplement interfaces as @noextend
*******************************************************************************/
package org.eclipse.rse.core.model;
/**
- * This interface represents a message we wish to display as child node in the tree view.
+ * This interface represents a message we wish to display as child node in the
+ * tree view.
+ *
* @noimplement This interface is not intended to be implemented by clients.
- * The standard implementations are included in the framework.
+ * @noextend This interface is not intended to be extended by clients. The
+ * standard implementations are included in the framework.
*/
public interface ISystemMessageObject {
/**
@@ -68,9 +72,9 @@ public interface ISystemMessageObject {
public Object getParent();
/**
- * isTransient determines if the message should be removed from the
+ * isTransient determines if the message should be removed from the
* tree when the parent item in the tree is collapsed.
- *
+ *
* @return true if the item should be removed, false if it should not
*/
public boolean isTransient();
diff --git a/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/model/ISystemProfile.java b/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/model/ISystemProfile.java
index 8f20539c914..3d18fa539f8 100644
--- a/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/model/ISystemProfile.java
+++ b/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/model/ISystemProfile.java
@@ -1,5 +1,5 @@
/*******************************************************************************
- * Copyright (c) 2002, 2008 IBM Corporation and others.
+ * Copyright (c) 2002, 2009 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,19 +7,20 @@
*
* 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) - 142806: refactoring persistence framework
* Martin Oberhuber (Wind River) - [184095] Replace systemTypeName by IRSESystemType
- * David Dykstal (IBM) - [197036] removed createHost() shortcut (should use ISystemRegistry),
- * cleaned javadoc for getFilterPools()
+ * David Dykstal (IBM) - [197036] removed createHost() shortcut (should use ISystemRegistry),
+ * 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
* David Dykstal (IBM) - [235800] Document naming restriction for profiles and filter pools
+ * Martin Oberhuber (Wind River) - [261486][api][cleanup] Mark @noimplement interfaces as @noextend
*******************************************************************************/
package org.eclipse.rse.core.model;
@@ -29,18 +30,19 @@ import org.eclipse.rse.core.subsystems.ISubSystemConfiguration;
import org.eclipse.rse.persistence.IRSEPersistenceProvider;
/**
- * A system profile holds definitions for hosts
- * (connections), filter pools, filters, and filter strings.
- * It is the unit of persistence for those definitions. Individual
- * hosts and filter pool definitions always reside in a profile and the profile
- * itself is the entity that is saved and restored.
+ * A system profile holds definitions for hosts (connections), filter pools,
+ * filters, and filter strings. It is the unit of persistence for those
+ * definitions. Individual hosts and filter pool definitions always reside in a
+ * profile and the profile itself is the entity that is saved and restored.
* * Profiles may be active or inactive. An active profile contributes its - * definitions to RSE. When made inactive, it those definition are no longer + * definitions to RSE. When made inactive, it those definition are no longer * available for use. *
+ * * @noimplement This interface is not intended to be implemented by clients. - * The standard implementations are included in the framework. + * @noextend This interface is not intended to be extended by clients. The + * standard implementations are included in the framework. */ public interface ISystemProfile extends IRSEModelObject { @@ -76,7 +78,7 @@ public interface ISystemProfile extends IRSEModelObject { boolean isDefaultPrivate(); /** - * @generated This field/method will be replaced during code generation + * @generated This field/method will be replaced during code generation * @param value The new value of the DefaultPrivate attribute */ void setDefaultPrivate(boolean value); @@ -103,20 +105,20 @@ public interface ISystemProfile extends IRSEModelObject { * The active state of a profile is remembered from session to session. */ public boolean isActive(); - + /** * Activates or deactivates a profile. If the profile is already in the - * requested state, this will do nothing. The default private system profile + * requested state, this will do nothing. The default private system profile * cannot be deactivated and such a request will be ignored. * @param flag true to activate the profile, false to deactivate it. * @see ISystemProfile#isActive() */ public void setActive(boolean flag); - + /** * Suspend this profile. * Suspended profiles ignore commit requests. - * Profiles are created in a non-suspended state. + * Profiles are created in a non-suspended state. * Profiles should be suspended while deleting their contents prior to their own deletion. * Note that being non-suspended is a different condition than being active. * A suspended profile may be resumed. @@ -124,7 +126,7 @@ public interface ISystemProfile extends IRSEModelObject { * @see #resume() */ public void suspend(); - + /** * Resume this profile from a suspended state. * The profile will now honor commit requests. @@ -140,21 +142,21 @@ public interface ISystemProfile extends IRSEModelObject { * @see #resume() */ public boolean isSuspended(); - + /** - * Each profile is persisted by a persistence provider. This returns the instance of the + * Each profile is persisted by a persistence provider. This returns the instance of the * persistence provider used for this profile. New profiles will use the default persistence * provider unless one is set by some other means. * @return The persistence provider used for saving and restoring this profile. */ public IRSEPersistenceProvider getPersistenceProvider(); - + /** * Sets the persistence provider for the use of this profile. If this is not called then * this profile will be persisted by the default persistence provider. This will typically * be set by either a persistence persistence provider when restoring a profile or by a migration * utility when converting profiles from one form to another. - * @param provider the persistence provider to use when saving this profile. + * @param provider the persistence provider to use when saving this profile. */ public void setPersistenceProvider(IRSEPersistenceProvider provider); } diff --git a/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/model/ISystemProfileManager.java b/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/model/ISystemProfileManager.java index 688d7b40005..cc0551f6c18 100644 --- a/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/model/ISystemProfileManager.java +++ b/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/model/ISystemProfileManager.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2002, 2008 IBM Corporation and others. + * Copyright (c) 2002, 2009 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 @@ -10,12 +10,13 @@ * 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) - [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 + * Martin Oberhuber (Wind River) - [261486][api][cleanup] Mark @noimplement interfaces as @noextend *******************************************************************************/ package org.eclipse.rse.core.model; @@ -27,9 +28,10 @@ import org.eclipse.core.runtime.IStatus; * deleted, restored, activated, and deactivated though this interface if event * processing is not desired. If events are necessary then the system registry * should be used. - * + * * @noimplement This interface is not intended to be implemented by clients. - * The standard implementations are included in the framework. + * @noextend This interface is not intended to be extended by clients. The + * standard implementations are included in the framework. */ public interface ISystemProfileManager { @@ -121,7 +123,7 @@ public interface ISystemProfileManager { /** * Commit a system profile - * + * * @param profile the profile to commit * @return a status object indicating the result of the commit * @since org.eclipse.rse.core 3.0 diff --git a/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/model/ISystemRegistry.java b/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/model/ISystemRegistry.java index ac1d5478781..73994bb6a26 100644 --- a/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/model/ISystemRegistry.java +++ b/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/model/ISystemRegistry.java @@ -1,5 +1,5 @@ /******************************************************************************** - * Copyright (c) 2006, 2008 IBM Corporation and others. All rights reserved. + * Copyright (c) 2006, 2009 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 @@ -30,6 +30,7 @@ * David Dykstal (IBM) - [226561] Add API markup to RSE javadocs for extend / implement * David Dykstal (IBM) - [235800] Document naming restriction for profiles and filter pools * David Dykstal (IBM) - [236516] Bug in user code causes failure in RSE initialization + * Martin Oberhuber (Wind River) - [261486][api][cleanup] Mark @noimplement interfaces as @noextend ********************************************************************************/ package org.eclipse.rse.core.model; @@ -65,8 +66,10 @@ import org.eclipse.rse.internal.core.RSECoreRegistry; * there is a user-specified number of profiles "active" and connections from * each active profile are worked with. *
+ * * @noimplement This interface is not intended to be implemented by clients. - * The standard implementations are included in the framework. + * @noextend This interface is not intended to be extended by clients. The + * standard implementations are included in the framework. */ public interface ISystemRegistry extends ISchedulingRule, IAdaptable, ISystemViewInputProvider { @@ -112,14 +115,14 @@ public interface ISystemRegistry extends ISchedulingRule, IAdaptable, ISystemVie * equivalent to getSubSystemConfigurationsBySystemType(systemType, * filterDuplicates,true) which is preferred since we do not
* want to load subsystem configurations unless necessary.
- *
+ *
* @param systemType system type to filter
* @param filterDuplicates if true and the subsystem configuration uses
* services then return only one subsystem configuration that
* supports this service. Which configuration is returned is
* undefined.
* @return an array of subsystem configurations meeting the criteria
- *
+ *
* @deprecated Use
* {@link #getSubSystemConfigurationsBySystemType(IRSESystemType,boolean,boolean)}
* instead in order to avoid instantiating subsystem
diff --git a/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/subsystems/IFileConstants.java b/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/subsystems/IFileConstants.java
index 43bc023cfde..ab7975fe075 100644
--- a/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/subsystems/IFileConstants.java
+++ b/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/subsystems/IFileConstants.java
@@ -1,5 +1,5 @@
/*******************************************************************************
- * Copyright (c) 2000, 2008 IBM Corporation and others.
+ * Copyright (c) 2000, 2009 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
@@ -10,17 +10,19 @@
* 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) - [cleanup] Add API "since" Javadoc tags
+ * Martin Oberhuber (Wind River) - [261486][api][cleanup] Mark @noimplement interfaces as @noextend
*******************************************************************************/
package org.eclipse.rse.core.subsystems;
/**
* Constants used in the remote file system support.
- *
+ *
* @noimplement This interface is not intended to be implemented by clients.
+ * @noextend This interface is not intended to be extended by clients.
*/
public interface IFileConstants {
diff --git a/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/subsystems/RemoteServerLauncherConstants.java b/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/subsystems/RemoteServerLauncherConstants.java
index 4fcd70c34bf..f5dbe7d06d7 100644
--- a/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/subsystems/RemoteServerLauncherConstants.java
+++ b/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/subsystems/RemoteServerLauncherConstants.java
@@ -1,26 +1,28 @@
/********************************************************************************
- * Copyright (c) 2006, 2008 IBM Corporation and others. All rights reserved.
+ * Copyright (c) 2006, 2009 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
- *
+ *
* 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,
* Emily Bruner, Mazen Faraj, Adrian Storisteanu, Li Ding, and Kent Hawley.
- *
+ *
* Contributors:
* David Dykstal (IBM) - 168977: refactoring IConnectorService and ServerLauncher hierarchies
* Martin Oberhuber (Wind River) - [cleanup] Add API "since" Javadoc tags
+ * Martin Oberhuber (Wind River) - [261486][api][cleanup] Mark @noimplement interfaces as @noextend
********************************************************************************/
package org.eclipse.rse.core.subsystems;
/**
* This interface defines constants for the Remote Server Launcher.
- *
+ *
* @noimplement This interface is not intended to be implemented by clients.
+ * @noextend This interface is not intended to be extended by clients.
*/
public interface RemoteServerLauncherConstants
{
diff --git a/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/internal/core/SystemResourceConstants.java b/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/internal/core/SystemResourceConstants.java
index 4ce5b4c26ce..74ae1dd3703 100644
--- a/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/internal/core/SystemResourceConstants.java
+++ b/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/internal/core/SystemResourceConstants.java
@@ -1,5 +1,5 @@
/*******************************************************************************
- * Copyright (c) 2002, 2008 IBM Corporation and others.
+ * Copyright (c) 2002, 2009 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
@@ -10,23 +10,23 @@
* 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) - removed RESOURCE_TEAMPROFILE_NAME
* David McKnight (IBM) - [220547] [api][breaking] SimpleSystemMessage needs to specify a message id and some messages should be shared
+ * Martin Oberhuber (Wind River) - [261486][api][cleanup] Mark @noimplement interfaces as @noextend
*******************************************************************************/
package org.eclipse.rse.internal.core;
-
/**
* Constants related to project and folder names.
- *
+ *
* @noimplement This interface is not intended to be implemented by clients.
+ * @noextend This interface is not intended to be extended by clients.
*/
public interface SystemResourceConstants
{
-
public static final String RESOURCE_PROJECT_NAME = "RemoteSystemsConnections"; //$NON-NLS-1$
public static final String RESOURCE_TEMPFILES_PROJECT_NAME= "RemoteSystemsTempFiles"; //$NON-NLS-1$
public static final String RESOURCE_CONNECTIONS_FOLDER_NAME = "Connections"; //$NON-NLS-1$
diff --git a/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/persistence/dom/IRSEDOMConstants.java b/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/persistence/dom/IRSEDOMConstants.java
index 2314e12f3a8..3fb06e734a4 100644
--- a/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/persistence/dom/IRSEDOMConstants.java
+++ b/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/persistence/dom/IRSEDOMConstants.java
@@ -1,5 +1,5 @@
/*******************************************************************************
- * Copyright (c) 2006, 2008 IBM Corporation and others.
+ * Copyright (c) 2006, 2009 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
@@ -10,18 +10,20 @@
* 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) - [cleanup] Add API "since" Javadoc tags
* David Dykstal (IBM) - add attribute name for filter type
+ * Martin Oberhuber (Wind River) - [261486][api][cleanup] Mark @noimplement interfaces as @noextend
*******************************************************************************/
package org.eclipse.rse.persistence.dom;
/**
* Constants used in RSE DOMs.
- *
+ *
* @noimplement This interface is not intended to be implemented by clients.
+ * @noextend This interface is not intended to be extended by clients.
*/
public interface IRSEDOMConstants {
// node types
diff --git a/rse/plugins/org.eclipse.rse.files.ui/src/org/eclipse/rse/files/ui/resources/ISystemRemotePath.java b/rse/plugins/org.eclipse.rse.files.ui/src/org/eclipse/rse/files/ui/resources/ISystemRemotePath.java
index 3c2b0b7f920..c9ed5b489b4 100644
--- a/rse/plugins/org.eclipse.rse.files.ui/src/org/eclipse/rse/files/ui/resources/ISystemRemotePath.java
+++ b/rse/plugins/org.eclipse.rse.files.ui/src/org/eclipse/rse/files/ui/resources/ISystemRemotePath.java
@@ -1,5 +1,5 @@
/*******************************************************************************
- * Copyright (c) 2002, 2008 IBM Corporation and others.
+ * Copyright (c) 2002, 2009 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
@@ -10,17 +10,18 @@
* 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:
- * {Name} (company) - description of contribution.
+ * Martin Oberhuber (Wind River) - [261486][api][cleanup] Mark @noimplement interfaces as @noextend
*******************************************************************************/
package org.eclipse.rse.files.ui.resources;
/**
* This interface defines a remote path.
- *
+ *
* @noimplement This interface is not intended to be implemented by clients.
+ * @noextend This interface is not intended to be extended by clients.
*/
public interface ISystemRemotePath {
diff --git a/rse/plugins/org.eclipse.rse.services/clientserver/org/eclipse/rse/services/clientserver/IClassifierConstants.java b/rse/plugins/org.eclipse.rse.services/clientserver/org/eclipse/rse/services/clientserver/IClassifierConstants.java
index d938bb58c43..fc6ea32259f 100644
--- a/rse/plugins/org.eclipse.rse.services/clientserver/org/eclipse/rse/services/clientserver/IClassifierConstants.java
+++ b/rse/plugins/org.eclipse.rse.services/clientserver/org/eclipse/rse/services/clientserver/IClassifierConstants.java
@@ -1,5 +1,5 @@
/********************************************************************************
- * Copyright (c) 2006, 2008 IBM Corporation. All rights reserved.
+ * Copyright (c) 2006, 2009 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:
* David McKnight (IBM) - [247573][api] IClassifierConstants.TYPE_LINK == "link" is not in sync with actual usage of "symbolic link" in the code
+ * Martin Oberhuber (Wind River) - [261486][api][cleanup] Mark @noimplement interfaces as @noextend
********************************************************************************/
package org.eclipse.rse.services.clientserver;
@@ -20,6 +21,7 @@ package org.eclipse.rse.services.clientserver;
* This interface defines some constants for classifiers.
*
* @noimplement This interface is not intended to be implemented by clients.
+ * @noextend This interface is not intended to be extended by clients.
*/
public interface IClassifierConstants {
diff --git a/rse/plugins/org.eclipse.rse.ui/UI/org/eclipse/rse/ui/ISystemContextMenuConstants.java b/rse/plugins/org.eclipse.rse.ui/UI/org/eclipse/rse/ui/ISystemContextMenuConstants.java
index fae6a446362..dcea469b28e 100644
--- a/rse/plugins/org.eclipse.rse.ui/UI/org/eclipse/rse/ui/ISystemContextMenuConstants.java
+++ b/rse/plugins/org.eclipse.rse.ui/UI/org/eclipse/rse/ui/ISystemContextMenuConstants.java
@@ -1,5 +1,5 @@
/*******************************************************************************
- * Copyright (c) 2002, 2008 IBM Corporation and others.
+ * Copyright (c) 2002, 2009 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,60 +7,66 @@
*
* 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:
- * {Name} (company) - description of contribution.
* Kevin Doyle (IBM) - [242431] Register a new unique context menu id, so contributions can be made to all our views
+ * Martin Oberhuber (Wind River) - [261486][api][cleanup] Mark @noimplement interfaces as @noextend
*******************************************************************************/
package org.eclipse.rse.ui;
import org.eclipse.ui.IWorkbenchActionConstants;
+
/**
- * Constants defining our groups inside our right-click popup menu in the system view.
- *
+ * Constants defining our groups inside our right-click popup menu in the system
+ * view.
+ *
+ *
+ * <code>
* // simply sets partitions in the menu, into which actions can be directed.
- * // Each partition can be delimited by a separator (new Separator) or not (new GroupMarker).
- * menu.add(new Separator(ISystemContextMenuConstants.GROUP_NEW)); // new->
- * menu.add(new GroupMarker(ISystemContextMenuConstants.GROUP_GOTO)); // goto into, go->
- * menu.add(new Separator(ISystemContextMenuConstants.GROUP_EXPANDTO)); // expand to->
- * menu.add(new GroupMarker(ISystemContextMenuConstants.GROUP_EXPAND)); // expand, collapse
- * menu.add(new GroupMarker(ISystemContextMenuConstants.GROUP_OPEN)); // open xxx
- * menu.add(new GroupMarker(ISystemContextMenuConstants.GROUP_OPENWITH)); // open with->
- * menu.add(new GroupMarker(ISystemContextMenuConstants.GROUP_BROWSEWITH)); // open with->
- * menu.add(new Separator(ISystemContextMenuConstants.GROUP_WORKWITH)); // work with->
- * menu.add(new Separator(ISystemContextMenuConstants.GROUP_BUILD)); // build, rebuild, refresh
- * menu.add(new Separator(ISystemContextMenuConstants.GROUP_CHANGE)); // update, change
- * menu.add(new Separator(ISystemContextMenuConstants.GROUP_REORGANIZE)); // rename,move,copy,delete,bookmark,refactoring
- * menu.add(new Separator(ISystemContextMenuConstants.GROUP_REORDER)); // move up, move down
- * menu.add(new GroupMarker(ISystemContextMenuConstants.GROUP_GENERATE)); // getters/setters, etc. Typically in editor
- * menu.add(new Separator(ISystemContextMenuConstants.GROUP_SEARCH)); // search
- * menu.add(new Separator(ISystemContextMenuConstants.GROUP_CONNECTION)); // connection-related actions
- * menu.add(new Separator(ISystemContextMenuConstants.GROUP_IMPORTEXPORT)); // get or put actions
- * menu.add(new Separator(ISystemContextMenuConstants.GROUP_ADAPTERS)); // actions queried from adapters
- * menu.add(new Separator(ISystemContextMenuConstants.GROUP_ADDITIONS)); // user or BP/ISV additions
- * menu.add(new Separator(ISystemContextMenuConstants.GROUP_TEAM)); // Team
- * menu.add(new Separator(ISystemContextMenuConstants.GROUP_PROPERTIES)); // Properties
- *
"group.goto").
*
@@ -80,7 +86,7 @@ public interface ISystemContextMenuConstants
* ID of the submenu for "Preferences->"
*/
public static final String MENU_PREFERENCES= "menu.preferences"; //$NON-NLS-1$
-
+
/**
* Pop-up menu: name of group for open-with actions (value "group.openwith").
*
@@ -101,12 +107,12 @@ public interface ISystemContextMenuConstants
* Group name for the "Browse With" submenu
*/
public static final String GROUP_BROWSEWITH= "group.browsewith"; //$NON-NLS-1$
-
+
/**
* Group name for the "Compare With" submenu
*/
public static final String GROUP_COMPAREWITH= "group.comparewith"; //$NON-NLS-1$
-
+
/**
* Group name for the "Replace With" submenu
*/
@@ -156,7 +162,7 @@ public interface ISystemContextMenuConstants
* ID of the submenu for "Open To->"
*/
public static final String MENU_OPENTO= "menu.opento"; //$NON-NLS-1$
-
+
/**
* Pop-up menu: name of group for work-with actions (value "group.workwith").
*
@@ -195,7 +201,7 @@ public interface ISystemContextMenuConstants *
*/ public static final String GROUP_SHOW= "group.show"; //$NON-NLS-1$ - + /** * Pop-up menu: name of group for new actions (value"group.new").
* This is a cascading group.
@@ -221,19 +227,19 @@ public interface ISystemContextMenuConstants
*
*/
public static final String GROUP_NEW_NONCASCADING="group.new.noncascade"; //$NON-NLS-1$
-
+
/**
* Pop-up menu: name of group for build actions (value "group.build").
*/
public static final String GROUP_BUILD= "group.build"; //$NON-NLS-1$
-
+
/**
* Pop-up menu: name of group for reorganize actions (value "group.reorganize").
- */
+ */
public static final String GROUP_REORGANIZE= "group.reorganize"; //$NON-NLS-1$
/**
* Pop-up menu: name of group for reorder actions like move up/down(value "group.reorder").
- */
+ */
public static final String GROUP_REORDER= "group.reorder"; //$NON-NLS-1$
/**
* Pop-up menu: name of group for CHANGE actions. (value "group.change").
@@ -247,31 +253,31 @@ public interface ISystemContextMenuConstants
*
*/
public static final String GROUP_CHANGE = "group.change"; //$NON-NLS-1$
-
+
/**
* Pop-up menu: name of group for code generation or refactoring actions (
* value "group.generate").
- */
+ */
public static final String GROUP_GENERATE= "group.generate"; //$NON-NLS-1$
/**
* Pop-up menu: name of group for search actions (value "group.search").
- */
+ */
public static final String GROUP_SEARCH= "group.search"; //$NON-NLS-1$
-
+
/**
* Pop-up menu: name of group for additional actions (value "group.additions").
- */
+ */
public static final String GROUP_ADDITIONS= IWorkbenchActionConstants.MB_ADDITIONS; //"additions";
/**
* Pop-up menu: name of group for viewer setup actions (value "group.viewerSetup").
- */
+ */
public static final String GROUP_VIEWER_SETUP= "group.viewerSetup"; //$NON-NLS-1$
/**
* Pop-up menu: name of group for properties actions (value "group.properties").
- */
+ */
public static final String GROUP_PROPERTIES= "group.properties"; //$NON-NLS-1$
/**
* Pop-up menu: name of group for actions contributed by the adaptors for the selected object, which
diff --git a/rse/plugins/org.eclipse.rse.ui/model/org/eclipse/rse/ui/model/ISystemRegistryUI.java b/rse/plugins/org.eclipse.rse.ui/model/org/eclipse/rse/ui/model/ISystemRegistryUI.java
index 0af9b7300b8..545786dc168 100644
--- a/rse/plugins/org.eclipse.rse.ui/model/org/eclipse/rse/ui/model/ISystemRegistryUI.java
+++ b/rse/plugins/org.eclipse.rse.ui/model/org/eclipse/rse/ui/model/ISystemRegistryUI.java
@@ -1,21 +1,22 @@
/********************************************************************************
- * Copyright (c) 2006, 2008 IBM Corporation and others. All rights reserved.
+ * Copyright (c) 2006, 2009 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
- *
+ *
* 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,
* Emily Bruner, Mazen Faraj, Adrian Storisteanu, Li Ding, and Kent Hawley.
- *
+ *
* Contributors:
* Martin Oberhuber (Wind River) - [168975] Move RSE Events API to Core
* Martin Oberhuber (Wind River) - [186773] split ISystemRegistryUI from ISystemRegistry
* Martin Oberhuber (Wind River) - [189123] Prepare ISystemRegistry for move into non-UI
* Martin Oberhuber (Wind River) - [190271] Move ISystemViewInputProvider to Core
* Martin Oberhuber (Wind River) - [215820] Move SystemRegistry implementation to Core
+ * Martin Oberhuber (Wind River) - [261486][api][cleanup] Mark @noimplement interfaces as @noextend
********************************************************************************/
package org.eclipse.rse.ui.model;
@@ -31,8 +32,9 @@ import org.eclipse.swt.widgets.Shell;
/**
* Registry and control center for RSE UI related operations.
- *
+ *
* @noimplement This interface is not intended to be implemented by clients.
+ * @noextend This interface is not intended to be extended by clients.
*/
public interface ISystemRegistryUI extends ISystemShellProvider {
diff --git a/terminal/org.eclipse.tm.terminal/src/org/eclipse/tm/internal/terminal/provisional/api/ITerminalConnector.java b/terminal/org.eclipse.tm.terminal/src/org/eclipse/tm/internal/terminal/provisional/api/ITerminalConnector.java
index c8dcc844d26..978c4b89fee 100644
--- a/terminal/org.eclipse.tm.terminal/src/org/eclipse/tm/internal/terminal/provisional/api/ITerminalConnector.java
+++ b/terminal/org.eclipse.tm.terminal/src/org/eclipse/tm/internal/terminal/provisional/api/ITerminalConnector.java
@@ -1,5 +1,5 @@
/*******************************************************************************
- * Copyright (c) 2006, 2008 Wind River Systems, Inc. and others.
+ * Copyright (c) 2006, 2009 Wind River Systems, Inc. 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
@@ -8,6 +8,7 @@
* Contributors:
* Michael Scharf (Wind River) - initial API and implementation
* Martin Oberhuber (Wind River) - fixed copyright headers and beautified
+ * Martin Oberhuber (Wind River) - [261486][api][cleanup] Mark @noimplement interfaces as @noextend
*******************************************************************************/
package org.eclipse.tm.internal.terminal.provisional.api;
@@ -17,15 +18,14 @@ import org.eclipse.core.runtime.IAdaptable;
import org.eclipse.tm.internal.terminal.control.ITerminalViewControl;
import org.eclipse.tm.internal.terminal.provisional.api.provider.TerminalConnectorImpl;
-
/**
* A contributed connection type to manage a single connection.
*
* Implementations of this class are contributed through the
- * org.eclipse.tm.terminal.terminalConnectors extension point.
- * This class gives access to the static markup of a terminal connector
- * extension as well as providing the lifecycle management for the dynamically
- * loaded {@link TerminalConnectorImpl} instance, which performs the actual
+ * org.eclipse.tm.terminal.terminalConnectors extension point. This
+ * class gives access to the static markup of a terminal connector extension as
+ * well as providing the lifecycle management for the dynamically loaded
+ * {@link TerminalConnectorImpl} instance, which performs the actual
* communications. This pattern allows for lazy initialization, bundle
* activation and class loading of the actual {@link TerminalConnectorImpl}
* instance.
@@ -36,13 +36,14 @@ import org.eclipse.tm.internal.terminal.provisional.api.provider.TerminalConnect
* active terminal widget.
*
* @noimplement This interface is not intended to be implemented by clients.
+ * @noextend This interface is not intended to be extended by clients.
*
* @author Michael Scharf
* - * EXPERIMENTAL. This class or interface has been - * added as part of a work in progress. There is no guarantee that this - * API will work or that it will remain the same. Please do not use this - * API without consulting with the EXPERIMENTAL. This class or interface has been added + * as part of a work in progress. There is no guarantee that this API + * will work or that it will remain the same. Please do not use this API + * without consulting with the Target Management team. *
*/ @@ -128,7 +129,7 @@ public interface ITerminalConnector extends IAdaptable { * FIXME should not have UI related stuff in ITerminalConnector, since * connectors may be totally programmatic and UI-less. Better make the * connector adapt to an interface that controls the UI aspect. - * + * * @return a new page that can be used in a dialog to setup this connection. * The dialog should persist its settings with the * {@link #load(ISettingsStore)} and {@link #save(ISettingsStore)} diff --git a/terminal/org.eclipse.tm.terminal/src/org/eclipse/tm/internal/terminal/provisional/api/ITerminalControl.java b/terminal/org.eclipse.tm.terminal/src/org/eclipse/tm/internal/terminal/provisional/api/ITerminalControl.java index fc78b8f6092..ea9046b7a92 100644 --- a/terminal/org.eclipse.tm.terminal/src/org/eclipse/tm/internal/terminal/provisional/api/ITerminalControl.java +++ b/terminal/org.eclipse.tm.terminal/src/org/eclipse/tm/internal/terminal/provisional/api/ITerminalControl.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2006, 2008 Wind River Systems, Inc. and others. + * Copyright (c) 2006, 2009 Wind River Systems, Inc. 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 @@ -9,6 +9,7 @@ * Michael Scharf (Wind River) - initial API and implementation * Martin Oberhuber (Wind River) - fixed copyright headers and beautified * Martin Oberhuber (Wind River) - [204796] Terminal should allow setting the encoding to use + * Martin Oberhuber (Wind River) - [261486][api][cleanup] Mark @noimplement interfaces as @noextend *******************************************************************************/ package org.eclipse.tm.internal.terminal.provisional.api; @@ -20,15 +21,15 @@ import org.eclipse.swt.widgets.Shell; /** * Represents the terminal view as seen by a terminal connection. *- * EXPERIMENTAL. This class or interface has been added as - * part of a work in progress. There is no guarantee that this API will work or - * that it will remain the same. Please do not use this API without consulting - * with the Target Management - * team. + * EXPERIMENTAL. This class or interface has been added as part + * of a work in progress. There is no guarantee that this API will work or that + * it will remain the same. Please do not use this API without consulting with + * the Target Management team. *
* * @author Michael Scharf * @noimplement This interface is not intended to be implemented by clients. + * @noextend This interface is not intended to be extended by clients. */ public interface ITerminalControl { @@ -79,7 +80,7 @@ public interface ITerminalControl { * setEncoding() call failed and the fallback default encoding should be * queried, such that e.g. a combobox with encodings to choose can be * properly initialized. - * + * * @return the current Encoding of the Terminal. * @since org.eclipse.tm.terminal 2.0 */ diff --git a/terminal/org.eclipse.tm.terminal/src/org/eclipse/tm/terminal/model/ITerminalTextData.java b/terminal/org.eclipse.tm.terminal/src/org/eclipse/tm/terminal/model/ITerminalTextData.java index 3b2c9ad5932..3ca18158aa3 100644 --- a/terminal/org.eclipse.tm.terminal/src/org/eclipse/tm/terminal/model/ITerminalTextData.java +++ b/terminal/org.eclipse.tm.terminal/src/org/eclipse/tm/terminal/model/ITerminalTextData.java @@ -1,24 +1,26 @@ /******************************************************************************* - * Copyright (c) 2007, 2008 Wind River Systems, Inc. and others. + * Copyright (c) 2007, 2009 Wind River Systems, Inc. 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 - * + * * Contributors: * Michael Scharf (Wind River) - initial API and implementation + * Martin Oberhuber (Wind River) - [261486][api][cleanup] Mark @noimplement interfaces as @noextend *******************************************************************************/ package org.eclipse.tm.terminal.model; - /** - * A writable matrix of characters and {@link Style}. This is intended to be - * the low level representation of the text of a Terminal. Higher layers are + * A writable matrix of characters and {@link Style}. This is intended to be the + * low level representation of the text of a Terminal. Higher layers are * responsible to fill the text and styles into this representation. ** Note: Implementations of this interface has to be thread safe. *
+ * * @noimplement This interface is not intended to be implemented by clients. + * @noextend This interface is not intended to be extended by clients. */ public interface ITerminalTextData extends ITerminalTextDataReadOnly { @@ -95,7 +97,7 @@ public interface ITerminalTextData extends ITerminalTextDataReadOnly { * 3 dddd * 4 eeee * - * + * * Shift a region of 3 lines up by one lineshift(1,3,-1)
*
* 0 aaaa
@@ -104,8 +106,8 @@ public interface ITerminalTextData extends ITerminalTextDataReadOnly {
* 3
* 4 eeee
*
- *
- *
+ *
+ *
* Shift a region of 3 lines down by one line shift(1,3,1)
*
* 0 aaaa
diff --git a/terminal/org.eclipse.tm.terminal/src/org/eclipse/tm/terminal/model/ITerminalTextDataReadOnly.java b/terminal/org.eclipse.tm.terminal/src/org/eclipse/tm/terminal/model/ITerminalTextDataReadOnly.java
index 183446c191d..0503b4c1ddc 100644
--- a/terminal/org.eclipse.tm.terminal/src/org/eclipse/tm/terminal/model/ITerminalTextDataReadOnly.java
+++ b/terminal/org.eclipse.tm.terminal/src/org/eclipse/tm/terminal/model/ITerminalTextDataReadOnly.java
@@ -1,16 +1,20 @@
/*******************************************************************************
- * Copyright (c) 2007 Wind River Systems, Inc. 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
- *
- * Contributors:
+ * Copyright (c) 2007, 2009 Wind River Systems, Inc. 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
+ *
+ * Contributors:
* Michael Scharf (Wind River) - initial API and implementation
+ * Martin Oberhuber (Wind River) - [261486][api][cleanup] Mark @noimplement interfaces as @noextend
*******************************************************************************/
package org.eclipse.tm.terminal.model;
-
+/**
+ * @noimplement This interface is not intended to be implemented by clients.
+ * @noextend This interface is not intended to be extended by clients.
+ */
public interface ITerminalTextDataReadOnly {
/**
@@ -50,14 +54,14 @@ public interface ITerminalTextDataReadOnly {
* can be used to track changes. Make sure to call {@link ITerminalTextDataSnapshot#detach()}
* if you don't need the snapshots anymore.
* Note: A new snapshot is empty and needs a call to {@link ITerminalTextDataSnapshot#updateSnapshot(boolean)} to
- * get its initial values. You might want to setup the snapshot to your needs by calling
+ * get its initial values. You might want to setup the snapshot to your needs by calling
* {@link ITerminalTextDataSnapshot#setInterestWindow(int, int)}.
*
* @return a new instance of {@link ITerminalTextDataSnapshot} that "listens" to changes of
* this.
*/
public ITerminalTextDataSnapshot makeSnapshot();
-
+
char[] getChars(int line);
Style[] getStyles(int line);
diff --git a/terminal/org.eclipse.tm.terminal/src/org/eclipse/tm/terminal/model/ITerminalTextDataSnapshot.java b/terminal/org.eclipse.tm.terminal/src/org/eclipse/tm/terminal/model/ITerminalTextDataSnapshot.java
index d7da1963f07..198f5edbacb 100644
--- a/terminal/org.eclipse.tm.terminal/src/org/eclipse/tm/terminal/model/ITerminalTextDataSnapshot.java
+++ b/terminal/org.eclipse.tm.terminal/src/org/eclipse/tm/terminal/model/ITerminalTextDataSnapshot.java
@@ -1,12 +1,13 @@
/*******************************************************************************
- * Copyright (c) 2007, 2008 Wind River Systems, Inc. and others.
+ * Copyright (c) 2007, 2009 Wind River Systems, Inc. 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
- *
+ *
* Contributors:
* Michael Scharf (Wind River) - initial API and implementation
+ * Martin Oberhuber (Wind River) - [261486][api][cleanup] Mark @noimplement interfaces as @noextend
*******************************************************************************/
package org.eclipse.tm.terminal.model;
@@ -18,32 +19,32 @@ package org.eclipse.tm.terminal.model;
* {@link ITerminalTextData} might get modified by another thread. Suppose you
* would want to draw the content of the {@link ITerminalTextData} using the
* following loop:
- *
+ *
*
* for (int line = 0; line < term.getHeight(); line++)
* for (int column = 0; column < term.getWidth(); column++)
* drawCharacter(column, line, term.getChar(column, line), term.getStyle(column, line));
*
- *
+ *
* This might fail because the background thread could change the dimensions of
* the {@link ITerminalTextData} while you iterate the loop. One solution would
- * be to put a synchronized(term){} statement around the code.
- * This has two problems: 1. you would have to know about the internals of the
+ * be to put a synchronized(term){} statement around the code. This
+ * has two problems: 1. you would have to know about the internals of the
* synchronisation of {@link ITerminalTextData}. 2. The other thread that
* changes {@link ITerminalTextData} is blocked while the potentially slow
* drawing is done.
*
- * Solution: Take a snapshot of the terminal and use the snapshot to
- * draw the content. There is no danger that the data structure get changed
- * while you draw. There are also methods to find out what has changed to
- * minimize the number of lines that get redrawn.
+ * Solution: Take a snapshot of the terminal and use the snapshot to draw
+ * the content. There is no danger that the data structure get changed while you
+ * draw. There are also methods to find out what has changed to minimize the
+ * number of lines that get redrawn.
*
- *
+ *
*
* Drawing optimization: To optimize redrawing of changed lines, this
* class keeps track of lines that have changed since the previous snapshot.
*
- *
+ *
*
* // iterate over the potentially changed lines
* for (int line = snap.getFirstChangedLine(); line <= snap.getLastChangedLine(); line++)
@@ -52,16 +53,16 @@ package org.eclipse.tm.terminal.model;
* for (int column = 0; column < snap.getWidth(); column++)
* drawCharacter(column, line, snap.getChar(column, line), snap.getStyle(column, line));
*
- *
+ *
*
- * Scroll optimization: Often new lines are appended at the bottom of
- * the terminal and the rest of the lines are scrolled up. In this case all
- * lines would be marked as changed. To optimize for this case,
- * {@link #updateSnapshot(boolean)} can be called with true for
- * the detectScrolling parameter. The object will keep track of
+ * Scroll optimization: Often new lines are appended at the bottom of the
+ * terminal and the rest of the lines are scrolled up. In this case all lines
+ * would be marked as changed. To optimize for this case,
+ * {@link #updateSnapshot(boolean)} can be called with true for the
+ * detectScrolling parameter. The object will keep track of
* scrolling. The UI must first handle the scrolling and then use the
* {@link #hasLineChanged(int)} method to determine scrolling:
- *
+ *
*
* // scroll the visible region of the UI <b>before</b> drawing the changed lines.
* doUIScrolling(snap.getScrollChangeY(), snap.getScrollChangeN(), snap.getScrollChangeShift());
@@ -72,14 +73,16 @@ package org.eclipse.tm.terminal.model;
* for (int column = 0; column < snap.getWidth(); column++)
* drawCharacter(column, line, snap.getChar(column, line), snap.getStyle(column, line));
*
+ *
*
*
* Threading Note: This class is not thread safe! All methods have to be
* called by the a same thread, that created the instance by calling
* {@link ITerminalTextDataReadOnly#makeSnapshot()}.
*
- *
+ *
* @noimplement This interface is not intended to be implemented by clients.
+ * @noextend This interface is not intended to be extended by clients.
*/
public interface ITerminalTextDataSnapshot extends ITerminalTextDataReadOnly {
/**
@@ -92,7 +95,7 @@ public interface ITerminalTextDataSnapshot extends ITerminalTextDataReadOnly {
* A typical terminal view would not update the snapshot immediately
* after the {@link #snapshotOutOfDate(ITerminalTextDataSnapshot)} has been called. It would introduce a
* delay to update the UI (and the snapshot} 10 or 20 times per second.
- *
+ *
* Make sure you don't spend too much time in this method.
*/
interface SnapshotOutOfDateListener {
@@ -146,10 +149,10 @@ public interface ITerminalTextDataSnapshot extends ITerminalTextDataReadOnly {
/**
* @return The first line changed in this snapshot compared
* to the previous snapshot.
- *
+ *
*
Note: If no line has changed, this
* returns {@link Integer#MAX_VALUE}
- *
+ *
*
Note: if {@link #updateSnapshot(boolean)} has been called with true,
* then this does not include lines that only have been scrolled. This is the
* first line that has changed after the scroll has been applied.
@@ -161,13 +164,13 @@ public interface ITerminalTextDataSnapshot extends ITerminalTextDataReadOnly {
* to the previous snapshot. If the height has changed since the
* last update of the snapshot, then the returned value is within
* the new dimensions.
- *
+ *
*
Note: If no line has changed, this returns -1
- *
+ *
*
Note: if {@link #updateSnapshot(boolean)} has been called with true,
* then this does not include lines that only have been scrolled. This is the
* last line that has changed after the scroll has been applied.
- *
+ *
*
A typical for loop using this method would look like this (note the <= in the for loop):
*
* for(int line=snap.{@link #getFirstChangedLine()}; line <= snap.getLastChangedLine(); line++)