RFR: 8336843: Deprecate java.util.zip.ZipError for removal [v2]

Eirik Bjørsnøs eirbjo at openjdk.org
Tue Aug 27 19:52:04 UTC 2024


On Tue, 27 Aug 2024 17:24:42 GMT, Lance Andersen <lancea at openjdk.org> wrote:

> The javadoc should be focused on the current JDK release, not the prior history of this Class

Makes sense, let's focus on the current release.

> ```
>  * @deprecated ZipError is deprecated and subject to removal in a
>  *  future release. This class is obsolete. Use  {@link ZipException} instead.
> ```

The leading sentence here seems redundant, since it mostly just repeats the heading generated by javadoc:

**Deprecated, for removal: This API element is subject to removal in a future version**
_ZipError is deprecated and subject to removal in a future release. This Error is obsolete and no longer thrown. Use ZipException instead._

What do you think of dropping that first sentence, such that the rendered result would be:

**Deprecated, for removal: This API element is subject to removal in a future version**
_ZipError is obsolete and is no longer thrown. Use ZipException instead._

(One might argue that *is no longer thrown* hints at different behavior in past releases, but I still think it helps to clarify that code running on the current release need not worry about catching this error)

-------------

PR Review Comment: https://git.openjdk.org/jdk/pull/20642#discussion_r1733433176


More information about the core-libs-dev mailing list