IOUtils.close needs better documentation

• Key: HADOOP-3535
• Type: Improvement
• Status: Closed
• Resolution: Fixed
• Priority: Blocker
• Assignee: Owen O'Malley
• Reporter: Owen O'Malley
• Component/s: io
• Fix Version/s: 0.18.0

Description

The JavaDoc for IOUtils.close is incorrect and misleading.

Comments

[Owen O'Malley]

This fixes the JavaDoc to make it clear that it should only be used for cleanup and renames the method.

[Tsz Wo (Nicholas), SZE]

<b>ignore<b> should be <b>ignore</b>

otherwise, patch looks good.

[Hadoop QA]

-1 overall. Here are the results of testing the latest attachment
http://issues.apache.org/jira/secure/attachment/12383872/cleanup.patch
against trunk revision 666620.

+1 @author. The patch does not contain any @author tags.

-1 tests included. The patch doesn't appear to include any new or modified tests.
Please justify why no tests are needed for this patch.

+1 javadoc. The javadoc tool did not generate any warning messages.

+1 javac. The applied patch does not increase the total number of javac compiler warnings.

+1 findbugs. The patch does not introduce any new Findbugs warnings.

+1 release audit. The applied patch does not increase the total number of release audit warnings.

+1 core tests. The patch passed core unit tests.

+1 contrib tests. The patch passed contrib unit tests.

Test results: http://hudson.zones.apache.org/hudson/job/Hadoop-Patch/2641/testReport/
Findbugs warnings: http://hudson.zones.apache.org/hudson/job/Hadoop-Patch/2641/artifact/trunk/build/test/findbugs/newPatchFindbugsWarnings.html
Checkstyle results: http://hudson.zones.apache.org/hudson/job/Hadoop-Patch/2641/artifact/trunk/build/test/checkstyle-errors.html
Console output: http://hudson.zones.apache.org/hudson/job/Hadoop-Patch/2641/console

This message is automatically generated.

[Mukund Madhugiri]

Marking a blocker for 0.18.0

[Owen O'Malley]

I just committed this.

[Hudson]

Integrated in Hadoop-trunk #522 (See http://hudson.zones.apache.org/hudson/job/Hadoop-trunk/522/)