Uploaded image for project: 'JDK'
  1. JDK
  2. JDK-8322044

@param/@return descriptions of ZoneRules#isDaylightSavings() are incorrect

XMLWordPrintable

    • Icon: CSR CSR
    • Resolution: Approved
    • Icon: P4 P4
    • 22, 23
    • core-libs
    • None
    • behavioral
    • minimal
    • This is a doc-only change.
    • Java API
    • SE

      Summary

      Correction to the @param/@return descriptions of java.time.zone.ZoneRules#isDaylightSavings().

      Problem

      The description of the argument and the return value of ZoneRules#isDaylightSavings() are incorrect. Looks like merely copied from getStandardOffset().

      Solution

      Correct those descriptions for daylight savings.

      Specification

      Change the @param and @return descriptions of the ZoneRules#isDaylightSavings(Instant) method as follows:

      -     * @param instant  the instant to find the offset information for, not null, but null
      +     * @param instant  the instant to check the daylight savings for, not null, but null
            *  may be ignored if the rules have a single offset for all instants
      -     * @return the standard offset, not null
      +     * @return true if the specified instant is in daylight savings, false otherwise.
            */

            naoto Naoto Sato
            webbuggrp Webbug Group
            Jaikiran Pai, Joe Wang, Roger Riggs
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

              Created:
              Updated:
              Resolved: