changeset 9156:0312741183c9

8032502: java.time add @param tags to readObject Summary: Add @param tags Reviewed-by: lancea, darcy
author rriggs
date Wed, 22 Jan 2014 17:40:58 -0500
parents 2f5996a8ba5d
children 1aa2dbdbacee
files src/share/classes/java/time/Duration.java src/share/classes/java/time/Instant.java src/share/classes/java/time/LocalDate.java src/share/classes/java/time/LocalDateTime.java src/share/classes/java/time/LocalTime.java src/share/classes/java/time/MonthDay.java src/share/classes/java/time/OffsetDateTime.java src/share/classes/java/time/OffsetTime.java src/share/classes/java/time/Period.java src/share/classes/java/time/Year.java src/share/classes/java/time/YearMonth.java src/share/classes/java/time/ZoneId.java src/share/classes/java/time/ZoneOffset.java src/share/classes/java/time/ZoneRegion.java src/share/classes/java/time/ZonedDateTime.java src/share/classes/java/time/chrono/AbstractChronology.java src/share/classes/java/time/chrono/ChronoLocalDateTimeImpl.java src/share/classes/java/time/chrono/ChronoPeriodImpl.java src/share/classes/java/time/chrono/ChronoZonedDateTimeImpl.java src/share/classes/java/time/chrono/HijrahChronology.java src/share/classes/java/time/chrono/HijrahDate.java src/share/classes/java/time/chrono/IsoChronology.java src/share/classes/java/time/chrono/JapaneseChronology.java src/share/classes/java/time/chrono/JapaneseDate.java src/share/classes/java/time/chrono/JapaneseEra.java src/share/classes/java/time/chrono/MinguoChronology.java src/share/classes/java/time/chrono/MinguoDate.java src/share/classes/java/time/chrono/ThaiBuddhistChronology.java src/share/classes/java/time/chrono/ThaiBuddhistDate.java src/share/classes/java/time/temporal/ValueRange.java src/share/classes/java/time/temporal/WeekFields.java src/share/classes/java/time/zone/ZoneOffsetTransition.java src/share/classes/java/time/zone/ZoneOffsetTransitionRule.java src/share/classes/java/time/zone/ZoneRules.java
diffstat 34 files changed, 39 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/src/share/classes/java/time/Duration.java	Wed Jan 22 11:03:44 2014 -0800
+++ b/src/share/classes/java/time/Duration.java	Wed Jan 22 17:40:58 2014 -0500
@@ -1326,6 +1326,7 @@
     /**
      * Defend against malicious streams.
      *
+     * @param s the stream to read
      * @throws InvalidObjectException always
      */
     private void readObject(ObjectInputStream s) throws InvalidObjectException {
--- a/src/share/classes/java/time/Instant.java	Wed Jan 22 11:03:44 2014 -0800
+++ b/src/share/classes/java/time/Instant.java	Wed Jan 22 17:40:58 2014 -0500
@@ -1348,6 +1348,7 @@
     /**
      * Defend against malicious streams.
      *
+     * @param s the stream to read
      * @throws InvalidObjectException always
      */
     private void readObject(ObjectInputStream s) throws InvalidObjectException {
--- a/src/share/classes/java/time/LocalDate.java	Wed Jan 22 11:03:44 2014 -0800
+++ b/src/share/classes/java/time/LocalDate.java	Wed Jan 22 17:40:58 2014 -0500
@@ -2053,6 +2053,7 @@
     /**
      * Defend against malicious streams.
      *
+     * @param s the stream to read
      * @throws InvalidObjectException always
      */
     private void readObject(ObjectInputStream s) throws InvalidObjectException {
--- a/src/share/classes/java/time/LocalDateTime.java	Wed Jan 22 11:03:44 2014 -0800
+++ b/src/share/classes/java/time/LocalDateTime.java	Wed Jan 22 17:40:58 2014 -0500
@@ -1986,6 +1986,7 @@
     /**
      * Defend against malicious streams.
      *
+     * @param s the stream to read
      * @throws InvalidObjectException always
      */
     private void readObject(ObjectInputStream s) throws InvalidObjectException {
--- a/src/share/classes/java/time/LocalTime.java	Wed Jan 22 11:03:44 2014 -0800
+++ b/src/share/classes/java/time/LocalTime.java	Wed Jan 22 17:40:58 2014 -0500
@@ -1638,6 +1638,7 @@
     /**
      * Defend against malicious streams.
      *
+     * @param s the stream to read
      * @throws InvalidObjectException always
      */
     private void readObject(ObjectInputStream s) throws InvalidObjectException {
--- a/src/share/classes/java/time/MonthDay.java	Wed Jan 22 11:03:44 2014 -0800
+++ b/src/share/classes/java/time/MonthDay.java	Wed Jan 22 17:40:58 2014 -0500
@@ -771,6 +771,7 @@
     /**
      * Defend against malicious streams.
      *
+     * @param s the stream to read
      * @throws InvalidObjectException always
      */
     private void readObject(ObjectInputStream s) throws InvalidObjectException {
--- a/src/share/classes/java/time/OffsetDateTime.java	Wed Jan 22 11:03:44 2014 -0800
+++ b/src/share/classes/java/time/OffsetDateTime.java	Wed Jan 22 17:40:58 2014 -0500
@@ -1925,6 +1925,7 @@
     /**
      * Defend against malicious streams.
      *
+     * @param s the stream to read
      * @throws InvalidObjectException always
      */
     private void readObject(ObjectInputStream s) throws InvalidObjectException {
--- a/src/share/classes/java/time/OffsetTime.java	Wed Jan 22 11:03:44 2014 -0800
+++ b/src/share/classes/java/time/OffsetTime.java	Wed Jan 22 17:40:58 2014 -0500
@@ -1396,6 +1396,7 @@
     /**
      * Defend against malicious streams.
      *
+     * @param s the stream to read
      * @throws InvalidObjectException always
      */
     private void readObject(ObjectInputStream s) throws InvalidObjectException {
--- a/src/share/classes/java/time/Period.java	Wed Jan 22 11:03:44 2014 -0800
+++ b/src/share/classes/java/time/Period.java	Wed Jan 22 17:40:58 2014 -0500
@@ -1058,6 +1058,7 @@
     /**
      * Defend against malicious streams.
      *
+     * @param s the stream to read
      * @throws java.io.InvalidObjectException always
      */
     private void readObject(ObjectInputStream s) throws InvalidObjectException {
--- a/src/share/classes/java/time/Year.java	Wed Jan 22 11:03:44 2014 -0800
+++ b/src/share/classes/java/time/Year.java	Wed Jan 22 17:40:58 2014 -0500
@@ -1104,6 +1104,7 @@
     /**
      * Defend against malicious streams.
      *
+     * @param s the stream to read
      * @throws InvalidObjectException always
      */
     private void readObject(ObjectInputStream s) throws InvalidObjectException {
--- a/src/share/classes/java/time/YearMonth.java	Wed Jan 22 11:03:44 2014 -0800
+++ b/src/share/classes/java/time/YearMonth.java	Wed Jan 22 17:40:58 2014 -0500
@@ -1230,6 +1230,7 @@
     /**
      * Defend against malicious streams.
      *
+     * @param s the stream to read
      * @throws InvalidObjectException always
      */
     private void readObject(ObjectInputStream s) throws InvalidObjectException {
--- a/src/share/classes/java/time/ZoneId.java	Wed Jan 22 11:03:44 2014 -0800
+++ b/src/share/classes/java/time/ZoneId.java	Wed Jan 22 17:40:58 2014 -0500
@@ -624,6 +624,7 @@
     /**
      * Defend against malicious streams.
      *
+     * @param s the stream to read
      * @throws InvalidObjectException always
      */
     private void readObject(ObjectInputStream s) throws InvalidObjectException {
--- a/src/share/classes/java/time/ZoneOffset.java	Wed Jan 22 11:03:44 2014 -0800
+++ b/src/share/classes/java/time/ZoneOffset.java	Wed Jan 22 17:40:58 2014 -0500
@@ -769,6 +769,7 @@
     /**
      * Defend against malicious streams.
      *
+     * @param s the stream to read
      * @throws InvalidObjectException always
      */
     private void readObject(ObjectInputStream s) throws InvalidObjectException {
--- a/src/share/classes/java/time/ZoneRegion.java	Wed Jan 22 11:03:44 2014 -0800
+++ b/src/share/classes/java/time/ZoneRegion.java	Wed Jan 22 17:40:58 2014 -0500
@@ -196,6 +196,7 @@
     /**
      * Defend against malicious streams.
      *
+     * @param s the stream to read
      * @throws InvalidObjectException always
      */
     private void readObject(ObjectInputStream s) throws InvalidObjectException {
--- a/src/share/classes/java/time/ZonedDateTime.java	Wed Jan 22 11:03:44 2014 -0800
+++ b/src/share/classes/java/time/ZonedDateTime.java	Wed Jan 22 17:40:58 2014 -0500
@@ -2225,6 +2225,7 @@
     /**
      * Defend against malicious streams.
      *
+     * @param s the stream to read
      * @throws InvalidObjectException always
      */
     private void readObject(ObjectInputStream s) throws InvalidObjectException {
--- a/src/share/classes/java/time/chrono/AbstractChronology.java	Wed Jan 22 11:03:44 2014 -0800
+++ b/src/share/classes/java/time/chrono/AbstractChronology.java	Wed Jan 22 17:40:58 2014 -0500
@@ -766,6 +766,7 @@
     /**
      * Defend against malicious streams.
      *
+     * @param s the stream to read
      * @throws java.io.InvalidObjectException always
      */
     private void readObject(ObjectInputStream s) throws ObjectStreamException {
--- a/src/share/classes/java/time/chrono/ChronoLocalDateTimeImpl.java	Wed Jan 22 11:03:44 2014 -0800
+++ b/src/share/classes/java/time/chrono/ChronoLocalDateTimeImpl.java	Wed Jan 22 17:40:58 2014 -0500
@@ -416,6 +416,7 @@
     /**
      * Defend against malicious streams.
      *
+     * @param s the stream to read
      * @throws InvalidObjectException always
      */
     private void readObject(ObjectInputStream s) throws InvalidObjectException {
--- a/src/share/classes/java/time/chrono/ChronoPeriodImpl.java	Wed Jan 22 11:03:44 2014 -0800
+++ b/src/share/classes/java/time/chrono/ChronoPeriodImpl.java	Wed Jan 22 17:40:58 2014 -0500
@@ -376,6 +376,7 @@
     /**
      * Defend against malicious streams.
      *
+     * @param s the stream to read
      * @throws InvalidObjectException always
      */
     private void readObject(ObjectInputStream s) throws ObjectStreamException {
--- a/src/share/classes/java/time/chrono/ChronoZonedDateTimeImpl.java	Wed Jan 22 11:03:44 2014 -0800
+++ b/src/share/classes/java/time/chrono/ChronoZonedDateTimeImpl.java	Wed Jan 22 17:40:58 2014 -0500
@@ -340,6 +340,7 @@
     /**
      * Defend against malicious streams.
      *
+     * @param s the stream to read
      * @throws InvalidObjectException always
      */
     private void readObject(ObjectInputStream s) throws InvalidObjectException {
--- a/src/share/classes/java/time/chrono/HijrahChronology.java	Wed Jan 22 11:03:44 2014 -0800
+++ b/src/share/classes/java/time/chrono/HijrahChronology.java	Wed Jan 22 17:40:58 2014 -0500
@@ -1096,6 +1096,7 @@
     /**
      * Defend against malicious streams.
      *
+     * @param s the stream to read
      * @throws InvalidObjectException always
      */
     private void readObject(ObjectInputStream s) throws InvalidObjectException {
--- a/src/share/classes/java/time/chrono/HijrahDate.java	Wed Jan 22 11:03:44 2014 -0800
+++ b/src/share/classes/java/time/chrono/HijrahDate.java	Wed Jan 22 17:40:58 2014 -0500
@@ -654,6 +654,7 @@
     /**
      * Defend against malicious streams.
      *
+     * @param s the stream to read
      * @throws InvalidObjectException always
      */
     private void readObject(ObjectInputStream s) throws InvalidObjectException {
--- a/src/share/classes/java/time/chrono/IsoChronology.java	Wed Jan 22 11:03:44 2014 -0800
+++ b/src/share/classes/java/time/chrono/IsoChronology.java	Wed Jan 22 17:40:58 2014 -0500
@@ -604,6 +604,7 @@
     /**
      * Defend against malicious streams.
      *
+     * @param s the stream to read
      * @throws InvalidObjectException always
      */
     private void readObject(ObjectInputStream s) throws InvalidObjectException {
--- a/src/share/classes/java/time/chrono/JapaneseChronology.java	Wed Jan 22 11:03:44 2014 -0800
+++ b/src/share/classes/java/time/chrono/JapaneseChronology.java	Wed Jan 22 17:40:58 2014 -0500
@@ -525,6 +525,7 @@
     /**
      * Defend against malicious streams.
      *
+     * @param s the stream to read
      * @throws InvalidObjectException always
      */
     private void readObject(ObjectInputStream s) throws InvalidObjectException {
--- a/src/share/classes/java/time/chrono/JapaneseDate.java	Wed Jan 22 11:03:44 2014 -0800
+++ b/src/share/classes/java/time/chrono/JapaneseDate.java	Wed Jan 22 17:40:58 2014 -0500
@@ -716,6 +716,7 @@
     /**
      * Defend against malicious streams.
      *
+     * @param s the stream to read
      * @throws InvalidObjectException always
      */
     private void readObject(ObjectInputStream s) throws InvalidObjectException {
--- a/src/share/classes/java/time/chrono/JapaneseEra.java	Wed Jan 22 11:03:44 2014 -0800
+++ b/src/share/classes/java/time/chrono/JapaneseEra.java	Wed Jan 22 17:40:58 2014 -0500
@@ -357,6 +357,7 @@
     /**
      * Defend against malicious streams.
      *
+     * @param s the stream to read
      * @throws InvalidObjectException always
      */
     private void readObject(ObjectInputStream s) throws InvalidObjectException {
--- a/src/share/classes/java/time/chrono/MinguoChronology.java	Wed Jan 22 11:03:44 2014 -0800
+++ b/src/share/classes/java/time/chrono/MinguoChronology.java	Wed Jan 22 17:40:58 2014 -0500
@@ -355,6 +355,7 @@
     /**
      * Defend against malicious streams.
      *
+     * @param s the stream to read
      * @throws InvalidObjectException always
      */
     private void readObject(ObjectInputStream s) throws InvalidObjectException {
--- a/src/share/classes/java/time/chrono/MinguoDate.java	Wed Jan 22 11:03:44 2014 -0800
+++ b/src/share/classes/java/time/chrono/MinguoDate.java	Wed Jan 22 17:40:58 2014 -0500
@@ -478,6 +478,7 @@
     /**
      * Defend against malicious streams.
      *
+     * @param s the stream to read
      * @throws InvalidObjectException always
      */
     private void readObject(ObjectInputStream s) throws InvalidObjectException {
--- a/src/share/classes/java/time/chrono/ThaiBuddhistChronology.java	Wed Jan 22 11:03:44 2014 -0800
+++ b/src/share/classes/java/time/chrono/ThaiBuddhistChronology.java	Wed Jan 22 17:40:58 2014 -0500
@@ -391,6 +391,7 @@
     /**
      * Defend against malicious streams.
      *
+     * @param s the stream to read
      * @throws InvalidObjectException always
      */
     private void readObject(ObjectInputStream s) throws InvalidObjectException {
--- a/src/share/classes/java/time/chrono/ThaiBuddhistDate.java	Wed Jan 22 11:03:44 2014 -0800
+++ b/src/share/classes/java/time/chrono/ThaiBuddhistDate.java	Wed Jan 22 17:40:58 2014 -0500
@@ -478,6 +478,7 @@
     /**
      * Defend against malicious streams.
      *
+     * @param s the stream to read
      * @throws InvalidObjectException always
      */
     private void readObject(ObjectInputStream s) throws InvalidObjectException {
--- a/src/share/classes/java/time/temporal/ValueRange.java	Wed Jan 22 11:03:44 2014 -0800
+++ b/src/share/classes/java/time/temporal/ValueRange.java	Wed Jan 22 17:40:58 2014 -0500
@@ -344,10 +344,13 @@
     /**
      * Restore the state of an ValueRange from the stream.
      * Check that the values are valid.
+     *
+     * @param s the stream to read
      * @throws InvalidObjectException if
      *     the smallest minimum is greater than the smallest maximum,
      *  or the smallest maximum is greater than the largest maximum
      *  or the largest minimum is greater than the largest maximum
+     * @throws ClassNotFoundException if a class cannot be resolved
      */
     private void readObject(ObjectInputStream s)
          throws IOException, ClassNotFoundException, InvalidObjectException
--- a/src/share/classes/java/time/temporal/WeekFields.java	Wed Jan 22 11:03:44 2014 -0800
+++ b/src/share/classes/java/time/temporal/WeekFields.java	Wed Jan 22 17:40:58 2014 -0500
@@ -344,8 +344,11 @@
     /**
      * Restore the state of a WeekFields from the stream.
      * Check that the values are valid.
+     *
+     * @param s the stream to read
      * @throws InvalidObjectException if the serialized object has an invalid
      *     value for firstDayOfWeek or minimalDays.
+     * @throws ClassNotFoundException if a class cannot be resolved
      */
     private void readObject(ObjectInputStream s)
          throws IOException, ClassNotFoundException, InvalidObjectException
--- a/src/share/classes/java/time/zone/ZoneOffsetTransition.java	Wed Jan 22 11:03:44 2014 -0800
+++ b/src/share/classes/java/time/zone/ZoneOffsetTransition.java	Wed Jan 22 17:40:58 2014 -0500
@@ -173,6 +173,8 @@
     //-----------------------------------------------------------------------
     /**
      * Defend against malicious streams.
+     *
+     * @param s the stream to read
      * @throws InvalidObjectException always
      */
     private void readObject(ObjectInputStream s) throws InvalidObjectException {
--- a/src/share/classes/java/time/zone/ZoneOffsetTransitionRule.java	Wed Jan 22 11:03:44 2014 -0800
+++ b/src/share/classes/java/time/zone/ZoneOffsetTransitionRule.java	Wed Jan 22 17:40:58 2014 -0500
@@ -235,6 +235,7 @@
     /**
      * Defend against malicious streams.
      *
+     * @param s the stream to read
      * @throws InvalidObjectException always
      */
     private void readObject(ObjectInputStream s) throws InvalidObjectException {
--- a/src/share/classes/java/time/zone/ZoneRules.java	Wed Jan 22 11:03:44 2014 -0800
+++ b/src/share/classes/java/time/zone/ZoneRules.java	Wed Jan 22 17:40:58 2014 -0500
@@ -319,6 +319,7 @@
     /**
      * Defend against malicious streams.
      *
+     * @param s the stream to read
      * @throws InvalidObjectException always
      */
     private void readObject(ObjectInputStream s) throws InvalidObjectException {