[GitHub] [sling-org-apache-sling-api] cziegeler commented on a change in pull request #40: SLING-11067 extend URIProvider by method returning Optional

[GitBox <gi...@apache.org>]

cziegeler commented on a change in pull request #40:
URL: https://github.com/apache/sling-org-apache-sling-api/pull/40#discussion_r785800371



##########
File path: src/main/java/org/apache/sling/api/resource/external/ExternalizableInputStream.java
##########
@@ -22,23 +22,25 @@
 import java.net.URI;
 
 import org.jetbrains.annotations.NotNull;
+import org.osgi.annotation.versioning.ProviderType;
 
 /**
  * This interface is normally used to extend an InputStream to indicate that it has a URI form that could
  * be used in place of the InputStream if desired. It is used in situations where the internal of a ResourceProvider
- * wants to offload IO to channels that do not pass through the JVM. The URI that is returned may have restrictions
+ * wants to offload I/O to channels that do not pass through the JVM. The URI that is returned may have restrictions
  * imposed on it requiring it to be used immediately. Do not store the URI for later usage as it will, in most cases,
  * have expired.
- *
+ * Every implementation implementing {@code ExternalizableInputStream} should rely on {@link URIProviders} for getting the URI.
+ * @since 1.0.0 (Sling API Bundle 2.16.4)
  */
+@ProviderType

Review comment:
       This is a breaking change, it will break all existing bundles implementing this type




-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: dev-unsubscribe@sling.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org