[HTTPCORE-330] Clarify InputStreamEntity length constructor argument

• Type: Improvement
• Status: Closed
• Priority: Trivial
• Resolution: Fixed
• Affects Version/s: 4.2.3
• Fix Version/s: 4.3-beta1
• Component/s: Documentation, HttpCore
• Labels: documentation
• Assignee: Unassigned
• Reporter: John McCarthy
• Created: 17/Jan/13 07:37
• Updated: 10/Apr/13 16:42
• Resolved: 18/Jan/13 10:54

Description

When creating an InputStreamEntity, content length may not be known. (Also, it may be desired to create an entity that will be read until fully consumed without specifying a content length.) From what I see in the writeTo() method source, you may specify a number less than zero for the length parameter in the constructor if the length is not known. Please clarify this in the javadoc. Also, because is length is optional, perhaps corresponding constructors should be added that don't require this parameter.