[IO-380] FileUtils.copyInputStreamToFile should document it closes the input source

• Type: Improvement
• Status: Closed
• Priority: Trivial
• Resolution: Fixed
• Affects Version/s: 2.4
• Fix Version/s: 2.5

Environment

JDK 7, OSX 10.8.3 (doesn't matter)

• Assignee: Unassigned
• Reporter: Claudio Nieder
• Created: 08/May/13 13:57
• Updated: 08/Nov/16 17:58
• Resolved: 08/May/13 14:28

Description

It would be nice to extend the parameter description

@param source the <code>InputStream</code> to copy bytes from, must not be

{@code null}

to read:

@param source the <code>InputStream</code> to copy bytes from, must not be {@code null}

, will be closed

so that one is aware it cannot be used e.g. on ZipInputStream which require the stream to still be open for executing zip.getNextEntry.

Issue Links

• is related to: IO-381 Add FileUtils.copyInputStreamToFile API with option to leave the source open
• relates to: IO-381 Add FileUtils.copyInputStreamToFile API with option to leave the source open