8022176: Weaken contract of java.lang.AutoCloseable

Reviewed-by: alanb, martin, mduigou, psandoz
This commit is contained in:
Brian Goetz 2013-08-28 14:13:03 -07:00 committed by Henry Jen
parent 9b5513a8e8
commit f7b61b93f1

View File

@ -26,7 +26,24 @@
package java.lang;
/**
* A resource that must be closed when it is no longer needed.
* An object that may hold resources (such as file or socket handles)
* until it is closed. The {@link #close()} method of an {@code AutoCloseable}
* object is called automatically when exiting a {@code
* try}-with-resources block for which the object has been declared in
* the resource specification header. This construction ensures prompt
* release, avoiding resource exhaustion exceptions and errors that
* may otherwise occur.
*
* @apiNote
* <p>It is possible, and in fact common, for a base class to
* implement AutoCloseable even though not all of its subclasses or
* instances will hold releasable resources. For code that must operate
* in complete generality, or when it is known that the {@code AutoCloseable}
* instance requires resource release, it is recommended to use {@code
* try}-with-resources constructions. However, when using facilities such as
* {@link java.util.stream.Stream} that support both I/O-based and
* non-I/O-based forms, {@code try}-with-resources blocks are in
* general unnecessary when using non-I/O-based forms.
*
* @author Josh Bloch
* @since 1.7