mirror of
https://github.com/eclipse-cdt/cdt
synced 2025-08-06 15:55:47 +02:00
[261486][api][cleanup] Mark @noimplement interfaces as @noextend
This commit is contained in:
Martin Oberhuber
parent
e1c0a8fe9b
commit
2656a58a7e
36 changed files with 391 additions and 309 deletions
|
|
@ -1,5 +1,5 @@
|
|||
/*******************************************************************************
|
||||
* Copyright (c) 2008 Wind River Systems, Inc.
|
||||
* Copyright (c) 2008, 2009 Wind River Systems, Inc.
|
||||
* 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:
|
||||
* Johann Draschwandtner (Wind River) - initial API and implementation
|
||||
* Martin Oberhuber (Wind River) - [261486][api][cleanup] Mark @noimplement interfaces as @noextend
|
||||
*******************************************************************************/
|
||||
package org.eclipse.rse.internal.remotecdt;
|
||||
|
||||
|
|
@ -20,6 +21,7 @@ package org.eclipse.rse.internal.remotecdt;
|
|||
* </p>
|
||||
*
|
||||
* @noimplement This interface is not intended to be implemented by clients.
|
||||
* @noextend This interface is not intended to be extended by clients.
|
||||
* @since org.eclipse.rse.remotecdt 2.1
|
||||
*/
|
||||
public interface IRemoteConnectionHostConstants {
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
/********************************************************************************
|
||||
* Copyright (c) 2003, 2008 IBM Corporation. All rights reserved.
|
||||
* Copyright (c) 2003, 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,16 +12,18 @@
|
|||
*
|
||||
* 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;
|
||||
|
||||
/**
|
||||
* <p>
|
||||
* 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
|
||||
{
|
||||
|
|
|
|||
|
|
@ -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) - [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
|
||||
{
|
||||
|
|
|
|||
|
|
@ -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,
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
|
@ -13,6 +13,7 @@
|
|||
*
|
||||
* Contributors:
|
||||
* 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;
|
||||
|
|
@ -21,6 +22,7 @@ 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);
|
||||
|
|
|
|||
|
|
@ -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 {
|
||||
|
||||
|
|
|
|||
|
|
@ -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 {
|
||||
|
||||
|
|
|
|||
|
|
@ -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.
|
||||
*/
|
||||
|
||||
/*
|
||||
|
|
|
|||
|
|
@ -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,10 +33,11 @@ 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.
|
||||
* <p>
|
||||
*
|
||||
* @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.
|
||||
* </p>
|
||||
*/
|
||||
public interface IRSESystemType extends IAdaptable {
|
||||
|
|
|
|||
|
|
@ -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,6 +7,7 @@
|
|||
* 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;
|
||||
|
||||
|
|
@ -16,6 +17,7 @@ package org.eclipse.rse.core;
|
|||
*
|
||||
* @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 {
|
||||
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
/********************************************************************************
|
||||
* 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
|
||||
|
|
@ -12,6 +12,7 @@
|
|||
*
|
||||
* 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;
|
||||
|
|
@ -21,6 +22,7 @@ package org.eclipse.rse.core;
|
|||
* 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 {
|
||||
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
/********************************************************************************
|
||||
* 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
|
||||
|
|
@ -14,23 +14,29 @@
|
|||
* 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.
|
||||
* <p>
|
||||
* 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)}.
|
||||
* <p>
|
||||
* 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 {
|
||||
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
/********************************************************************************
|
||||
* 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
|
||||
|
|
@ -13,6 +13,7 @@
|
|||
* 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;
|
||||
|
|
@ -21,6 +22,7 @@ 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 {
|
||||
/**
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
/********************************************************************************
|
||||
* 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
|
||||
|
|
@ -14,6 +14,7 @@
|
|||
* 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;
|
||||
|
|
@ -23,6 +24,7 @@ package org.eclipse.rse.core.events;
|
|||
* 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
|
||||
{
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
/********************************************************************************
|
||||
* 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
|
||||
|
|
@ -13,6 +13,7 @@
|
|||
* 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;
|
||||
|
|
@ -23,6 +24,7 @@ import org.eclipse.rse.core.subsystems.IRemoteObjectIdentifier;
|
|||
* Interface of event ID constants
|
||||
*
|
||||
* @noimplement This interface is not intended to be implemented by clients.
|
||||
* @noextend This interface is not intended to be extended by clients.
|
||||
*/
|
||||
public interface ISystemResourceChangeEvents
|
||||
{
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
|
@ -14,17 +14,21 @@
|
|||
* 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
|
||||
* Martin Oberhuber (Wind River) - [261486][api][cleanup] Mark @noimplement interfaces as @noextend
|
||||
********************************************************************************/
|
||||
|
||||
package org.eclipse.rse.core.model;
|
||||
|
||||
/**
|
||||
* Properties are contained in property sets ({@link IPropertySet}) and may be associated with objects that
|
||||
* implement {@link IPropertySetContainer}. These would typically be model objects.
|
||||
* Properties also have a type (see {@link IPropertyType}).
|
||||
* Properties are contained in property sets ({@link IPropertySet}) and may be
|
||||
* associated with objects that implement {@link IPropertySetContainer}. These
|
||||
* would typically be model objects. Properties also have a type (see
|
||||
* {@link IPropertyType}).
|
||||
*
|
||||
* @see IRSEModelObject
|
||||
* @noimplement This interface is not intended to be implemented by clients.
|
||||
* Use {@link Property} directly.
|
||||
* @noextend This interface is not intended to be extended by clients. Use
|
||||
* {@link Property} directly.
|
||||
*/
|
||||
public interface IProperty {
|
||||
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
|
@ -15,6 +15,7 @@
|
|||
* 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
|
||||
* Martin Oberhuber (Wind River) - [261486][api][cleanup] Mark @noimplement interfaces as @noextend
|
||||
*******************************************************************************/
|
||||
|
||||
package org.eclipse.rse.core.model;
|
||||
|
|
@ -22,18 +23,20 @@ package org.eclipse.rse.core.model;
|
|||
import java.util.Map;
|
||||
|
||||
/**
|
||||
* A Property Set stores key/value pairs, where the keys
|
||||
* are Strings and the values are an {@link IProperty},
|
||||
* of a type declared by an {@link IPropertyType}.
|
||||
* A Property Set stores key/value pairs, where the keys are Strings and the
|
||||
* values are an {@link IProperty}, of a type declared by an
|
||||
* {@link IPropertyType}.
|
||||
*
|
||||
* The Property Set is identified by a name.
|
||||
* By default, the type of each property is of type String, and
|
||||
* in fact each value can be retrieved in String representation.
|
||||
* The Property Set is identified by a name. By default, the type of each
|
||||
* property is of type String, and in fact each value can be retrieved in String
|
||||
* representation.
|
||||
*
|
||||
* The key <code>"description"</code> is reserved for internal use, to store the
|
||||
* description of the Property set.
|
||||
*
|
||||
* The key <code>"description"</code> 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 {
|
||||
/**
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
|
@ -13,14 +13,17 @@
|
|||
* 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}.
|
||||
*
|
||||
* @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 {
|
||||
|
||||
|
|
|
|||
|
|
@ -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 {
|
||||
/**
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
|
@ -13,14 +13,18 @@
|
|||
*
|
||||
* 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 {
|
||||
/**
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
|
@ -20,6 +20,7 @@
|
|||
* 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.
|
||||
* <p>
|
||||
* Profiles may be active or inactive. An active profile contributes its
|
||||
* definitions to RSE. When made inactive, it those definition are no longer
|
||||
* available for use.
|
||||
* <p>
|
||||
*
|
||||
* @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 {
|
||||
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
|
@ -16,6 +16,7 @@
|
|||
* 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;
|
||||
|
|
@ -29,7 +30,8 @@ import org.eclipse.core.runtime.IStatus;
|
|||
* 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 {
|
||||
|
||||
|
|
|
|||
|
|
@ -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.
|
||||
* </p>
|
||||
*
|
||||
* @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 {
|
||||
|
||||
|
|
|
|||
|
|
@ -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,6 +13,7 @@
|
|||
*
|
||||
* 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;
|
||||
|
|
@ -21,6 +22,7 @@ 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 {
|
||||
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
|
@ -13,6 +13,7 @@
|
|||
* 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;
|
||||
|
|
@ -21,6 +22,7 @@ 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
|
||||
{
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
|
@ -14,19 +14,19 @@
|
|||
* 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$
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
|
@ -14,6 +14,7 @@
|
|||
* 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;
|
||||
|
|
@ -22,6 +23,7 @@ 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
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
|
@ -12,7 +12,7 @@
|
|||
* 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;
|
||||
|
|
@ -21,6 +21,7 @@ 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 {
|
||||
|
||||
|
|
|
|||
|
|
@ -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 {
|
||||
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
|
@ -12,25 +12,29 @@
|
|||
* 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.
|
||||
* <pre><code>
|
||||
* Constants defining our groups inside our right-click popup menu in the system
|
||||
* view.
|
||||
*
|
||||
* <pre>
|
||||
* <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 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 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
|
||||
|
|
@ -43,9 +47,11 @@ import org.eclipse.ui.IWorkbenchActionConstants;
|
|||
* 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
|
||||
* </code></pre>
|
||||
* </code>
|
||||
* </pre>
|
||||
*
|
||||
* @noimplement This interface is not intended to be implemented by clients.
|
||||
* @noextend This interface is not intended to be extended by clients.
|
||||
*/
|
||||
public interface ISystemContextMenuConstants
|
||||
{
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
|
@ -16,6 +16,7 @@
|
|||
* 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;
|
||||
|
||||
|
|
@ -33,6 +34,7 @@ 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 {
|
||||
|
||||
|
|
|
|||
|
|
@ -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
|
||||
* <code>org.eclipse.tm.terminal.terminalConnectors</code> 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
|
||||
* <code>org.eclipse.tm.terminal.terminalConnectors</code> 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
|
||||
* <p>
|
||||
* <strong>EXPERIMENTAL</strong>. 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 <a
|
||||
* <strong>EXPERIMENTAL</strong>. 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 <a
|
||||
* href="http://www.eclipse.org/dsdp/tm/">Target Management</a> team.
|
||||
* </p>
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -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.
|
||||
* <p>
|
||||
* <strong>EXPERIMENTAL</strong>. 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 <a href="http://www.eclipse.org/dsdp/tm/">Target Management</a>
|
||||
* team.
|
||||
* <strong>EXPERIMENTAL</strong>. 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 <a href="http://www.eclipse.org/dsdp/tm/">Target Management</a> team.
|
||||
* </p>
|
||||
*
|
||||
* @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 {
|
||||
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
/*******************************************************************************
|
||||
* 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
|
||||
|
|
@ -7,18 +7,20 @@
|
|||
*
|
||||
* 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.
|
||||
* <p>
|
||||
* <b>Note: </b> Implementations of this interface has to be thread safe.
|
||||
* </p>
|
||||
*
|
||||
* @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 {
|
||||
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
/*******************************************************************************
|
||||
* Copyright (c) 2007 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
|
||||
|
|
@ -7,10 +7,14 @@
|
|||
*
|
||||
* 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 {
|
||||
|
||||
/**
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
/*******************************************************************************
|
||||
* 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
|
||||
|
|
@ -7,6 +7,7 @@
|
|||
*
|
||||
* 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;
|
||||
|
||||
|
|
@ -27,16 +28,16 @@ package org.eclipse.tm.terminal.model;
|
|||
*
|
||||
* 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 <code>synchronized(term){}</code> statement around the code.
|
||||
* This has two problems: 1. you would have to know about the internals of the
|
||||
* be to put a <code>synchronized(term){}</code> 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.
|
||||
* <p>
|
||||
* <b>Solution:</b> 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.
|
||||
* <b>Solution:</b> 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.
|
||||
* </p>
|
||||
*
|
||||
* <p>
|
||||
|
|
@ -54,11 +55,11 @@ package org.eclipse.tm.terminal.model;
|
|||
* </pre>
|
||||
*
|
||||
* <p>
|
||||
* <b>Scroll optimization:</b> 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 <code>true</code> for
|
||||
* the <code>detectScrolling</code> parameter. The object will keep track of
|
||||
* <b>Scroll optimization:</b> 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 <code>true</code> for the
|
||||
* <code>detectScrolling</code> parameter. The object will keep track of
|
||||
* scrolling. The UI must <b>first</b> handle the scrolling and then use the
|
||||
* {@link #hasLineChanged(int)} method to determine scrolling:
|
||||
*
|
||||
|
|
@ -72,6 +73,7 @@ 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));
|
||||
* </pre>
|
||||
*
|
||||
* </p>
|
||||
* <p>
|
||||
* <b>Threading Note</b>: This class is not thread safe! All methods have to be
|
||||
|
|
@ -80,6 +82,7 @@ package org.eclipse.tm.terminal.model;
|
|||
* </p>
|
||||
*
|
||||
* @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 {
|
||||
/**
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue