From 151c0d309231f2dc870017e9fb7e8c252fc3daaf Mon Sep 17 00:00:00 2001
From: Martin Oberhuber < martin.oberhuber@windriver.com>
Date: Mon, 15 Mar 2010 12:51:01 +0000
Subject: [PATCH] Bug 304170 -  [api] ISystemFileTypes and
 ISystemFileTransferModeMapping should be marked @noimplement

---
 .../template/buildNotes.php                     |  9 ++++++++-
 .../.settings/.api_filters                      |  7 +++++++
 .../services/clientserver/ISystemFileTypes.java |  2 +-
 .../.settings/.api_filters                      | 17 +++++++++++++++++
 .../model/ISystemFileTransferModeMapping.java   |  1 +
 .../model/ISystemFileTransferModeRegistry.java  |  6 +++++-
 6 files changed, 39 insertions(+), 3 deletions(-)
 create mode 100644 rse/plugins/org.eclipse.rse.subsystems.files.core/.settings/.api_filters

diff --git a/releng/org.eclipse.rse.build/template/buildNotes.php b/releng/org.eclipse.rse.build/template/buildNotes.php
index 89041a2068c..c6e4e2f65f5 100755
--- a/releng/org.eclipse.rse.build/template/buildNotes.php
+++ b/releng/org.eclipse.rse.build/template/buildNotes.php
@@ -119,7 +119,14 @@ More information can be found in the associated bugzilla items.
 <ul>
 <li>TM @buildId@ API Specification Updates
 <ul>
-  <li>None.</li>
+  <li>The <code><a href="http://dsdp.eclipse.org/help/latest/topic/org.eclipse.rse.doc.isv/reference/api/org/eclipse/rse/services/clientserver/ISystemFileTypes.html">ISystemFileTypes</a></code>,
+      <code><a href="http://dsdp.eclipse.org/help/latest/topic/org.eclipse.rse.doc.isv/reference/api/org/eclipse/rse/subsystems/files/core/model/ISystemFileTransferModeMapping.html">ISystemFileTransferModeMapping</a></code>
+      and <code><a href="http://dsdp.eclipse.org/help/latest/topic/org.eclipse.rse.doc.isv/reference/api/org/eclipse/rse/subsystems/files/core/model/ISystemFileTransferModeRegistry.html">ISystemFileTransferModeRegistry</a></code>
+      interfaces have been marked <b>@noimplement</b> in order to allow adding new methods.
+      These interfaces had not been documented at all so far, and have never been intended
+      to be implemented. The amendment adds a restriction which should have been there
+      from the start 
+      [<a href="https://bugs.eclipse.org/bugs/show_bug.cgi?id=304170">304170</a>].</li>
 </ul></li>
 </ul>
 </li>
diff --git a/rse/plugins/org.eclipse.rse.services/.settings/.api_filters b/rse/plugins/org.eclipse.rse.services/.settings/.api_filters
index 62a43f14b91..19273c2d6c7 100644
--- a/rse/plugins/org.eclipse.rse.services/.settings/.api_filters
+++ b/rse/plugins/org.eclipse.rse.services/.settings/.api_filters
@@ -98,6 +98,13 @@
             </message_arguments>
         </filter>
     </resource>
+    <resource path="clientserver/org/eclipse/rse/services/clientserver/ISystemFileTypes.java" type="org.eclipse.rse.services.clientserver.ISystemFileTypes">
+        <filter id="403853384">
+            <message_arguments>
+                <message_argument value="org.eclipse.rse.services.clientserver.ISystemFileTypes"/>
+            </message_arguments>
+        </filter>
+    </resource>
     <resource path="src/org/eclipse/rse/internal/services/terminals/ProcessBaseShell.java" type="org.eclipse.rse.internal.services.terminals.ProcessBaseShell">
         <filter id="305365105">
             <message_arguments>
diff --git a/rse/plugins/org.eclipse.rse.services/clientserver/org/eclipse/rse/services/clientserver/ISystemFileTypes.java b/rse/plugins/org.eclipse.rse.services/clientserver/org/eclipse/rse/services/clientserver/ISystemFileTypes.java
index 08a19150199..b60b08a0cad 100644
--- a/rse/plugins/org.eclipse.rse.services/clientserver/org/eclipse/rse/services/clientserver/ISystemFileTypes.java
+++ b/rse/plugins/org.eclipse.rse.services/clientserver/org/eclipse/rse/services/clientserver/ISystemFileTypes.java
@@ -20,7 +20,7 @@ package org.eclipse.rse.services.clientserver;
 
 import java.io.File;
 
-/*
+/**
  *  Used to determine whether a file is binary, text or XML.
  *  
  * @noimplement This interface is not intended to be implemented by clients.
diff --git a/rse/plugins/org.eclipse.rse.subsystems.files.core/.settings/.api_filters b/rse/plugins/org.eclipse.rse.subsystems.files.core/.settings/.api_filters
new file mode 100644
index 00000000000..de8ce70a17b
--- /dev/null
+++ b/rse/plugins/org.eclipse.rse.subsystems.files.core/.settings/.api_filters
@@ -0,0 +1,17 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<component id="org.eclipse.rse.subsystems.files.core" version="2">
+    <resource path="src/org/eclipse/rse/subsystems/files/core/model/ISystemFileTransferModeMapping.java" type="org.eclipse.rse.subsystems.files.core.model.ISystemFileTransferModeMapping">
+        <filter id="403853384">
+            <message_arguments>
+                <message_argument value="org.eclipse.rse.subsystems.files.core.model.ISystemFileTransferModeMapping"/>
+            </message_arguments>
+        </filter>
+    </resource>
+    <resource path="src/org/eclipse/rse/subsystems/files/core/model/ISystemFileTransferModeRegistry.java" type="org.eclipse.rse.subsystems.files.core.model.ISystemFileTransferModeRegistry">
+        <filter id="403853384">
+            <message_arguments>
+                <message_argument value="org.eclipse.rse.subsystems.files.core.model.ISystemFileTransferModeRegistry"/>
+            </message_arguments>
+        </filter>
+    </resource>
+</component>
diff --git a/rse/plugins/org.eclipse.rse.subsystems.files.core/src/org/eclipse/rse/subsystems/files/core/model/ISystemFileTransferModeMapping.java b/rse/plugins/org.eclipse.rse.subsystems.files.core/src/org/eclipse/rse/subsystems/files/core/model/ISystemFileTransferModeMapping.java
index d33a67b2f86..3df87586f36 100644
--- a/rse/plugins/org.eclipse.rse.subsystems.files.core/src/org/eclipse/rse/subsystems/files/core/model/ISystemFileTransferModeMapping.java
+++ b/rse/plugins/org.eclipse.rse.subsystems.files.core/src/org/eclipse/rse/subsystems/files/core/model/ISystemFileTransferModeMapping.java
@@ -82,6 +82,7 @@ public interface ISystemFileTransferModeMapping {
 	 * Returns if the mapping is XML
 	 * 
 	 * @return true if XML
+	 * @since 3.2
 	 */
 	public boolean isXML();
 	
diff --git a/rse/plugins/org.eclipse.rse.subsystems.files.core/src/org/eclipse/rse/subsystems/files/core/model/ISystemFileTransferModeRegistry.java b/rse/plugins/org.eclipse.rse.subsystems.files.core/src/org/eclipse/rse/subsystems/files/core/model/ISystemFileTransferModeRegistry.java
index ea75f1f253d..f6a98e53065 100644
--- a/rse/plugins/org.eclipse.rse.subsystems.files.core/src/org/eclipse/rse/subsystems/files/core/model/ISystemFileTransferModeRegistry.java
+++ b/rse/plugins/org.eclipse.rse.subsystems.files.core/src/org/eclipse/rse/subsystems/files/core/model/ISystemFileTransferModeRegistry.java
@@ -25,7 +25,11 @@ import org.eclipse.rse.services.clientserver.ISystemFileTypes;
 import org.eclipse.rse.subsystems.files.core.subsystems.IRemoteFile;
 
 
-
+/**
+ * Registry for associating file types with transfer modes.  
+ *
+ * @noimplement This interface is not intended to be implemented by clients.
+ */
 public interface ISystemFileTransferModeRegistry extends ISystemFileTypes
 {