Skip to content

HTTPCORE-656: Improve HttpEntity.getContent() documentation #238

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ok2c merged 2 commits into from
Dec 23, 2020
Merged

HTTPCORE-656: Improve HttpEntity.getContent() documentation #238

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
154ccc8
HTTPCORE-656: Improve HttpEntity.getContent() documentation
Marcono1234 Dec 23, 2020
efd4c99
fixup! HTTPCORE-656: Improve HttpEntity.getContent() documentation
Marcono1234 Dec 23, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions httpcore5/src/main/java/org/apache/hc/core5/http/HttpEntity.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,15 @@ public interface HttpEntity extends EntityDetails, Closeable {
* to return the same {@link InputStream} instance and therefore
* may not be consumed more than once.
* <p>
* If this entity belongs to an incoming HTTP message, calling
* {@link InputStream#close()} on the returned {@code InputStream} will
* try to consume the complete entity content to keep the connection
* alive. In cases where this is undesired, e.g. when only a small part
* of the content is relevant and consuming the complete entity content
* would be too inefficient, <i>only</i> the HTTP message from which
* this entity was obtained should be closed (if supported).
* </p>
* <p>
* IMPORTANT: Please note all entity implementations must ensure that
* all allocated resources are properly deallocated after
* the {@link InputStream#close()} method is invoked.
Expand Down