Changes between Version 28 and Version 29 of pyson

Timestamp:

05/18/21 08:37:28 (4 years ago)

Author:

wouter

Comment:

--

pyson

@@ -42 +42 @@
 * Create a json dict, with keys the arguments of the __init__ function of the object and the value the serialized value returned by the getter (also considering @JsonGetter)
 * If the object is an instance of a class with @JsonSubtypes, add/wrap the json with class info according to the @JsonTypeInfo 
+
+== Annotations
+
+The following annotations are available 
+
+=== {{{@JsonGetter}}}
+Added to a function definition in a class. Takes "value" as argument, containing the name of a json field (which is also used as argument in the constructor). 
+
+Indicates that that function is to be used to get the value of the given json field.
+
+=== {{{@JsonSubTypes}}}
+Added to a class definition. Takes a list of strings as argument. Each string is the full class path to another class. 
+
+Indicates that that other class is a sub-class of the annotated class. The other class can be used for deserialization as well. 
+
+If this is used, the @JsonTypeInfo must also be provided.
+
+=== {{{@JsonTypeInfo}}}
+Added to a class definition. Contains "Id" and "As" values. 
+
+Indicates that the class name/id should be included in the json code.  This is especially useful in combination with {{{@JsonSubTypes.}}}
+
+The "Id" value can have the value NONE, NAME, CLASS. We recommend to use NAME,
+||NONE|| Do not include class id at all. Do not use this with @JsonTypeInfo. Only included because it was availale in Jackson||
+||NAME||Use the name of the class to refer to the class. All classes referred must have different name (not two the same names with different classpath).||
+||CLASS||Use the full.class.path to refer to the class. ||
+
+We recommend NAME, because it is shorter and gives more readable json, and gives you flexibility to move around the actual classes if needed without breaking compabibility with existing json files||
+
+
+Indicates how to include the class name is included in/extracted from the json. 
+
+====
+
+=== Inheritance of annotations
+The usual inheritance mechanism of python applies also to the annotatinos. 
+
+
 
 == Examples