JDK-4619632 : ZipFile.OPEN_DELETE and similar should be marked @since 1.3
  • Type: Bug
  • Component: docs
  • Sub-Component: guides
  • Affected Version: 1.4.0
  • Priority: P4
  • Status: Closed
  • Resolution: Duplicate
  • OS: generic
  • CPU: generic
  • Submitted: 2002-01-04
  • Updated: 2002-02-25
  • Resolved: 2002-02-25
Related Reports
Duplicate :  
Description

Name: rmT116609			Date: 01/04/2002


FULL PRODUCT VERSION :
java version "1.4.0-beta3"
Java(TM) 2 Runtime Environment, Standard Edition (build 1.4.0-beta3-b84)
Java HotSpot(TM) Client VM (build 1.4.0-beta3-b84, mixed mode)

 DESCRIPTION OF THE PROBLEM :

There are some new publically accessible members in java.util.zip.ZipFile as of JDK 1.3. For
example, OPEN_DELETE was added. Yet the java doc does not mention that these were 
added later. The tag

@since 1.3 should be added. 

Compare:

http://java.sun.com/products/jdk/1.2/docs/api/java/util/zip/ZipFile.html
http://java.sun.com/j2se/1.3/docs/api/java/util/zip/ZipFile.html#OPEN_DELETE
http://java.sun.com/j2se/1.4/docs/api/java/util/zip/ZipFile.html#OPEN_DELETE

OPEN_READ is similar. I think other constants were there in 1.2.2. Also the constructor:

http://java.sun.com/j2se/1.3/docs/api/java/util/zip/ZipFile.html#ZipFile(java.io.File, int)

A developer looking at 1.3/1.4 Javadoc and writing an app accordingly might not realize 
that it would not work correctly on 1.2.2. In fact this almost happened to me.

This bug can be reproduced always.
(Review ID: 137647) 
======================================================================

Comments
EVALUATION This is part of a larger problem. We need to devise a way to add @since tags to all members that were added in a given release. ###@###.### 2002-02-25
25-02-2002