From 930a4614e6bc8ecdc04a8da28a2bb30f8a0ef1be Mon Sep 17 00:00:00 2001 From: Roger Riggs Date: Fri, 31 Jan 2014 13:42:31 -0500 Subject: [PATCH] 8032221: Typo in java.util.date Trancate -> truncate; updated html and to use {@code ...} Reviewed-by: darcy, lancea --- jdk/src/share/classes/java/util/Date.java | 343 +++++++++++----------- 1 file changed, 170 insertions(+), 173 deletions(-) diff --git a/jdk/src/share/classes/java/util/Date.java b/jdk/src/share/classes/java/util/Date.java index 502daaefdbb..f16ea496604 100644 --- a/jdk/src/share/classes/java/util/Date.java +++ b/jdk/src/share/classes/java/util/Date.java @@ -41,20 +41,20 @@ import sun.util.calendar.Gregorian; import sun.util.calendar.ZoneInfo; /** - * The class Date represents a specific instant + * The class {@code Date} represents a specific instant * in time, with millisecond precision. *

- * Prior to JDK 1.1, the class Date had two additional + * Prior to JDK 1.1, the class {@code Date} had two additional * functions. It allowed the interpretation of dates as year, month, day, hour, * minute, and second values. It also allowed the formatting and parsing * of date strings. Unfortunately, the API for these functions was not * amenable to internationalization. As of JDK 1.1, the - * Calendar class should be used to convert between dates and time - * fields and the DateFormat class should be used to format and + * {@code Calendar} class should be used to convert between dates and time + * fields and the {@code DateFormat} class should be used to format and * parse date strings. - * The corresponding methods in Date are deprecated. + * The corresponding methods in {@code Date} are deprecated. *

- * Although the Date class is intended to reflect + * Although the {@code Date} class is intended to reflect * coordinated universal time (UTC), it may not do so exactly, * depending on the host environment of the Java Virtual Machine. * Nearly all modern operating systems assume that 1 day = @@ -93,12 +93,12 @@ import sun.util.calendar.ZoneInfo; * http://tycho.usno.navy.mil/systime.html * *

- * In all methods of class Date that accept or return + * In all methods of class {@code Date} that accept or return * year, month, date, hours, minutes, and seconds values, the * following representations are used: *

    *
  • A year y is represented by the integer - * y - 1900. + * y {@code - 1900}. *
  • A month is represented by an integer from 0 to 11; 0 is January, * 1 is February, and so forth; thus 11 is December. *
  • A date (day of month) is represented by an integer from 1 to 31 @@ -155,7 +155,7 @@ public class Date private static final long serialVersionUID = 7523967970034938905L; /** - * Allocates a Date object and initializes it so that + * Allocates a {@code Date} object and initializes it so that * it represents the time at which it was allocated, measured to the * nearest millisecond. * @@ -166,7 +166,7 @@ public class Date } /** - * Allocates a Date object and initializes it to + * Allocates a {@code Date} object and initializes it to * represent the specified number of milliseconds since the * standard base time known as "the epoch", namely January 1, * 1970, 00:00:00 GMT. @@ -179,18 +179,18 @@ public class Date } /** - * Allocates a Date object and initializes it so that + * Allocates a {@code Date} object and initializes it so that * it represents midnight, local time, at the beginning of the day - * specified by the year, month, and - * date arguments. + * specified by the {@code year}, {@code month}, and + * {@code date} arguments. * * @param year the year minus 1900. * @param month the month between 0-11. * @param date the day of the month between 1-31. * @see java.util.Calendar * @deprecated As of JDK version 1.1, - * replaced by Calendar.set(year + 1900, month, date) - * or GregorianCalendar(year + 1900, month, date). + * replaced by {@code Calendar.set(year + 1900, month, date)} + * or {@code GregorianCalendar(year + 1900, month, date)}. */ @Deprecated public Date(int year, int month, int date) { @@ -198,10 +198,10 @@ public class Date } /** - * Allocates a Date object and initializes it so that + * Allocates a {@code Date} object and initializes it so that * it represents the instant at the start of the minute specified by - * the year, month, date, - * hrs, and min arguments, in the local + * the {@code year}, {@code month}, {@code date}, + * {@code hrs}, and {@code min} arguments, in the local * time zone. * * @param year the year minus 1900. @@ -211,9 +211,8 @@ public class Date * @param min the minutes between 0-59. * @see java.util.Calendar * @deprecated As of JDK version 1.1, - * replaced by Calendar.set(year + 1900, month, date, - * hrs, min) or GregorianCalendar(year + 1900, - * month, date, hrs, min). + * replaced by {@code Calendar.set(year + 1900, month, date, hrs, min)} + * or {@code GregorianCalendar(year + 1900, month, date, hrs, min)}. */ @Deprecated public Date(int year, int month, int date, int hrs, int min) { @@ -221,10 +220,10 @@ public class Date } /** - * Allocates a Date object and initializes it so that + * Allocates a {@code Date} object and initializes it so that * it represents the instant at the start of the second specified - * by the year, month, date, - * hrs, min, and sec arguments, + * by the {@code year}, {@code month}, {@code date}, + * {@code hrs}, {@code min}, and {@code sec} arguments, * in the local time zone. * * @param year the year minus 1900. @@ -235,9 +234,8 @@ public class Date * @param sec the seconds between 0-59. * @see java.util.Calendar * @deprecated As of JDK version 1.1, - * replaced by Calendar.set(year + 1900, month, date, - * hrs, min, sec) or GregorianCalendar(year + 1900, - * month, date, hrs, min, sec). + * replaced by {@code Calendar.set(year + 1900, month, date, hrs, min, sec)} + * or {@code GregorianCalendar(year + 1900, month, date, hrs, min, sec)}. */ @Deprecated public Date(int year, int month, int date, int hrs, int min, int sec) { @@ -258,16 +256,16 @@ public class Date } /** - * Allocates a Date object and initializes it so that + * Allocates a {@code Date} object and initializes it so that * it represents the date and time indicated by the string - * s, which is interpreted as if by the + * {@code s}, which is interpreted as if by the * {@link Date#parse} method. * * @param s a string representation of the date. * @see java.text.DateFormat * @see java.util.Date#parse(java.lang.String) * @deprecated As of JDK version 1.1, - * replaced by DateFormat.parse(String s). + * replaced by {@code DateFormat.parse(String s)}. */ @Deprecated public Date(String s) { @@ -292,7 +290,7 @@ public class Date * Determines the date and time based on the arguments. The * arguments are interpreted as a year, month, day of the month, * hour of the day, minute within the hour, and second within the - * minute, exactly as for the Date constructor with six + * minute, exactly as for the {@code Date} constructor with six * arguments, except that the arguments are interpreted relative * to UTC rather than to the local time zone. The time indicated is * returned represented as the distance, measured in milliseconds, @@ -308,10 +306,9 @@ public class Date * the date and time specified by the arguments. * @see java.util.Calendar * @deprecated As of JDK version 1.1, - * replaced by Calendar.set(year + 1900, month, date, - * hrs, min, sec) or GregorianCalendar(year + 1900, - * month, date, hrs, min, sec), using a UTC - * TimeZone, followed by Calendar.getTime().getTime(). + * replaced by {@code Calendar.set(year + 1900, month, date, hrs, min, sec)} + * or {@code GregorianCalendar(year + 1900, month, date, hrs, min, sec)}, using a UTC + * {@code TimeZone}, followed by {@code Calendar.getTime().getTime()}. */ @Deprecated public static long UTC(int year, int month, int date, @@ -338,12 +335,12 @@ public class Date } /** - * Attempts to interpret the string s as a representation + * Attempts to interpret the string {@code s} as a representation * of a date and time. If the attempt is successful, the time * indicated is returned represented as the distance, measured in * milliseconds, of that time from the epoch (00:00:00 GMT on * January 1, 1970). If the attempt fails, an - * IllegalArgumentException is thrown. + * {@code IllegalArgumentException} is thrown. *

    * It accepts many syntaxes; in particular, it recognizes the IETF * standard date syntax: "Sat, 12 Aug 1995 13:30:00 GMT". It also @@ -353,11 +350,11 @@ public class Date * meridian). If no time zone is specified, the local time zone is * assumed. GMT and UTC are considered equivalent. *

    - * The string s is processed from left to right, looking for - * data of interest. Any material in s that is within the - * ASCII parenthesis characters ( and ) is ignored. + * The string {@code s} is processed from left to right, looking for + * data of interest. Any material in {@code s} that is within the + * ASCII parenthesis characters {@code (} and {@code )} is ignored. * Parentheses may be nested. Otherwise, the only characters permitted - * within s are these ASCII characters: + * within {@code s} are these ASCII characters: *

          * abcdefghijklmnopqrstuvwxyz
          * ABCDEFGHIJKLMNOPQRSTUVWXYZ
    @@ -365,18 +362,18 @@ public class Date
          * and whitespace characters.

    * A consecutive sequence of decimal digits is treated as a decimal * number:

      - *
    • If a number is preceded by + or - and a year + *
    • If a number is preceded by {@code +} or {@code -} and a year * has already been recognized, then the number is a time-zone * offset. If the number is less than 24, it is an offset measured * in hours. Otherwise, it is regarded as an offset in minutes, * expressed in 24-hour time format without punctuation. A - * preceding - means a westward offset. Time zone offsets + * preceding {@code -} means a westward offset. Time zone offsets * are always relative to UTC (Greenwich). Thus, for example, - * -5 occurring in the string would mean "five hours west - * of Greenwich" and +0430 would mean "four hours and + * {@code -5} occurring in the string would mean "five hours west + * of Greenwich" and {@code +0430} would mean "four hours and * thirty minutes east of Greenwich." It is permitted for the - * string to specify GMT, UT, or UTC - * redundantly-for example, GMT-5 or utc+0430. + * string to specify {@code GMT}, {@code UT}, or {@code UTC} + * redundantly-for example, {@code GMT-5} or {@code utc+0430}. *
    • The number is regarded as a year number if one of the * following conditions is true: *
        @@ -399,8 +396,8 @@ public class Date * unless an hour has already been recognized, in which case it is * regarded as a minute. *
      • If the number is followed by a slash, it is regarded as a month - * (it is decreased by 1 to produce a number in the range 0 - * to 11), unless a month has already been recognized, in + * (it is decreased by 1 to produce a number in the range {@code 0} + * to {@code 11}), unless a month has already been recognized, in * which case it is regarded as a day of the month. *
      • If the number is followed by whitespace, a comma, a hyphen, or * end of string, then if an hour has been recognized but not a @@ -409,31 +406,31 @@ public class Date * otherwise, it is regarded as a day of the month.

      * A consecutive sequence of letters is regarded as a word and treated * as follows:

        - *
      • A word that matches AM, ignoring case, is ignored (but + *
      • A word that matches {@code AM}, ignoring case, is ignored (but * the parse fails if an hour has not been recognized or is less - * than 1 or greater than 12). - *
      • A word that matches PM, ignoring case, adds 12 + * than {@code 1} or greater than {@code 12}). + *
      • A word that matches {@code PM}, ignoring case, adds {@code 12} * to the hour (but the parse fails if an hour has not been - * recognized or is less than 1 or greater than 12). - *
      • Any word that matches any prefix of SUNDAY, MONDAY, TUESDAY, - * WEDNESDAY, THURSDAY, FRIDAY, or SATURDAY, ignoring - * case, is ignored. For example, sat, Friday, TUE, and - * Thurs are ignored. - *
      • Otherwise, any word that matches any prefix of JANUARY, + * recognized or is less than {@code 1} or greater than {@code 12}). + *
      • Any word that matches any prefix of {@code SUNDAY, MONDAY, TUESDAY, + * WEDNESDAY, THURSDAY, FRIDAY}, or {@code SATURDAY}, ignoring + * case, is ignored. For example, {@code sat, Friday, TUE}, and + * {@code Thurs} are ignored. + *
      • Otherwise, any word that matches any prefix of {@code JANUARY, * FEBRUARY, MARCH, APRIL, MAY, JUNE, JULY, AUGUST, SEPTEMBER, - * OCTOBER, NOVEMBER, or DECEMBER, ignoring case, and + * OCTOBER, NOVEMBER}, or {@code DECEMBER}, ignoring case, and * considering them in the order given here, is recognized as - * specifying a month and is converted to a number (0 to - * 11). For example, aug, Sept, april, and - * NOV are recognized as months. So is Ma, which - * is recognized as MARCH, not MAY. - *
      • Any word that matches GMT, UT, or UTC, ignoring + * specifying a month and is converted to a number ({@code 0} to + * {@code 11}). For example, {@code aug, Sept, april}, and + * {@code NOV} are recognized as months. So is {@code Ma}, which + * is recognized as {@code MARCH}, not {@code MAY}. + *
      • Any word that matches {@code GMT, UT}, or {@code UTC}, ignoring * case, is treated as referring to UTC. - *
      • Any word that matches EST, CST, MST, or PST, + *
      • Any word that matches {@code EST, CST, MST}, or {@code PST}, * ignoring case, is recognized as referring to the time zone in * North America that is five, six, seven, or eight hours west of - * Greenwich, respectively. Any word that matches EDT, CDT, - * MDT, or PDT, ignoring case, is recognized as + * Greenwich, respectively. Any word that matches {@code EDT, CDT, + * MDT}, or {@code PDT}, ignoring case, is recognized as * referring to the same time zone, respectively, during daylight * saving time.

      * Once the entire string s has been scanned, it is converted to a time @@ -448,7 +445,7 @@ public class Date * represented by the string argument. * @see java.text.DateFormat * @deprecated As of JDK version 1.1, - * replaced by DateFormat.parse(String s). + * replaced by {@code DateFormat.parse(String s)}. */ @Deprecated public static long parse(String s) { @@ -638,13 +635,13 @@ public class Date /** * Returns a value that is the result of subtracting 1900 from the * year that contains or begins with the instant in time represented - * by this Date object, as interpreted in the local + * by this {@code Date} object, as interpreted in the local * time zone. * * @return the year represented by this date, minus 1900. * @see java.util.Calendar * @deprecated As of JDK version 1.1, - * replaced by Calendar.get(Calendar.YEAR) - 1900. + * replaced by {@code Calendar.get(Calendar.YEAR) - 1900}. */ @Deprecated public int getYear() { @@ -652,8 +649,8 @@ public class Date } /** - * Sets the year of this Date object to be the specified - * value plus 1900. This Date object is modified so + * Sets the year of this {@code Date} object to be the specified + * value plus 1900. This {@code Date} object is modified so * that it represents a point in time within the specified year, * with the month, date, hour, minute, and second the same as * before, as interpreted in the local time zone. (Of course, if @@ -664,7 +661,7 @@ public class Date * @param year the year value. * @see java.util.Calendar * @deprecated As of JDK version 1.1, - * replaced by Calendar.set(Calendar.YEAR, year + 1900). + * replaced by {@code Calendar.set(Calendar.YEAR, year + 1900)}. */ @Deprecated public void setYear(int year) { @@ -673,14 +670,14 @@ public class Date /** * Returns a number representing the month that contains or begins - * with the instant in time represented by this Date object. - * The value returned is between 0 and 11, - * with the value 0 representing January. + * with the instant in time represented by this {@code Date} object. + * The value returned is between {@code 0} and {@code 11}, + * with the value {@code 0} representing January. * * @return the month represented by this date. * @see java.util.Calendar * @deprecated As of JDK version 1.1, - * replaced by Calendar.get(Calendar.MONTH). + * replaced by {@code Calendar.get(Calendar.MONTH)}. */ @Deprecated public int getMonth() { @@ -689,7 +686,7 @@ public class Date /** * Sets the month of this date to the specified value. This - * Date object is modified so that it represents a point + * {@code Date} object is modified so that it represents a point * in time within the specified month, with the year, date, hour, * minute, and second the same as before, as interpreted in the * local time zone. If the date was October 31, for example, and @@ -699,7 +696,7 @@ public class Date * @param month the month value between 0-11. * @see java.util.Calendar * @deprecated As of JDK version 1.1, - * replaced by Calendar.set(Calendar.MONTH, int month). + * replaced by {@code Calendar.set(Calendar.MONTH, int month)}. */ @Deprecated public void setMonth(int month) { @@ -719,16 +716,16 @@ public class Date } /** - * Returns the day of the month represented by this Date object. - * The value returned is between 1 and 31 + * Returns the day of the month represented by this {@code Date} object. + * The value returned is between {@code 1} and {@code 31} * representing the day of the month that contains or begins with the - * instant in time represented by this Date object, as + * instant in time represented by this {@code Date} object, as * interpreted in the local time zone. * * @return the day of the month represented by this date. * @see java.util.Calendar * @deprecated As of JDK version 1.1, - * replaced by Calendar.get(Calendar.DAY_OF_MONTH). + * replaced by {@code Calendar.get(Calendar.DAY_OF_MONTH)}. * @deprecated */ @Deprecated @@ -737,8 +734,8 @@ public class Date } /** - * Sets the day of the month of this Date object to the - * specified value. This Date object is modified so that + * Sets the day of the month of this {@code Date} object to the + * specified value. This {@code Date} object is modified so that * it represents a point in time within the specified day of the * month, with the year, month, hour, minute, and second the same * as before, as interpreted in the local time zone. If the date @@ -749,7 +746,7 @@ public class Date * @param date the day of the month value between 1-31. * @see java.util.Calendar * @deprecated As of JDK version 1.1, - * replaced by Calendar.set(Calendar.DAY_OF_MONTH, int date). + * replaced by {@code Calendar.set(Calendar.DAY_OF_MONTH, int date)}. */ @Deprecated public void setDate(int date) { @@ -758,17 +755,17 @@ public class Date /** * Returns the day of the week represented by this date. The - * returned value (0 = Sunday, 1 = Monday, - * 2 = Tuesday, 3 = Wednesday, 4 = - * Thursday, 5 = Friday, 6 = Saturday) + * returned value ({@code 0} = Sunday, {@code 1} = Monday, + * {@code 2} = Tuesday, {@code 3} = Wednesday, {@code 4} = + * Thursday, {@code 5} = Friday, {@code 6} = Saturday) * represents the day of the week that contains or begins with - * the instant in time represented by this Date object, + * the instant in time represented by this {@code Date} object, * as interpreted in the local time zone. * * @return the day of the week represented by this date. * @see java.util.Calendar * @deprecated As of JDK version 1.1, - * replaced by Calendar.get(Calendar.DAY_OF_WEEK). + * replaced by {@code Calendar.get(Calendar.DAY_OF_WEEK)}. */ @Deprecated public int getDay() { @@ -776,16 +773,16 @@ public class Date } /** - * Returns the hour represented by this Date object. The - * returned value is a number (0 through 23) + * Returns the hour represented by this {@code Date} object. The + * returned value is a number ({@code 0} through {@code 23}) * representing the hour within the day that contains or begins - * with the instant in time represented by this Date + * with the instant in time represented by this {@code Date} * object, as interpreted in the local time zone. * * @return the hour represented by this date. * @see java.util.Calendar * @deprecated As of JDK version 1.1, - * replaced by Calendar.get(Calendar.HOUR_OF_DAY). + * replaced by {@code Calendar.get(Calendar.HOUR_OF_DAY)}. */ @Deprecated public int getHours() { @@ -793,8 +790,8 @@ public class Date } /** - * Sets the hour of this Date object to the specified value. - * This Date object is modified so that it represents a point + * Sets the hour of this {@code Date} object to the specified value. + * This {@code Date} object is modified so that it represents a point * in time within the specified hour of the day, with the year, month, * date, minute, and second the same as before, as interpreted in the * local time zone. @@ -802,7 +799,7 @@ public class Date * @param hours the hour value. * @see java.util.Calendar * @deprecated As of JDK version 1.1, - * replaced by Calendar.set(Calendar.HOUR_OF_DAY, int hours). + * replaced by {@code Calendar.set(Calendar.HOUR_OF_DAY, int hours)}. */ @Deprecated public void setHours(int hours) { @@ -812,12 +809,12 @@ public class Date /** * Returns the number of minutes past the hour represented by this date, * as interpreted in the local time zone. - * The value returned is between 0 and 59. + * The value returned is between {@code 0} and {@code 59}. * * @return the number of minutes past the hour represented by this date. * @see java.util.Calendar * @deprecated As of JDK version 1.1, - * replaced by Calendar.get(Calendar.MINUTE). + * replaced by {@code Calendar.get(Calendar.MINUTE)}. */ @Deprecated public int getMinutes() { @@ -825,8 +822,8 @@ public class Date } /** - * Sets the minutes of this Date object to the specified value. - * This Date object is modified so that it represents a point + * Sets the minutes of this {@code Date} object to the specified value. + * This {@code Date} object is modified so that it represents a point * in time within the specified minute of the hour, with the year, month, * date, hour, and second the same as before, as interpreted in the * local time zone. @@ -834,7 +831,7 @@ public class Date * @param minutes the value of the minutes. * @see java.util.Calendar * @deprecated As of JDK version 1.1, - * replaced by Calendar.set(Calendar.MINUTE, int minutes). + * replaced by {@code Calendar.set(Calendar.MINUTE, int minutes)}. */ @Deprecated public void setMinutes(int minutes) { @@ -843,14 +840,14 @@ public class Date /** * Returns the number of seconds past the minute represented by this date. - * The value returned is between 0 and 61. The - * values 60 and 61 can only occur on those + * The value returned is between {@code 0} and {@code 61}. The + * values {@code 60} and {@code 61} can only occur on those * Java Virtual Machines that take leap seconds into account. * * @return the number of seconds past the minute represented by this date. * @see java.util.Calendar * @deprecated As of JDK version 1.1, - * replaced by Calendar.get(Calendar.SECOND). + * replaced by {@code Calendar.get(Calendar.SECOND)}. */ @Deprecated public int getSeconds() { @@ -858,8 +855,8 @@ public class Date } /** - * Sets the seconds of this Date to the specified value. - * This Date object is modified so that it represents a + * Sets the seconds of this {@code Date} to the specified value. + * This {@code Date} object is modified so that it represents a * point in time within the specified second of the minute, with * the year, month, date, hour, and minute the same as before, as * interpreted in the local time zone. @@ -867,7 +864,7 @@ public class Date * @param seconds the seconds value. * @see java.util.Calendar * @deprecated As of JDK version 1.1, - * replaced by Calendar.set(Calendar.SECOND, int seconds). + * replaced by {@code Calendar.set(Calendar.SECOND, int seconds)}. */ @Deprecated public void setSeconds(int seconds) { @@ -876,7 +873,7 @@ public class Date /** * Returns the number of milliseconds since January 1, 1970, 00:00:00 GMT - * represented by this Date object. + * represented by this {@code Date} object. * * @return the number of milliseconds since January 1, 1970, 00:00:00 GMT * represented by this date. @@ -893,8 +890,8 @@ public class Date } /** - * Sets this Date object to represent a point in time that is - * time milliseconds after January 1, 1970 00:00:00 GMT. + * Sets this {@code Date} object to represent a point in time that is + * {@code time} milliseconds after January 1, 1970 00:00:00 GMT. * * @param time the number of milliseconds. */ @@ -907,11 +904,11 @@ public class Date * Tests if this date is before the specified date. * * @param when a date. - * @return true if and only if the instant of time - * represented by this Date object is strictly - * earlier than the instant represented by when; - * false otherwise. - * @exception NullPointerException if when is null. + * @return {@code true} if and only if the instant of time + * represented by this {@code Date} object is strictly + * earlier than the instant represented by {@code when}; + * {@code false} otherwise. + * @exception NullPointerException if {@code when} is null. */ public boolean before(Date when) { return getMillisOf(this) < getMillisOf(when); @@ -921,11 +918,11 @@ public class Date * Tests if this date is after the specified date. * * @param when a date. - * @return true if and only if the instant represented - * by this Date object is strictly later than the - * instant represented by when; - * false otherwise. - * @exception NullPointerException if when is null. + * @return {@code true} if and only if the instant represented + * by this {@code Date} object is strictly later than the + * instant represented by {@code when}; + * {@code false} otherwise. + * @exception NullPointerException if {@code when} is null. */ public boolean after(Date when) { return getMillisOf(this) > getMillisOf(when); @@ -933,17 +930,17 @@ public class Date /** * Compares two dates for equality. - * The result is true if and only if the argument is - * not null and is a Date object that + * The result is {@code true} if and only if the argument is + * not {@code null} and is a {@code Date} object that * represents the same point in time, to the millisecond, as this object. *

      - * Thus, two Date objects are equal if and only if the - * getTime method returns the same long + * Thus, two {@code Date} objects are equal if and only if the + * {@code getTime} method returns the same {@code long} * value for both. * * @param obj the object to compare with. - * @return true if the objects are the same; - * false otherwise. + * @return {@code true} if the objects are the same; + * {@code false} otherwise. * @see java.util.Date#getTime() */ public boolean equals(Object obj) { @@ -951,7 +948,7 @@ public class Date } /** - * Returns the millisecond value of this Date object + * Returns the millisecond value of this {@code Date} object * without affecting its internal state. */ static final long getMillisOf(Date date) { @@ -965,13 +962,13 @@ public class Date /** * Compares two Dates for ordering. * - * @param anotherDate the Date to be compared. - * @return the value 0 if the argument Date is equal to - * this Date; a value less than 0 if this Date + * @param anotherDate the {@code Date} to be compared. + * @return the value {@code 0} if the argument Date is equal to + * this Date; a value less than {@code 0} if this Date * is before the Date argument; and a value greater than - * 0 if this Date is after the Date argument. + * {@code 0} if this Date is after the Date argument. * @since 1.2 - * @exception NullPointerException if anotherDate is null. + * @exception NullPointerException if {@code anotherDate} is null. */ public int compareTo(Date anotherDate) { long thisTime = getMillisOf(this); @@ -981,7 +978,7 @@ public class Date /** * Returns a hash code value for this object. The result is the - * exclusive OR of the two halves of the primitive long + * exclusive OR of the two halves of the primitive {@code long} * value returned by the {@link Date#getTime} * method. That is, the hash code is the value of the expression: *

      {@code
      @@ -996,29 +993,29 @@ public class Date
           }
       
           /**
      -     * Converts this Date object to a String
      +     * Converts this {@code Date} object to a {@code String}
            * of the form:
            * 
            * dow mon dd hh:mm:ss zzz yyyy
      * where:
        - *
      • dow is the day of the week (Sun, Mon, Tue, Wed, - * Thu, Fri, Sat). - *
      • mon is the month (Jan, Feb, Mar, Apr, May, Jun, - * Jul, Aug, Sep, Oct, Nov, Dec). - *
      • dd is the day of the month (01 through - * 31), as two decimal digits. - *
      • hh is the hour of the day (00 through - * 23), as two decimal digits. - *
      • mm is the minute within the hour (00 through - * 59), as two decimal digits. - *
      • ss is the second within the minute (00 through - * 61, as two decimal digits. - *
      • zzz is the time zone (and may reflect daylight saving + *
      • {@code dow} is the day of the week ({@code Sun, Mon, Tue, Wed, + * Thu, Fri, Sat}). + *
      • {@code mon} is the month ({@code Jan, Feb, Mar, Apr, May, Jun, + * Jul, Aug, Sep, Oct, Nov, Dec}). + *
      • {@code dd} is the day of the month ({@code 01} through + * {@code 31}), as two decimal digits. + *
      • {@code hh} is the hour of the day ({@code 00} through + * {@code 23}), as two decimal digits. + *
      • {@code mm} is the minute within the hour ({@code 00} through + * {@code 59}), as two decimal digits. + *
      • {@code ss} is the second within the minute ({@code 00} through + * {@code 61}, as two decimal digits. + *
      • {@code zzz} is the time zone (and may reflect daylight saving * time). Standard time zone abbreviations include those - * recognized by the method parse. If time zone - * information is not available, then zzz is empty - + * recognized by the method {@code parse}. If time zone + * information is not available, then {@code zzz} is empty - * that is, it consists of no characters at all. - *
      • yyyy is the year, as four decimal digits. + *
      • {@code yyyy} is the year, as four decimal digits. *
      * * @return a string representation of this date. @@ -1053,7 +1050,7 @@ public class Date /** * Converts the given name to its 3-letter abbreviation (e.g., * "monday" -> "Mon") and stored the abbreviation in the given - * StringBuilder. + * {@code StringBuilder}. */ private static final StringBuilder convertToAbbr(StringBuilder sb, String name) { sb.append(Character.toUpperCase(name.charAt(0))); @@ -1062,11 +1059,11 @@ public class Date } /** - * Creates a string representation of this Date object in an + * Creates a string representation of this {@code Date} object in an * implementation-dependent form. The intent is that the form should * be familiar to the user of the Java application, wherever it may * happen to be running. The intent is comparable to that of the - * "%c" format supported by the strftime() + * "{@code %c}" format supported by the {@code strftime()} * function of ISO C. * * @return a string representation of this date, using the locale @@ -1075,7 +1072,7 @@ public class Date * @see java.util.Date#toString() * @see java.util.Date#toGMTString() * @deprecated As of JDK version 1.1, - * replaced by DateFormat.format(Date date). + * replaced by {@code DateFormat.format(Date date)}. */ @Deprecated public String toLocaleString() { @@ -1084,23 +1081,23 @@ public class Date } /** - * Creates a string representation of this Date object of + * Creates a string representation of this {@code Date} object of * the form: *
            * d mon yyyy hh:mm:ss GMT
      * where:
        - *
      • d is the day of the month (1 through 31), + *
      • d is the day of the month ({@code 1} through {@code 31}), * as one or two decimal digits. - *
      • mon is the month (Jan, Feb, Mar, Apr, May, Jun, Jul, - * Aug, Sep, Oct, Nov, Dec). + *
      • mon is the month ({@code Jan, Feb, Mar, Apr, May, Jun, Jul, + * Aug, Sep, Oct, Nov, Dec}). *
      • yyyy is the year, as four decimal digits. - *
      • hh is the hour of the day (00 through 23), + *
      • hh is the hour of the day ({@code 00} through {@code 23}), * as two decimal digits. - *
      • mm is the minute within the hour (00 through - * 59), as two decimal digits. - *
      • ss is the second within the minute (00 through - * 61), as two decimal digits. - *
      • GMT is exactly the ASCII letters "GMT" to indicate + *
      • mm is the minute within the hour ({@code 00} through + * {@code 59}), as two decimal digits. + *
      • ss is the second within the minute ({@code 00} through + * {@code 61}), as two decimal digits. + *
      • GMT is exactly the ASCII letters "{@code GMT}" to indicate * Greenwich Mean Time. *

      * The result does not depend on the local time zone. @@ -1111,8 +1108,8 @@ public class Date * @see java.util.Date#toString() * @see java.util.Date#toLocaleString() * @deprecated As of JDK version 1.1, - * replaced by DateFormat.format(Date date), using a - * GMT TimeZone. + * replaced by {@code DateFormat.format(Date date)}, using a + * GMT {@code TimeZone}. */ @Deprecated public String toGMTString() { @@ -1135,7 +1132,7 @@ public class Date /** * Returns the offset, measured in minutes, for the local time zone * relative to UTC that is appropriate for the time represented by - * this Date object. + * this {@code Date} object. *

      * For example, in Massachusetts, five time zones west of Greenwich: *

      @@ -1161,8 +1158,8 @@ public class Date
            * @see     java.util.Calendar#DST_OFFSET
            * @see     java.util.TimeZone#getDefault
            * @deprecated As of JDK version 1.1,
      -     * replaced by -(Calendar.get(Calendar.ZONE_OFFSET) +
      -     * Calendar.get(Calendar.DST_OFFSET)) / (60 * 1000).
      +     * replaced by {@code -(Calendar.get(Calendar.ZONE_OFFSET) +
      +     * Calendar.get(Calendar.DST_OFFSET)) / (60 * 1000)}.
            */
           @Deprecated
           public int getTimezoneOffset() {
      @@ -1313,7 +1310,7 @@ public class Date
           /**
            * Save the state of this object to a stream (i.e., serialize it).
            *
      -     * @serialData The value returned by getTime()
      +     * @serialData The value returned by {@code getTime()}
            *             is emitted (long).  This represents the offset from
            *             January 1, 1970, 00:00:00 GMT in milliseconds.
            */
      @@ -1336,7 +1333,7 @@ public class Date
            * Obtains an instance of {@code Date} from an {@code Instant} object.
            * 

      * {@code Instant} uses a precision of nanoseconds, whereas {@code Date} - * uses a precision of milliseconds. The conversion will trancate any + * uses a precision of milliseconds. The conversion will truncate any * excess precision information as though the amount in nanoseconds was * subject to integer division by one million. *