Remove @noreference from InstallableUnit.isSingleton/getFilter

merks · Dec 10, 2023 · f108a32 · f108a32
1 parent cb70b67
commit f108a32
Show file tree

Hide file tree

Showing 3 changed files with 28 additions and 3 deletions.
diff --git a/bundles/org.eclipse.equinox.p2.metadata/.settings/.api_filters b/bundles/org.eclipse.equinox.p2.metadata/.settings/.api_filters
@@ -1,5 +1,26 @@
 <?xml version="1.0" encoding="UTF-8" standalone="no"?>
 <component id="org.eclipse.equinox.p2.metadata" version="2">
+    <resource path="src/org/eclipse/equinox/p2/metadata/IInstallableUnit.java" type="org.eclipse.equinox.p2.metadata.IInstallableUnit">
+        <filter comment="The getFilter has  existed forever but was marked as @noref" id="1211105284">
+            <message_arguments>
+                <message_argument value="getFilter()"/>
+            </message_arguments>
+        </filter>
+        <filter comment="The isSingleton method has existed forever but was marked @noref" id="1211105284">
+            <message_arguments>
+                <message_argument value="isSingleton()"/>
+            </message_arguments>
+        </filter>
+    </resource>
+    <resource path="src/org/eclipse/equinox/p2/metadata/IRequirement.java" type="org.eclipse.equinox.p2.metadata.IRequirement">
+        <filter comment="The getFilter method has existed forever but was marked @noreference." id="1209008130">
+            <message_arguments>
+                <message_argument value="2.0"/>
+                <message_argument value="2.9"/>
+                <message_argument value="getFilter()"/>
+            </message_arguments>
+        </filter>
+    </resource>
     <resource path="src/org/eclipse/equinox/p2/query/CompoundQueryable.java" type="org.eclipse.equinox.p2.query.CompoundQueryable">
         <filter id="576720909">
             <message_arguments>

diff --git a/...org.eclipse.equinox.p2.metadata/src/org/eclipse/equinox/p2/metadata/IInstallableUnit.java b/...org.eclipse.equinox.p2.metadata/src/org/eclipse/equinox/p2/metadata/IInstallableUnit.java
@@ -148,7 +148,6 @@ public interface IInstallableUnit extends IVersionedId, Comparable<IInstallableU
 	 * properties of the environment.
 	 * 
 	 * @return The installation filter for this unit, or <code>null</code>
-	 * @noreference This method is not intended to be referenced by clients.
 	 */
 	public IMatchExpression<IInstallableUnit> getFilter();
 
@@ -227,7 +226,6 @@ public interface IInstallableUnit extends IVersionedId, Comparable<IInstallableU
 	 * installable unit with a given id is allowed to exist in a given installed system.
 	 * Attempting to install multiple versions of a singleton will fail.
 	 * @return <code>true</code> if this unit is a singleton, and <code>false</code> otherwise
-	 * @noreference This method is not intended to be referenced by clients.
 	 */
 	public boolean isSingleton();
 

diff --git a/...les/org.eclipse.equinox.p2.metadata/src/org/eclipse/equinox/p2/metadata/IRequirement.java b/...les/org.eclipse.equinox.p2.metadata/src/org/eclipse/equinox/p2/metadata/IRequirement.java
@@ -57,7 +57,13 @@ public interface IRequirement {
 	int getMax();
 
 	/**
-	 * @noreference This method is not intended to be referenced by clients.
+	 * Returns the filter on this requirement. The filter is matched against
+	 * the properties of the environment the requirement is installed into. A requirement
+	 * not applicable, i.e., is ignored, if it has a filter condition that is not satisfied
+	 * by the properties of the environment.
+	 * 
+	 * @return The requirement filter for this unit, or <code>null</code>
+	 * 
 	 * @since 2.0
 	 */
 	IMatchExpression<IInstallableUnit> getFilter();