Move the guidance to subclasses to the end() method

jaikiran · Jan 14, 2025 · 45bad0e · 45bad0e
1 parent 1cd16c4
commit 45bad0e
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 4 deletions.
diff --git a/src/java.base/share/classes/java/util/zip/Deflater.java b/src/java.base/share/classes/java/util/zip/Deflater.java
@@ -60,8 +60,7 @@
  * @apiNote
  * This class implements {@link AutoCloseable} to facilitate its usage with
  * {@code try}-with-resources statement. The {@linkplain Deflater#close() close() method} simply
- * calls {@code end()}. Subclasses should override {@linkplain #end()} to clean up the
- * resources acquired by the subclass.
+ * calls {@code end()}.
  *
  * <p>
  * The following code fragment demonstrates a trivial compression
@@ -889,6 +888,9 @@ public void reset() {
      * <p>
      * If the {@code Deflater} is already closed then invoking this method has no effect.
      *
+     * @implSpec Subclasses should override this method to clean up the resources
+     * acquired by the subclass.
+     *
      * @see #close()
      */
     public void end() {

diff --git a/src/java.base/share/classes/java/util/zip/Inflater.java b/src/java.base/share/classes/java/util/zip/Inflater.java
@@ -59,8 +59,7 @@
  * @apiNote
  * This class implements {@link AutoCloseable} to facilitate its usage with
  * {@code try}-with-resources statement. The {@linkplain Inflater#close() close() method} simply
- * calls {@code end()}. Subclasses should override {@linkplain #end()} to clean up the
- * resources acquired by the subclass.
+ * calls {@code end()}.
  *
  * <p>
  * The following code fragment demonstrates a trivial compression
@@ -703,6 +702,9 @@ public void reset() {
      * <p>
      * If the {@code Inflater} is already closed then invoking this method has no effect.
      *
+     * @implSpec Subclasses should override this method to clean up the resources
+     * acquired by the subclass.
+     *
      * @see #close()
      */
     public void end() {