mirror of
https://github.com/eclipse-cdt/cdt
synced 2025-07-25 18:05:33 +02:00
Cleanup: Fix various API Markup Issues
This fixes API related issues and warnings by adding appropriate markup
where it had been forgotten. This is formally breaking binary
compatibility in some cases, but we are OK releasing as 4.1 since it
just codifies the original intent of the API.
1. org.eclipse.tm.terminal.control/MANIFEST.MF:
- Replace unintuitive "x-friends" with more obvious "x-internal".
- Update the terminal.test/.classpath instead for giving access.
- Add @noimplement keywords on interfaces where appropriate.
2. org.eclipse.tm.terminal.view.ui:
- Add missing @since tags, and mark the view.showin package as
"x-internal", since it was never meant to be API.
- Add @noimplement keywords on interfaces where appropriate.
3. Generally, remove unnecessary @suppress("restriction") warnings
and fix one "Type Safety (ArrayList)" warning.
Change-Id: I75f8b0fb3a5ff0383bff3bc0a4a8d9fd07b71ac9
Signed-off-by: Martin Oberhuber <martin.oberhuber@windriver.com>
This commit is contained in:
Martin Oberhuber
parent
de7244a8f0
commit
ec23b12ef2
27 changed files with 28 additions and 29 deletions
|
|
@ -87,7 +87,6 @@ public class ProcessMonitor {
|
|||
* Monitors the associated system process, waiting for it to terminate,
|
||||
* and notifies the associated process monitor's.
|
||||
*/
|
||||
@SuppressWarnings("restriction")
|
||||
public void monitorProcess() {
|
||||
// If already disposed -> return immediately
|
||||
if (disposed) return;
|
||||
|
|
|
|||
|
|
@ -12,14 +12,14 @@ Bundle-ActivationPolicy: lazy
|
|||
Eclipse-LazyStart: true
|
||||
Bundle-RequiredExecutionEnvironment: JavaSE-1.6
|
||||
Bundle-ClassPath: .
|
||||
Export-Package: org.eclipse.tm.internal.terminal.connector;x-friends:="org.eclipse.tm.terminal.test",
|
||||
Export-Package: org.eclipse.tm.internal.terminal.connector;x-internal:=true,
|
||||
org.eclipse.tm.internal.terminal.control,
|
||||
org.eclipse.tm.internal.terminal.control.actions,
|
||||
org.eclipse.tm.internal.terminal.control.impl;x-friends:="org.eclipse.tm.terminal.test",
|
||||
org.eclipse.tm.internal.terminal.emulator;x-friends:="org.eclipse.tm.terminal.test",
|
||||
org.eclipse.tm.internal.terminal.model;x-friends:="org.eclipse.tm.terminal.test",
|
||||
org.eclipse.tm.internal.terminal.control.impl;x-internal:=true,
|
||||
org.eclipse.tm.internal.terminal.emulator;x-internal:=true,
|
||||
org.eclipse.tm.internal.terminal.model;x-internal:=true,
|
||||
org.eclipse.tm.internal.terminal.preferences,
|
||||
org.eclipse.tm.internal.terminal.provisional.api,
|
||||
org.eclipse.tm.internal.terminal.provisional.api.provider,
|
||||
org.eclipse.tm.internal.terminal.textcanvas;x-friends:="org.eclipse.tm.terminal.test",
|
||||
org.eclipse.tm.internal.terminal.textcanvas;x-internal:=true,
|
||||
org.eclipse.tm.terminal.model
|
||||
|
|
|
|||
|
|
@ -26,6 +26,7 @@ import org.eclipse.tm.internal.terminal.provisional.api.TerminalState;
|
|||
/**
|
||||
* @author Michael Scharf
|
||||
*
|
||||
* @noimplement This interface is not intended to be implemented by clients.
|
||||
*/
|
||||
public interface ITerminalViewControl {
|
||||
/**
|
||||
|
|
|
|||
|
|
@ -1,7 +1,11 @@
|
|||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<classpath>
|
||||
<classpathentry kind="con" path="org.eclipse.jdt.launching.JRE_CONTAINER/org.eclipse.jdt.internal.debug.ui.launcher.StandardVMType/JavaSE-1.6"/>
|
||||
<classpathentry kind="con" path="org.eclipse.pde.core.requiredPlugins"/>
|
||||
<classpathentry kind="con" path="org.eclipse.pde.core.requiredPlugins">
|
||||
<accessrules>
|
||||
<accessrule kind="accessible" pattern="org/eclipse/tm/internal/terminal/**"/>
|
||||
</accessrules>
|
||||
</classpathentry>
|
||||
<classpathentry kind="src" path="src"/>
|
||||
<classpathentry kind="output" path="bin"/>
|
||||
</classpath>
|
||||
|
|
|
|||
|
|
@ -42,7 +42,7 @@ public class TerminalTextDataWindowTest extends AbstractITerminalTextDataTest {
|
|||
StringBuffer b=new StringBuffer();
|
||||
// String[] lines=s.split("\n");
|
||||
// <J2ME CDC-1.1 Foundation-1.1 variant>
|
||||
ArrayList l = new ArrayList();
|
||||
ArrayList<String> l = new ArrayList<String>();
|
||||
int j = 0;
|
||||
for (int k = 0; k < s.length(); k++) {
|
||||
if (s.charAt(k) == '\n') {
|
||||
|
|
@ -56,7 +56,7 @@ public class TerminalTextDataWindowTest extends AbstractITerminalTextDataTest {
|
|||
}
|
||||
String[] lines = new String[j + 1];
|
||||
while (j >= 0) {
|
||||
lines[j] = (String) l.get(j);
|
||||
lines[j] = l.get(j);
|
||||
j--;
|
||||
}
|
||||
// </J2ME CDC-1.1 Foundation-1.1 variant>
|
||||
|
|
|
|||
|
|
@ -33,4 +33,4 @@ Export-Package: org.eclipse.tm.terminal.view.ui.actions,
|
|||
org.eclipse.tm.terminal.view.ui.streams,
|
||||
org.eclipse.tm.terminal.view.ui.tabs,
|
||||
org.eclipse.tm.terminal.view.ui.view,
|
||||
org.eclipse.tm.terminal.view.ui.view.showin
|
||||
org.eclipse.tm.terminal.view.ui.view.showin;x-internal:=true
|
||||
|
|
|
|||
|
|
@ -20,6 +20,8 @@ import org.eclipse.tm.terminal.view.ui.nls.Messages;
|
|||
|
||||
/**
|
||||
* Opens a new terminal view with a new secondary view ID.
|
||||
*
|
||||
* @since 4.1
|
||||
*/
|
||||
public class NewTerminalViewAction extends AbstractTerminalAction {
|
||||
|
||||
|
|
|
|||
|
|
@ -25,7 +25,6 @@ import org.eclipse.tm.terminal.view.ui.tabs.TabFolderManager;
|
|||
/**
|
||||
* Terminal control select encoding action implementation.
|
||||
*/
|
||||
@SuppressWarnings("restriction")
|
||||
public class SelectEncodingAction extends AbstractTerminalAction {
|
||||
// Reference to the parent tab folder manager
|
||||
private final TabFolderManager tabFolderManager;
|
||||
|
|
|
|||
|
|
@ -20,7 +20,6 @@ import org.eclipse.tm.terminal.view.ui.nls.Messages;
|
|||
/**
|
||||
* Terminal console tab scroll lock action.
|
||||
*/
|
||||
@SuppressWarnings("restriction")
|
||||
public class TabScrollLockAction extends AbstractTerminalAction {
|
||||
|
||||
/**
|
||||
|
|
|
|||
|
|
@ -24,7 +24,6 @@ import org.eclipse.tm.terminal.view.ui.tabs.TabFolderManager;
|
|||
/**
|
||||
* Toggle command input field.
|
||||
*/
|
||||
@SuppressWarnings("restriction")
|
||||
public class ToggleCommandFieldAction extends AbstractTerminalAction {
|
||||
private ITerminalsView view = null;
|
||||
|
||||
|
|
|
|||
|
|
@ -43,7 +43,6 @@ import org.osgi.framework.BundleContext;
|
|||
/**
|
||||
* The activator class controls the plug-in life cycle
|
||||
*/
|
||||
@SuppressWarnings("restriction")
|
||||
public class UIPlugin extends AbstractUIPlugin {
|
||||
// The shared instance
|
||||
private static UIPlugin plugin;
|
||||
|
|
|
|||
|
|
@ -20,7 +20,6 @@ import org.eclipse.tm.terminal.view.core.interfaces.ITerminalService;
|
|||
/**
|
||||
* Terminal launcher delegate.
|
||||
*/
|
||||
@SuppressWarnings("restriction")
|
||||
public interface ILauncherDelegate extends IExecutableExtension, IAdaptable {
|
||||
|
||||
/**
|
||||
|
|
|
|||
|
|
@ -11,6 +11,9 @@ package org.eclipse.tm.terminal.view.ui.interfaces;
|
|||
|
||||
/**
|
||||
* Terminal plug-in preference key definitions.
|
||||
*
|
||||
* @noextend This interface is not intended to be extended by clients.
|
||||
* @noimplement This interface is not intended to be implemented by clients.
|
||||
*/
|
||||
public interface IPreferenceKeys {
|
||||
/**
|
||||
|
|
|
|||
|
|
@ -12,6 +12,9 @@ package org.eclipse.tm.terminal.view.ui.interfaces;
|
|||
|
||||
/**
|
||||
* Image registry constants.
|
||||
*
|
||||
* @noextend This interface is not intended to be extended by clients.
|
||||
* @noimplement This interface is not intended to be implemented by clients.
|
||||
*/
|
||||
public interface ImageConsts {
|
||||
/**
|
||||
|
|
@ -66,16 +69,19 @@ public interface ImageConsts {
|
|||
|
||||
/**
|
||||
* The key to access the new terminal view action image (enabled).
|
||||
* @since 4.1
|
||||
*/
|
||||
public static final String ACTION_NewTerminalView_Enabled = "NewTerminalViewAction_enabled"; //$NON-NLS-1$
|
||||
|
||||
/**
|
||||
* The key to access the new terminal view action image (disabled).
|
||||
* @since 4.1
|
||||
*/
|
||||
public static final String ACTION_NewTerminalView_Disabled = "NewTerminalViewAction_disabled"; //$NON-NLS-1$
|
||||
|
||||
/**
|
||||
* The key to access the new terminal view action image (hover).
|
||||
* @since 4.1
|
||||
*/
|
||||
public static final String ACTION_NewTerminalView_Hover = "NewTerminalViewAction_hover"; //$NON-NLS-1$
|
||||
|
||||
|
|
|
|||
|
|
@ -22,7 +22,6 @@ import org.eclipse.tm.terminal.view.ui.tabs.TabFolderManager;
|
|||
/**
|
||||
* Terminal property tester implementation.
|
||||
*/
|
||||
@SuppressWarnings("restriction")
|
||||
public class PropertyTester extends org.eclipse.core.expressions.PropertyTester {
|
||||
|
||||
/* (non-Javadoc)
|
||||
|
|
|
|||
|
|
@ -19,7 +19,6 @@ import org.eclipse.tm.internal.terminal.provisional.api.ISettingsStore;
|
|||
* Simple default Terminal settings store implementation keeping the settings
|
||||
* within memory.
|
||||
*/
|
||||
@SuppressWarnings("restriction")
|
||||
public class SettingsStore implements ISettingsStore {
|
||||
private final Map<String, Object> settings = new HashMap<String, Object>();
|
||||
|
||||
|
|
|
|||
|
|
@ -49,7 +49,6 @@ import org.eclipse.ui.PlatformUI;
|
|||
/**
|
||||
* Terminal console manager.
|
||||
*/
|
||||
@SuppressWarnings("restriction")
|
||||
public class ConsoleManager {
|
||||
|
||||
// Constant to indicate any secondary id is acceptable
|
||||
|
|
@ -283,6 +282,7 @@ public class ConsoleManager {
|
|||
*
|
||||
* @param id The terminals console view id. Must not be <code>null</code>.
|
||||
* @return The next secondary id, or <code>null</code> if it is the first one
|
||||
* @since 4.1
|
||||
*/
|
||||
public String getNextTerminalSecondaryId(String id) {
|
||||
Assert.isNotNull(id);
|
||||
|
|
|
|||
|
|
@ -21,7 +21,6 @@ import org.eclipse.ui.services.IDisposable;
|
|||
/**
|
||||
* Streams connector implementation.
|
||||
*/
|
||||
@SuppressWarnings("restriction")
|
||||
public abstract class AbstractStreamsConnector extends TerminalConnectorImpl {
|
||||
// Reference to the stdin monitor
|
||||
private InputStreamMonitor stdInMonitor;
|
||||
|
|
|
|||
|
|
@ -32,7 +32,6 @@ import org.eclipse.ui.services.IDisposable;
|
|||
* <b>Note:</b> The input is coming <i>from</i> the terminal. Therefore, the input
|
||||
* stream monitor is attached to the stdin stream of the monitored (remote) process.
|
||||
*/
|
||||
@SuppressWarnings("restriction")
|
||||
public class InputStreamMonitor extends OutputStream implements IDisposable {
|
||||
// Reference to the parent terminal control
|
||||
private final ITerminalControl terminalControl;
|
||||
|
|
|
|||
|
|
@ -35,7 +35,6 @@ import org.eclipse.ui.services.IDisposable;
|
|||
* stream monitor is attached to the stdout and/or stderr stream of the monitored
|
||||
* (remote) process.
|
||||
*/
|
||||
@SuppressWarnings("restriction")
|
||||
public class OutputStreamMonitor implements IDisposable {
|
||||
// The default buffer size to use
|
||||
private static final int BUFFER_SIZE = 8192;
|
||||
|
|
|
|||
|
|
@ -19,7 +19,6 @@ import org.eclipse.ui.services.IDisposable;
|
|||
/**
|
||||
* Streams connector implementation.
|
||||
*/
|
||||
@SuppressWarnings("restriction")
|
||||
public class StreamsConnector extends AbstractStreamsConnector implements IDisposable {
|
||||
// Reference to the streams settings
|
||||
private final StreamsSettings settings;
|
||||
|
|
|
|||
|
|
@ -29,7 +29,6 @@ import org.eclipse.tm.terminal.view.ui.launcher.AbstractLauncherDelegate;
|
|||
/**
|
||||
* Streams launcher delegate implementation.
|
||||
*/
|
||||
@SuppressWarnings("restriction")
|
||||
public class StreamsLauncherDelegate extends AbstractLauncherDelegate {
|
||||
|
||||
/* (non-Javadoc)
|
||||
|
|
|
|||
|
|
@ -20,7 +20,6 @@ import org.eclipse.tm.terminal.view.ui.internal.SettingsStore;
|
|||
/**
|
||||
* Streams connector settings implementation.
|
||||
*/
|
||||
@SuppressWarnings("restriction")
|
||||
public class StreamsSettings {
|
||||
// Reference to the stdin stream
|
||||
private OutputStream stdin;
|
||||
|
|
|
|||
|
|
@ -59,7 +59,6 @@ import org.eclipse.ui.PlatformUI;
|
|||
/**
|
||||
* Terminal tab folder manager.
|
||||
*/
|
||||
@SuppressWarnings({ "restriction" })
|
||||
public class TabFolderManager extends PlatformObject implements ISelectionProvider {
|
||||
// Reference to the parent terminal consoles view
|
||||
private final ITerminalsView parentView;
|
||||
|
|
|
|||
|
|
@ -41,7 +41,6 @@ import org.eclipse.ui.IWorkbenchActionConstants;
|
|||
/**
|
||||
* Terminal tab folder menu handler.
|
||||
*/
|
||||
@SuppressWarnings("restriction")
|
||||
public class TabFolderMenuHandler extends PlatformObject {
|
||||
// Reference to the parent terminals console view
|
||||
private final ITerminalsView parentView;
|
||||
|
|
|
|||
|
|
@ -40,7 +40,6 @@ import org.eclipse.ui.IWorkbenchActionConstants;
|
|||
/**
|
||||
* Terminal tab folder toolbar handler.
|
||||
*/
|
||||
@SuppressWarnings("restriction")
|
||||
public class TabFolderToolbarHandler extends PlatformObject {
|
||||
// Reference to the parent terminals console view
|
||||
private final ITerminalsView parentView;
|
||||
|
|
|
|||
|
|
@ -21,7 +21,6 @@ import org.eclipse.tm.terminal.view.ui.nls.Messages;
|
|||
/**
|
||||
* Terminal tab default terminal listener implementation.
|
||||
*/
|
||||
@SuppressWarnings("restriction")
|
||||
public class TabTerminalListener implements ITerminalListener2 {
|
||||
private static final String TAB_TERMINAL_LISTENER = "TabTerminalListener"; //$NON-NLS-1$
|
||||
/* default */ final TabFolderManager tabFolderManager;
|
||||
|
|
@ -150,8 +149,9 @@ public class TabTerminalListener implements ITerminalListener2 {
|
|||
public void setTerminalTitle(String title) {
|
||||
}
|
||||
|
||||
/* (non-Javadoc)
|
||||
/**
|
||||
* @see org.eclipse.tm.internal.terminal.control.ITerminalListener2#setTerminalSelectionChanged()
|
||||
* @since 4.1
|
||||
*/
|
||||
@Override
|
||||
public void setTerminalSelectionChanged() {
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue