Add Javadoc regarding closing body stream

omaric · kullfar · commit 3ec1be264e5a · 2019-08-19T12:01:42.000+03:00
diff --git a/scribejava-core/src/main/java/com/github/scribejava/core/model/Response.java b/scribejava-core/src/main/java/com/github/scribejava/core/model/Response.java
@@ -5,6 +5,12 @@
 import java.util.Map;
 import com.github.scribejava.core.utils.StreamUtils;
 
+/**
+ * An HTTP response.
+ *
+ * <p>This response may contain a non-null body stream of the HttpUrlConnection. If so, this body must be closed to
+ * avoid leaking resources. Use either {@code getBody()} or {@code getStream().close()} to close the body.
+ */
 public class Response {
 
     private final int code;
@@ -45,6 +51,9 @@ public boolean isSuccessful() {
         return code >= 200 && code < 400;
     }
 
+    /**
+     * Returns the response body as a string, closing the stream that backs it. Idempotent.
+     */
     public String getBody() throws IOException {
         return body == null ? parseBodyContents() : body;
     }
