mirror of
https://github.com/corda/corda.git
synced 2025-02-01 08:48:09 +00:00
Additional comment corrections
This commit is contained in:
parent
c66026e54b
commit
2329254390
@ -19,7 +19,7 @@ annotation class CordaSerializationTransformRenames(vararg val value: CordaSeria
|
||||
/**
|
||||
* This annotation is used to mark a class has having had a property element. It is used by the
|
||||
* AMQP deserializer to allow instances with different versions of the class on their Class Path
|
||||
* to successfully deserialize the object
|
||||
* to successfully deserialize the object.
|
||||
*
|
||||
* NOTE: Renaming of the class itself isn't done with this annotation or, at present, supported
|
||||
* by Corda
|
||||
|
@ -22,7 +22,7 @@ open class ArraySerializer(override val type: Type, factory: SerializerFactory)
|
||||
// for example).
|
||||
//
|
||||
// We *need* to retain knowledge for AMQP deserialization weather that lowest primitive
|
||||
// was boxed or unboxed so just infer it recursively
|
||||
// was boxed or unboxed so just infer it recursively.
|
||||
private fun calcTypeName(type: Type): String =
|
||||
if (type.componentType().isArray()) {
|
||||
val typeName = calcTypeName(type.componentType()); "$typeName[]"
|
||||
|
@ -11,7 +11,7 @@ import kotlin.reflect.jvm.javaType
|
||||
|
||||
/**
|
||||
* Serializer for deserializing objects whose definition has changed since they
|
||||
* were serialised
|
||||
* were serialised.
|
||||
*/
|
||||
class EvolutionSerializer(
|
||||
clazz: Type,
|
||||
@ -40,9 +40,9 @@ class EvolutionSerializer(
|
||||
/**
|
||||
* Unlike the generic deserialization case where we need to locate the primary constructor
|
||||
* for the object (or our best guess) in the case of an object whose structure has changed
|
||||
* since serialisation we need to attempt to locate a constructor that we can use. I.e.
|
||||
* it's parameters match the serialised members and it will initialise any newly added
|
||||
* elements
|
||||
* since serialisation we need to attempt to locate a constructor that we can use. For example,
|
||||
* its parameters match the serialised members and it will initialise any newly added
|
||||
* elements.
|
||||
*
|
||||
* TODO: Type evolution
|
||||
* TODO: rename annotation
|
||||
@ -70,8 +70,8 @@ class EvolutionSerializer(
|
||||
}
|
||||
|
||||
/**
|
||||
* Build a serialization object for deserialisation only of objects serialised
|
||||
* as different versions of a class
|
||||
* Build a serialization object for deserialization only of objects serialised
|
||||
* as different versions of a class.
|
||||
*
|
||||
* @param old is an object holding the schema that represents the object
|
||||
* as it was serialised and the type descriptor of that type
|
||||
@ -119,7 +119,7 @@ class EvolutionSerializer(
|
||||
* to the object list of values we need to map that list, which is ordered per the
|
||||
* constructor of the original state of the object, we need to map the new parameter order
|
||||
* of the current constructor onto that list inserting nulls where new parameters are
|
||||
* encountered
|
||||
* encountered.
|
||||
*
|
||||
* TODO: Object references
|
||||
*/
|
||||
|
@ -62,7 +62,7 @@ fun EnumMap<SchemaFlags, Boolean>.simpleFieldAccess(): Boolean {
|
||||
}
|
||||
|
||||
/**
|
||||
* Represents a concrete object
|
||||
* Represents a concrete object.
|
||||
*/
|
||||
class ClassSchema(
|
||||
name: String,
|
||||
@ -77,7 +77,7 @@ class ClassSchema(
|
||||
|
||||
/**
|
||||
* Represents an interface. Carpented interfaces can be used within [ClassSchema]s
|
||||
* if that class should be implementing that interface
|
||||
* if that class should be implementing that interface.
|
||||
*/
|
||||
class InterfaceSchema(
|
||||
name: String,
|
||||
@ -91,7 +91,7 @@ class InterfaceSchema(
|
||||
}
|
||||
|
||||
/**
|
||||
* Represents an enumerated type
|
||||
* Represents an enumerated type.
|
||||
*/
|
||||
class EnumSchema(
|
||||
name: String,
|
||||
@ -112,7 +112,7 @@ class EnumSchema(
|
||||
|
||||
/**
|
||||
* Factory object used by the serializer when building [Schema]s based
|
||||
* on an AMQP schema
|
||||
* on an AMQP schema.
|
||||
*/
|
||||
object CarpenterSchemaFactory {
|
||||
fun newInstance(
|
||||
|
Loading…
x
Reference in New Issue
Block a user