Interface Releasable
For example, the creation of a ResettableInputStream
would entail physically opening a file. If the opened file is
meant to be closed only (in a finally block) by the very same code block that created it, then it is necessary that the release
method must not be called while the execution is made in other stack frames.
In such case, as other stack frames may inadvertently or indirectly call the close method of the stream, the creator of the
stream would need to explicitly disable the accidental closing via ResettableInputStream#disableClose()
, so that the
release method becomes the only way to truly close the opened file.
-
Method Summary
Modifier and TypeMethodDescriptionvoid
release()
Releases the allocated resource.static void
Releases the givenCloseable
especially if it was an instance ofReleasable
.
-
Method Details
-
release
Releases the givenCloseable
especially if it was an instance ofReleasable
.For example, the creation of a
ResettableInputStream
would entail physically opening a file. If the opened file is meant to be closed only (in a finally block) by the very same code block that created it, then it is necessary that the release method must not be called while the execution is made in other stack frames.In such case, as other stack frames may inadvertently or indirectly call the close method of the stream, the creator of the stream would need to explicitly disable the accidental closing via
ResettableInputStream#disableClose()
, so that the release method becomes the only way to truly close the opened file. -
release
void release()Releases the allocated resource. This method should not be called except by the caller who allocated the resource at the very top of the call stack. This allows, typically, aCloseable
resource to be not unintentionally released owing to the calling of theCloseable.close()
methods by implementation deep down in the call stack.For example, the creation of a
ResettableInputStream
would entail physically opening a file. If the opened file is meant to be closed only (in a finally block) by the very same code block that created it, then it is necessary that the release method must not be called while the execution is made in other stack frames.In such case, as other stack frames may inadvertently or indirectly call the close method of the stream, the creator of the stream would need to explicitly disable the accidental closing via
ResettableInputStream#disableClose()
, so that the release method becomes the only way to truly close the opened file.
-