Author: fmeschbe
Date: Mon Sep 9 13:22:26 2013
New Revision: 1521093
URL: http://svn.apache.org/r1521093
Log:
Clarify API: getInputStream() returns a new stream on each invocation
Modified:
sling/trunk/bundles/api/src/main/java/org/apache/sling/api/request/RequestParameter.java
Modified:
sling/trunk/bundles/api/src/main/java/org/apache/sling/api/request/RequestParameter.java
URL:
http://svn.apache.org/viewvc/sling/trunk/bundles/api/src/main/java/org/apache/sling/api/request/RequestParameter.java?rev=1521093&r1=1521092&r2=1521093&view=diff
==============================================================================
---
sling/trunk/bundles/api/src/main/java/org/apache/sling/api/request/RequestParameter.java
(original)
+++
sling/trunk/bundles/api/src/main/java/org/apache/sling/api/request/RequestParameter.java
Mon Sep 9 13:22:26 2013
@@ -73,6 +73,10 @@ public interface RequestParameter {
/**
* Returns an InputStream that can be used to retrieve the contents of the
* file.
+ * <p>
+ * Each call to this method returns a new {@code InputStream} to the
+ * request parameter data. Make sure to close the stream to prevent
+ * leaking resources.
*
* @return An InputStream that can be used to retrieve the contents of the
* file.
