1 /* 2 * Copyright (c) 2012, 2013, Oracle and/or its affiliates. All rights reserved. 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4 * 5 * This code is free software; you can redistribute it and/or modify it 6 * under the terms of the GNU General Public License version 2 only, as 7 * published by the Free Software Foundation. Oracle designates this 8 * particular file as subject to the "Classpath" exception as provided 9 * by Oracle in the LICENSE file that accompanied this code. 10 * 11 * This code is distributed in the hope that it will be useful, but WITHOUT 12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License 14 * version 2 for more details (a copy is included in the LICENSE file that 15 * accompanied this code). 16 * 17 * You should have received a copy of the GNU General Public License version 18 * 2 along with this work; if not, write to the Free Software Foundation, 19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. 20 * 21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA 22 * or visit www.oracle.com if you need additional information or have any 23 * questions. 24 */ 25 26 /* 27 * Copyright (c) 2011-2012, Stephen Colebourne & Michael Nascimento Santos 28 * 29 * All rights reserved. 30 * 31 * Redistribution and use in source and binary forms, with or without 32 * modification, are permitted provided that the following conditions are met: 33 * 34 * * Redistributions of source code must retain the above copyright notice, 35 * this list of conditions and the following disclaimer. 36 * 37 * * Redistributions in binary form must reproduce the above copyright notice, 38 * this list of conditions and the following disclaimer in the documentation 39 * and/or other materials provided with the distribution. 40 * 41 * * Neither the name of JSR-310 nor the names of its contributors 42 * may be used to endorse or promote products derived from this software 43 * without specific prior written permission. 44 * 45 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 46 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 47 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 48 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR 49 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, 50 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, 51 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR 52 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF 53 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING 54 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS 55 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 56 */ 57 package java.time.chrono; 58 59 import java.io.Externalizable; 60 import java.io.IOException; 61 import java.io.InvalidClassException; 62 import java.io.ObjectInput; 63 import java.io.ObjectOutput; 64 import java.io.StreamCorruptedException; 65 import java.time.LocalDate; 66 import java.time.LocalDateTime; 67 68 /** 69 * The shared serialization delegate for this package. 70 * 71 * @implNote 72 * This class wraps the object being serialized, and takes a byte representing the type of the class to 73 * be serialized. This byte can also be used for versioning the serialization format. In this case another 74 * byte flag would be used in order to specify an alternative version of the type format. 75 * For example {@code CHRONO_TYPE_VERSION_2 = 21} 76 * <p> 77 * In order to serialize the object it writes its byte and then calls back to the appropriate class where 78 * the serialization is performed. In order to deserialize the object it read in the type byte, switching 79 * in order to select which class to call back into. 80 * <p> 81 * The serialization format is determined on a per class basis. In the case of field based classes each 82 * of the fields is written out with an appropriate size format in descending order of the field's size. For 83 * example in the case of {@link LocalDate} year is written before month. Composite classes, such as 84 * {@link LocalDateTime} are serialized as one object. Enum classes are serialized using the index of their 85 * element. 86 * <p> 87 * This class is mutable and should be created once per serialization. 88 * 89 * @serial include 90 * @since 1.8 91 */ 92 final class Ser implements Externalizable { 93 94 /** 95 * Serialization version. 96 */ 97 private static final long serialVersionUID = -6103370247208168577L; 98 99 static final byte CHRONO_TYPE = 1; 100 static final byte CHRONO_LOCAL_DATE_TIME_TYPE = 2; 101 static final byte CHRONO_ZONE_DATE_TIME_TYPE = 3; 102 static final byte JAPANESE_DATE_TYPE = 4; 103 static final byte JAPANESE_ERA_TYPE = 5; 104 static final byte HIJRAH_DATE_TYPE = 6; 105 static final byte MINGUO_DATE_TYPE = 7; 106 static final byte THAIBUDDHIST_DATE_TYPE = 8; 107 static final byte CHRONO_PERIOD_TYPE = 9; 108 109 /** The type being serialized. */ 110 private byte type; 111 /** The object being serialized. */ 112 private Object object; 113 114 /** 115 * Constructor for deserialization. 116 */ Ser()117 public Ser() { 118 } 119 120 /** 121 * Creates an instance for serialization. 122 * 123 * @param type the type 124 * @param object the object 125 */ Ser(byte type, Object object)126 Ser(byte type, Object object) { 127 this.type = type; 128 this.object = object; 129 } 130 131 //----------------------------------------------------------------------- 132 /** 133 * Implements the {@code Externalizable} interface to write the object. 134 * @serialData 135 * Each serializable class is mapped to a type that is the first byte 136 * in the stream. Refer to each class {@code writeReplace} 137 * serialized form for the value of the type and sequence of values for the type. 138 * <ul> 139 * <li><a href="../../../serialized-form.html#java.time.chrono.HijrahChronology">HijrahChronology.writeReplace</a> 140 * <li><a href="../../../serialized-form.html#java.time.chrono.IsoChronology">IsoChronology.writeReplace</a> 141 * <li><a href="../../../serialized-form.html#java.time.chrono.JapaneseChronology">JapaneseChronology.writeReplace</a> 142 * <li><a href="../../../serialized-form.html#java.time.chrono.MinguoChronology">MinguoChronology.writeReplace</a> 143 * <li><a href="../../../serialized-form.html#java.time.chrono.ThaiBuddhistChronology">ThaiBuddhistChronology.writeReplace</a> 144 * <li><a href="../../../serialized-form.html#java.time.chrono.ChronoLocalDateTimeImpl">ChronoLocalDateTime.writeReplace</a> 145 * <li><a href="../../../serialized-form.html#java.time.chrono.ChronoZonedDateTimeImpl">ChronoZonedDateTime.writeReplace</a> 146 * <li><a href="../../../serialized-form.html#java.time.chrono.JapaneseDate">JapaneseDate.writeReplace</a> 147 * <li><a href="../../../serialized-form.html#java.time.chrono.JapaneseEra">JapaneseEra.writeReplace</a> 148 * <li><a href="../../../serialized-form.html#java.time.chrono.HijrahDate">HijrahDate.writeReplace</a> 149 * <li><a href="../../../serialized-form.html#java.time.chrono.MinguoDate">MinguoDate.writeReplace</a> 150 * <li><a href="../../../serialized-form.html#java.time.chrono.ThaiBuddhistDate">ThaiBuddhistDate.writeReplace</a> 151 * </ul> 152 * 153 * @param out the data stream to write to, not null 154 */ 155 @Override writeExternal(ObjectOutput out)156 public void writeExternal(ObjectOutput out) throws IOException { 157 writeInternal(type, object, out); 158 } 159 writeInternal(byte type, Object object, ObjectOutput out)160 private static void writeInternal(byte type, Object object, ObjectOutput out) throws IOException { 161 out.writeByte(type); 162 switch (type) { 163 case CHRONO_TYPE: 164 ((AbstractChronology) object).writeExternal(out); 165 break; 166 case CHRONO_LOCAL_DATE_TIME_TYPE: 167 ((ChronoLocalDateTimeImpl<?>) object).writeExternal(out); 168 break; 169 case CHRONO_ZONE_DATE_TIME_TYPE: 170 ((ChronoZonedDateTimeImpl<?>) object).writeExternal(out); 171 break; 172 case JAPANESE_DATE_TYPE: 173 ((JapaneseDate) object).writeExternal(out); 174 break; 175 case JAPANESE_ERA_TYPE: 176 ((JapaneseEra) object).writeExternal(out); 177 break; 178 case HIJRAH_DATE_TYPE: 179 ((HijrahDate) object).writeExternal(out); 180 break; 181 case MINGUO_DATE_TYPE: 182 ((MinguoDate) object).writeExternal(out); 183 break; 184 case THAIBUDDHIST_DATE_TYPE: 185 ((ThaiBuddhistDate) object).writeExternal(out); 186 break; 187 case CHRONO_PERIOD_TYPE: 188 ((ChronoPeriodImpl) object).writeExternal(out); 189 break; 190 default: 191 throw new InvalidClassException("Unknown serialized type"); 192 } 193 } 194 195 //----------------------------------------------------------------------- 196 /** 197 * Implements the {@code Externalizable} interface to read the object. 198 * @serialData 199 * The streamed type and parameters defined by the type's {@code writeReplace} 200 * method are read and passed to the corresponding static factory for the type 201 * to create a new instance. That instance is returned as the de-serialized 202 * {@code Ser} object. 203 * 204 * <ul> 205 * <li><a href="../../../serialized-form.html#java.time.chrono.HijrahChronology">HijrahChronology</a> - Chronology.of(id) 206 * <li><a href="../../../serialized-form.html#java.time.chrono.IsoChronology">IsoChronology</a> - Chronology.of(id) 207 * <li><a href="../../../serialized-form.html#java.time.chrono.JapaneseChronology">JapaneseChronology</a> - Chronology.of(id) 208 * <li><a href="../../../serialized-form.html#java.time.chrono.MinguoChronology">MinguoChronology</a> - Chronology.of(id) 209 * <li><a href="../../../serialized-form.html#java.time.chrono.ThaiBuddhistChronology">ThaiBuddhistChronology</a> - Chronology.of(id) 210 * <li><a href="../../../serialized-form.html#java.time.chrono.ChronoLocalDateTimeImpl">ChronoLocalDateTime</a> - date.atTime(time) 211 * <li><a href="../../../serialized-form.html#java.time.chrono.ChronoZonedDateTimeImpl">ChronoZonedDateTime</a> - dateTime.atZone(offset).withZoneSameLocal(zone) 212 * <li><a href="../../../serialized-form.html#java.time.chrono.JapaneseDate">JapaneseDate</a> - JapaneseChronology.INSTANCE.date(year, month, dayOfMonth) 213 * <li><a href="../../../serialized-form.html#java.time.chrono.JapaneseEra">JapaneseEra</a> - JapaneseEra.of(eraValue) 214 * <li><a href="../../../serialized-form.html#java.time.chrono.HijrahDate">HijrahDate</a> - HijrahChronology chrono.date(year, month, dayOfMonth) 215 * <li><a href="../../../serialized-form.html#java.time.chrono.MinguoDate">MinguoDate</a> - MinguoChronology.INSTANCE.date(year, month, dayOfMonth) 216 * <li><a href="../../../serialized-form.html#java.time.chrono.ThaiBuddhistDate">ThaiBuddhistDate</a> - ThaiBuddhistChronology.INSTANCE.date(year, month, dayOfMonth) 217 * </ul> 218 * 219 * @param in the data stream to read from, not null 220 */ 221 @Override readExternal(ObjectInput in)222 public void readExternal(ObjectInput in) throws IOException, ClassNotFoundException { 223 type = in.readByte(); 224 object = readInternal(type, in); 225 } 226 read(ObjectInput in)227 static Object read(ObjectInput in) throws IOException, ClassNotFoundException { 228 byte type = in.readByte(); 229 return readInternal(type, in); 230 } 231 readInternal(byte type, ObjectInput in)232 private static Object readInternal(byte type, ObjectInput in) throws IOException, ClassNotFoundException { 233 switch (type) { 234 case CHRONO_TYPE: return AbstractChronology.readExternal(in); 235 case CHRONO_LOCAL_DATE_TIME_TYPE: return ChronoLocalDateTimeImpl.readExternal(in); 236 case CHRONO_ZONE_DATE_TIME_TYPE: return ChronoZonedDateTimeImpl.readExternal(in); 237 case JAPANESE_DATE_TYPE: return JapaneseDate.readExternal(in); 238 case JAPANESE_ERA_TYPE: return JapaneseEra.readExternal(in); 239 case HIJRAH_DATE_TYPE: return HijrahDate.readExternal(in); 240 case MINGUO_DATE_TYPE: return MinguoDate.readExternal(in); 241 case THAIBUDDHIST_DATE_TYPE: return ThaiBuddhistDate.readExternal(in); 242 case CHRONO_PERIOD_TYPE: return ChronoPeriodImpl.readExternal(in); 243 default: throw new StreamCorruptedException("Unknown serialized type"); 244 } 245 } 246 247 /** 248 * Returns the object that will replace this one. 249 * 250 * @return the read object, should never be null 251 */ readResolve()252 private Object readResolve() { 253 return object; 254 } 255 256 } 257