JDK-8216177 : Clarify the singleton description in j.t.c.JapaneseEra class
  • Type: CSR
  • Component: core-libs
  • Sub-Component: java.time
  • Priority: P2
  • Status: Closed
  • Resolution: Approved
  • Fix Versions: 12
  • Submitted: 2019-01-04
  • Updated: 2019-01-08
  • Resolved: 2019-01-08
Related Reports
CSR :  
Description
Summary
-------

Clarify the language used for the public singleton definition in JapaneseEra class.

Problem
-------

With the change to 8212941, the class is now proofed for future JapaneseEra additions without spec changes. However, it is not clear whether the "subsequent versions of this class" refers to a feature release or an update release.

Solution
--------

Make it explicit that the singleton additions are intended for future platform releases.

Specification
-------------

Change the ambiguous sentence in the class description of j.t.c.JapaneseEra as follows:

    @@ -94,7 +94,7 @@
      * dates before Meiji 6, January 1 are not supported.
      * The number of the valid eras may increase, as new eras may be
      * defined by the Japanese government. Once an era is defined,
    - * subsequent versions of this class will add a singleton instance
    + * future versions of the platform may add a singleton instance
      * for it. The defined era is expected to have a consecutive integer
      * associated with it.
      *
Comments
Moving to Approved.
08-01-2019