OpenJDK 27 · java.time.Ser · APIdia, the JavaDoc alternative

Implementation Note

This class wraps the object being serialized, and takes a byte representing the type of the class to be serialized. This byte can also be used for versioning the serialization format. In this case another byte flag would be used in order to specify an alternative version of the type format. For example LOCAL_DATE_TYPE_VERSION_2 = 21.

In order to serialize the object it writes its byte and then calls back to the appropriate class where the serialization is performed. In order to deserialize the object it read in the type byte, switching in order to select which class to call back into.

The serialization format is determined on a per class basis. In the case of field based classes each of the fields is written out with an appropriate size format in descending order of the field's size. For example in the case of LocalDate year is written before month. Composite classes, such as LocalDateTime are serialized as one object.

This class is mutable and should be created once per serialization.

Field Summary

Modifier and Type	Field and Description
pack-priv static final byte	DURATION_TYPE
pack-priv static final byte	INSTANT_TYPE
pack-priv static final byte	LOCAL_DATE_TIME_TYPE
pack-priv static final byte	LOCAL_DATE_TYPE
pack-priv static final byte	LOCAL_TIME_TYPE
pack-priv static final byte	MONTH_DAY_TYPE
private Serializable	object The object being serialized.
pack-priv static final byte	OFFSET_DATE_TIME_TYPE
pack-priv static final byte	OFFSET_TIME_TYPE
pack-priv static final byte	PERIOD_TYPE
private static final long	serialVersionUID Serialization version.
private byte	type The type being serialized.
pack-priv static final byte	YEAR_MONTH_TYPE
pack-priv static final byte	YEAR_TYPE
pack-priv static final byte	ZONE_DATE_TIME_TYPE
pack-priv static final byte	ZONE_OFFSET_TYPE
pack-priv static final byte	ZONE_REGION_TYPE

Constructor Summary

Access	Constructor and Description
public	Ser() Constructor for deserialization.
pack-priv	Ser(byte the type type, Serializable the object object) Creates an instance for serialization.

Method Summary

Modifier and Type	Method and Description
pack-priv static Serializable	read(ObjectInput in)
public void	readExternal(ObjectInput the data to read, not null in) Implements java.io.Externalizable.readExternal. Implements the `Externalizable` interface to read the object.
private static Serializable	readInternal(byte type, ObjectInput in)
private Object	Returns: the read object, should never be null readResolve() Returns the object that will replace this one.
public void	writeExternal(ObjectOutput the data stream to write to, not null out) Implements java.io.Externalizable.writeExternal. Implements the `Externalizable` interface to write the object.
pack-priv static void	writeInternal(byte type, Object object, ObjectOutput out)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

DURATION_TYPE	back to summary
pack-priv static final byte DURATION_TYPE

INSTANT_TYPE	back to summary
pack-priv static final byte INSTANT_TYPE

LOCAL_DATE_TIME_TYPE	back to summary
pack-priv static final byte LOCAL_DATE_TIME_TYPE

LOCAL_DATE_TYPE	back to summary
pack-priv static final byte LOCAL_DATE_TYPE

LOCAL_TIME_TYPE	back to summary
pack-priv static final byte LOCAL_TIME_TYPE

MONTH_DAY_TYPE	back to summary
pack-priv static final byte MONTH_DAY_TYPE

object	back to summary
private Serializable object The object being serialized.

OFFSET_DATE_TIME_TYPE	back to summary
pack-priv static final byte OFFSET_DATE_TIME_TYPE

OFFSET_TIME_TYPE	back to summary
pack-priv static final byte OFFSET_TIME_TYPE

PERIOD_TYPE	back to summary
pack-priv static final byte PERIOD_TYPE

serialVersionUID	back to summary
private static final long serialVersionUID Serialization version. Annotations @Serial

type	back to summary
private byte type The type being serialized.

YEAR_MONTH_TYPE	back to summary
pack-priv static final byte YEAR_MONTH_TYPE

YEAR_TYPE	back to summary
pack-priv static final byte YEAR_TYPE

ZONE_DATE_TIME_TYPE	back to summary
pack-priv static final byte ZONE_DATE_TIME_TYPE

ZONE_OFFSET_TYPE	back to summary
pack-priv static final byte ZONE_OFFSET_TYPE

ZONE_REGION_TYPE	back to summary
pack-priv static final byte ZONE_REGION_TYPE

Constructor Detail

Ser	back to summary
public Ser() Constructor for deserialization.

Ser	back to summary
pack-priv Ser(byte type, Serializable object) Creates an instance for serialization. Parameters type:byte the type object:Serializable the object

Ser

back to summary

pack-priv Ser(byte type, Serializable object)

Creates an instance for serialization.

Parameters

type:byte: the type
object:Serializable: the object

Method Detail

read	back to summary
pack-priv static Serializable read(ObjectInput in) throws IOException, ClassNotFoundException

readExternal back to summary

readExternal	back to summary
public void readExternal(ObjectInput in) throws IOException, ClassNotFoundException Implements java.io.Externalizable.readExternal. Implements the `Externalizable` interface to read the object. Parameters in:ObjectInput the data to read, not null Exceptions IOException: Doc from java.io.Externalizable.readExternal. if I/O errors occur ClassNotFoundException: Doc from java.io.Externalizable.readExternal. If the class for an object being restored cannot be found. Serial data The streamed type and parameters defined by the type's `writeReplace` method are read and passed to the corresponding static factory for the type to create a new instance. That instance is returned as the de-serialized `Ser` object. Duration - `Duration.ofSeconds(seconds, nanos);` Instant - `Instant.ofEpochSecond(seconds, nanos);` LocalDate - `LocalDate.of(year, month, day);` LocalDateTime - `LocalDateTime.of(date, time);` LocalTime - `LocalTime.of(hour, minute, second, nano);` MonthDay - `MonthDay.of(month, day);` OffsetTime - `OffsetTime.of(time, offset);` OffsetDateTime - `OffsetDateTime.of(dateTime, offset);` Period - `Period.of(years, months, days);` Year - `Year.of(year);` YearMonth - `YearMonth.of(year, month);` ZonedDateTime - `ZonedDateTime.ofLenient(dateTime, offset, zone);` ZoneId - `ZoneId.of(id);` ZoneOffset - `(offsetByte == 127 ? ZoneOffset.ofTotalSeconds(in.readInt()) : ZoneOffset.ofTotalSeconds(offsetByte * 900));`

public void readExternal(ObjectInput in) throws IOException, ClassNotFoundException

Implements java.io.Externalizable.readExternal.

Implements the Externalizable interface to read the object.

Parameters

in:ObjectInput: the data to read, not null

Exceptions

IOException:

Doc from java.io.Externalizable.readExternal.

if I/O errors occur

ClassNotFoundException:

Doc from java.io.Externalizable.readExternal.

If the class for an object being restored cannot be found.

Serial data

The streamed type and parameters defined by the type's writeReplace method are read and passed to the corresponding static factory for the type to create a new instance. That instance is returned as the de-serialized Ser object.

Duration - Duration.ofSeconds(seconds, nanos);
Instant - Instant.ofEpochSecond(seconds, nanos);
LocalDate - LocalDate.of(year, month, day);
LocalDateTime - LocalDateTime.of(date, time);
LocalTime - LocalTime.of(hour, minute, second, nano);
MonthDay - MonthDay.of(month, day);
OffsetTime - OffsetTime.of(time, offset);
OffsetDateTime - OffsetDateTime.of(dateTime, offset);
Period - Period.of(years, months, days);
Year - Year.of(year);
YearMonth - YearMonth.of(year, month);
ZonedDateTime - ZonedDateTime.ofLenient(dateTime, offset, zone);
ZoneId - ZoneId.of(id);
ZoneOffset - (offsetByte == 127 ? ZoneOffset.ofTotalSeconds(in.readInt()) : ZoneOffset.ofTotalSeconds(offsetByte * 900));

readInternal	back to summary
private static Serializable readInternal(byte type, ObjectInput in) throws IOException, ClassNotFoundException

readResolve	back to summary
private Object readResolve() Returns the object that will replace this one. Returns:Object the read object, should never be null Annotations @Serial

readResolve

back to summary

private Object readResolve()

Returns the object that will replace this one.

Returns:Object

the read object, should never be null

Annotations

@Serial

writeExternal back to summary

writeExternal	back to summary
public void writeExternal(ObjectOutput out) throws IOException Implements java.io.Externalizable.writeExternal. Implements the `Externalizable` interface to write the object. Parameters out:ObjectOutput the data stream to write to, not null Annotations @Override Exceptions IOException: Doc from java.io.Externalizable.writeExternal. Includes any I/O exceptions that may occur Serial data Each serializable class is mapped to a type that is the first byte in the stream. Refer to each class `writeReplace` serialized form for the value of the type and sequence of values for the type. Duration.writeReplace Instant.writeReplace LocalDate.writeReplace LocalDateTime.writeReplace LocalTime.writeReplace MonthDay.writeReplace OffsetTime.writeReplace OffsetDateTime.writeReplace Period.writeReplace Year.writeReplace YearMonth.writeReplace ZoneId.writeReplace ZoneOffset.writeReplace ZonedDateTime.writeReplace

public void writeExternal(ObjectOutput out) throws IOException

Implements java.io.Externalizable.writeExternal.

Implements the Externalizable interface to write the object.

Parameters

out:ObjectOutput: the data stream to write to, not null

Annotations

@Override

Exceptions

IOException:

Doc from java.io.Externalizable.writeExternal.

Includes any I/O exceptions that may occur

Serial data

Each serializable class is mapped to a type that is the first byte in the stream. Refer to each class writeReplace serialized form for the value of the type and sequence of values for the type.

writeInternal	back to summary
pack-priv static void writeInternal(byte type, Object object, ObjectOutput out) throws IOException

pack-priv final Class Ser

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail