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;
58
59 import java.io.DataInput;
60 import java.io.DataOutput;
61 import java.io.Externalizable;
62 import java.io.IOException;
63 import java.io.InvalidClassException;
64 import java.io.ObjectInput;
65 import java.io.ObjectOutput;
66 import java.io.StreamCorruptedException;
67
68 /**
69 * The shared serialization delegate for this package.
70 *
71 * <h3>Implementation notes</h3>
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 LOCAL_DATE_TYPE_VERSION_2 = 21}.
76 * <p>
77 * In order to serialise the object it writes its byte and then calls back to the appropriate class where
78 * the serialisation is performed. In order to deserialise the object it read in the type byte, switching
79 * in order to select which class to call back into.
80 * <p>
81 * The serialisation 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 serialised as one object.
85 * <p>
86 * This class is mutable and should be created once per serialization.
87 *
88 * @serial include
89 * @since 1.8
90 */
91 final class Ser implements Externalizable {
92
93 /**
94 * Serialization version.
95 */
96 private static final long serialVersionUID = -7683839454370182990L;
97
98 static final byte DURATION_TYPE = 1;
99 static final byte INSTANT_TYPE = 2;
100 static final byte LOCAL_DATE_TYPE = 3;
101 static final byte LOCAL_TIME_TYPE = 4;
102 static final byte LOCAL_DATE_TIME_TYPE = 5;
103 static final byte ZONE_DATE_TIME_TYPE = 6;
104 static final byte ZONE_REGION_TYPE = 7;
105 static final byte ZONE_OFFSET_TYPE = 8;
106
107 /** The type being serialized. */
108 private byte type;
109 /** The object being serialized. */
110 private Object object;
111
112 /**
113 * Constructor for deserialization.
114 */
115 public Ser() {
116 }
117
118 /**
119 * Creates an instance for serialization.
120 *
121 * @param type the type
122 * @param object the object
123 */
124 Ser(byte type, Object object) {
125 this.type = type;
126 this.object = object;
127 }
128
129 //-----------------------------------------------------------------------
130 /**
131 * Implements the {@code Externalizable} interface to write the object.
132 *
133 * @param out the data stream to write to, not null
134 */
135 public void writeExternal(ObjectOutput out) throws IOException {
136 writeInternal(type, object, out);
137 }
138
139 static void writeInternal(byte type, Object object, DataOutput out) throws IOException {
140 out.writeByte(type);
141 switch (type) {
142 case DURATION_TYPE:
143 ((Duration) object).writeExternal(out);
144 break;
145 case INSTANT_TYPE:
146 ((Instant) object).writeExternal(out);
147 break;
148 case LOCAL_DATE_TYPE:
149 ((LocalDate) object).writeExternal(out);
150 break;
151 case LOCAL_DATE_TIME_TYPE:
152 ((LocalDateTime) object).writeExternal(out);
153 break;
154 case LOCAL_TIME_TYPE:
155 ((LocalTime) object).writeExternal(out);
156 break;
157 case ZONE_REGION_TYPE:
158 ((ZoneRegion) object).writeExternal(out);
159 break;
160 case ZONE_OFFSET_TYPE:
161 ((ZoneOffset) object).writeExternal(out);
162 break;
163 case ZONE_DATE_TIME_TYPE:
164 ((ZonedDateTime) object).writeExternal(out);
165 break;
166 default:
167 throw new InvalidClassException("Unknown serialized type");
168 }
169 }
170
171 //-----------------------------------------------------------------------
172 /**
173 * Implements the {@code Externalizable} interface to read the object.
174 *
175 * @param in the data to read, not null
176 */
177 public void readExternal(ObjectInput in) throws IOException {
178 type = in.readByte();
179 object = readInternal(type, in);
180 }
181
182 static Object read(DataInput in) throws IOException {
183 byte type = in.readByte();
184 return readInternal(type, in);
185 }
186
187 private static Object readInternal(byte type, DataInput in) throws IOException {
188 switch (type) {
189 case DURATION_TYPE: return Duration.readExternal(in);
190 case INSTANT_TYPE: return Instant.readExternal(in);
191 case LOCAL_DATE_TYPE: return LocalDate.readExternal(in);
192 case LOCAL_DATE_TIME_TYPE: return LocalDateTime.readExternal(in);
193 case LOCAL_TIME_TYPE: return LocalTime.readExternal(in);
194 case ZONE_DATE_TIME_TYPE: return ZonedDateTime.readExternal(in);
195 case ZONE_OFFSET_TYPE: return ZoneOffset.readExternal(in);
196 case ZONE_REGION_TYPE: return ZoneRegion.readExternal(in);
197 default:
198 throw new StreamCorruptedException("Unknown serialized type");
199 }
200 }
201
202 /**
203 * Returns the object that will replace this one.
204 *
205 * @return the read object, should never be null
206 */
207 private Object readResolve() {
208 return object;
209 }
210
211 }