public interface Evolvable
The Evolvable interface is designed to support the evolution of classes by the addition of data. Removal of data cannot be safely accomplished as long as a previous version of the class exists that relies on that data. Modifications to the structure or semantics of data from previous versions likewise cannot be safely accomplished as long as a previous version of the class exists that relies on the previous structure or semantics of the data.
When an Evolvable object is deserialized, it retains any unknown data that has been added to newer versions of the class, and the version identifier for that data format. When the Evolvable object is subsequently serialized, it includes both that version identifier and the unknown future data.
When an Evolvable object is deserialized from a data stream whose version identifier indicates an older version, it must default and/or calculate the values for any data fields and properties that have been added since that older version. When the Evolvable object is subsequently serialized, it includes its own version identifier and all of its data. Note that there will be no unknown future data in this case; future data can only exist when the version of the data stream is newer than the version of the Evolvable class.
Modifier and Type | Method and Description |
---|---|
int |
getDataVersion()
Obtain the version associated with the data stream from which this object was deserialized.
|
Binary |
getFutureData()
Return all the unknown remainder of the data stream from which this object was deserialized.
|
int |
getImplVersion()
Determine the serialization version supported by the implementing class.
|
void |
setDataVersion(int nVersion)
Set the version associated with the data stream with which this object is being deserialized.
|
void |
setFutureData(Binary binFuture)
Store the unknown remainder of the data stream from which this object is being deserialized.
|
int getImplVersion()
int getDataVersion()
void setDataVersion(int nVersion)
nVersion
- the version of the data in the data stream that will be used to deserialize this object; greater than or equal to zeroIllegalArgumentException
- if the specified version is negativeIllegalStateException
- if the object is not in a state in which the version can be set, for example outside of deserializationBinary getFutureData()
void setFutureData(Binary binFuture)
binFuture
- future data in binary formIllegalStateException
- if the object is not in a state in which the data can be set, for example outside of deserialization