org.jsonschema2pojo

Interface Annotator

All Known Implementing Classes:

AbstractAnnotator, AbstractTypeInfoAwareAnnotator, CompositeAnnotator, GsonAnnotator, Jackson2Annotator, Jsonb1Annotator, Jsonb2Annotator, Moshi1Annotator, NoopAnnotator

public interface Annotator

Adds annotations to generated types for compatibility with a JSON serialization library.

Annotators that need the generation configuration should add a constructor with GenerationConfig arg. Annotators that don't need the configuration need only add a default constructor.

Method Summary

Modifier and Type	Method and Description
void	additionalPropertiesField(com.sun.codemodel.JFieldVar field, com.sun.codemodel.JDefinedClass clazz, String propertyName)
void	anyGetter(com.sun.codemodel.JMethod getter, com.sun.codemodel.JDefinedClass clazz) Add the necessary annotation to mark a Java method as the getter for additional JSON property values that do not match any of the other property names found in the bean.
void	anySetter(com.sun.codemodel.JMethod setter, com.sun.codemodel.JDefinedClass clazz) Add the necessary annotation to mark a Java method as the setter for additional JSON property values that do not match any of the other property names found in the bean.
void	dateField(com.sun.codemodel.JFieldVar field, com.sun.codemodel.JDefinedClass clazz, com.fasterxml.jackson.databind.JsonNode propertyNode) Add the necessary annotations to a date field.
void	dateTimeField(com.sun.codemodel.JFieldVar field, com.sun.codemodel.JDefinedClass clazz, com.fasterxml.jackson.databind.JsonNode propertyNode) Add the necessary annotations to a date-time field.
void	enumConstant(com.sun.codemodel.JDefinedClass _enum, com.sun.codemodel.JEnumConstant constant, String value) Add the necessary annotations to an enum constant.
void	enumCreatorMethod(com.sun.codemodel.JDefinedClass _enum, com.sun.codemodel.JMethod creatorMethod) Add the necessary annotation to mark a static Java method as the creator/factory method which can choose the correct Java enum value for a given JSON value during deserialization.
void	enumValueMethod(com.sun.codemodel.JDefinedClass _enum, com.sun.codemodel.JMethod valueMethod) Add the necessary annotation to mark a Java method as the value method that is used to turn a Java enum value into a JSON value during serialization.
boolean	isAdditionalPropertiesSupported() Indicates whether the annotation style that this annotator uses can support the JSON Schema 'additionalProperties' feature.
boolean	isPolymorphicDeserializationSupported(com.fasterxml.jackson.databind.JsonNode node)
void	propertyField(com.sun.codemodel.JFieldVar field, com.sun.codemodel.JDefinedClass clazz, String propertyName, com.fasterxml.jackson.databind.JsonNode propertyNode) Add the necessary annotation to mark a Java field as a JSON property
void	propertyGetter(com.sun.codemodel.JMethod getter, com.sun.codemodel.JDefinedClass clazz, String propertyName) Add the necessary annotation to mark a Java method as the getter for a JSON property
void	propertyInclusion(com.sun.codemodel.JDefinedClass clazz, com.fasterxml.jackson.databind.JsonNode schema) Add the necessary annotation to cause only non-null values to be included during serialization.
void	propertyOrder(com.sun.codemodel.JDefinedClass clazz, com.fasterxml.jackson.databind.JsonNode propertiesNode) Add the necessary annotation to dictate correct property order during serialization
void	propertySetter(com.sun.codemodel.JMethod setter, com.sun.codemodel.JDefinedClass clazz, String propertyName) Add the necessary annotation to mark a Java method as the setter for a JSON property
void	timeField(com.sun.codemodel.JFieldVar field, com.sun.codemodel.JDefinedClass clazz, com.fasterxml.jackson.databind.JsonNode propertyNode) Add the necessary annotations to a time field.
void	typeInfo(com.sun.codemodel.JDefinedClass clazz, com.fasterxml.jackson.databind.JsonNode schema) Add the necessary annotation to dictate correct type information during serialization and deserialization; often required with polymorphic types.

Method Detail

typeInfo

void typeInfo(com.sun.codemodel.JDefinedClass clazz,
              com.fasterxml.jackson.databind.JsonNode schema)

Add the necessary annotation to dictate correct type information during serialization and deserialization; often required with polymorphic types.

Parameters:

clazz - a generated pojo class, that is serialized to JSON

schema - the object schema associated with this clazz

See Also:

Jackson Docs - Polymorphic Type Handling

propertyOrder

void propertyOrder(com.sun.codemodel.JDefinedClass clazz,
                   com.fasterxml.jackson.databind.JsonNode propertiesNode)

Add the necessary annotation to dictate correct property order during serialization

Parameters:

clazz - a generated pojo class, that is serialized to JSON

propertiesNode - the properties to be ordered

propertyInclusion

void propertyInclusion(com.sun.codemodel.JDefinedClass clazz,
                       com.fasterxml.jackson.databind.JsonNode schema)

Add the necessary annotation to cause only non-null values to be included during serialization.

Parameters:

clazz - a generated pojo class, that is serialized to JSON

schema - the object schema associated with this clazz

propertyField

void propertyField(com.sun.codemodel.JFieldVar field,
                   com.sun.codemodel.JDefinedClass clazz,
                   String propertyName,
                   com.fasterxml.jackson.databind.JsonNode propertyNode)

Add the necessary annotation to mark a Java field as a JSON property

Parameters:

field - the field that contains data that will be serialized

clazz - the owner of the field (class to which the field belongs)

propertyName - the name of the JSON property that this field represents

propertyNode - the schema node defining this property

propertyGetter

void propertyGetter(com.sun.codemodel.JMethod getter,
                    com.sun.codemodel.JDefinedClass clazz,
                    String propertyName)

Add the necessary annotation to mark a Java method as the getter for a JSON property

Parameters:

getter - the method that will be used to get the value of the given JSON property

propertyName - the name of the JSON property that this getter gets

propertySetter

void propertySetter(com.sun.codemodel.JMethod setter,
                    com.sun.codemodel.JDefinedClass clazz,
                    String propertyName)

Add the necessary annotation to mark a Java method as the setter for a JSON property

Parameters:

setter - the method that will be used to set the value of the given JSON property

propertyName - the name of the JSON property that this setter sets

anyGetter

void anyGetter(com.sun.codemodel.JMethod getter,
               com.sun.codemodel.JDefinedClass clazz)

Add the necessary annotation to mark a Java method as the getter for additional JSON property values that do not match any of the other property names found in the bean.

Parameters:

getter - the method that will be used to get the values of additional properties

anySetter

void anySetter(com.sun.codemodel.JMethod setter,
               com.sun.codemodel.JDefinedClass clazz)

Add the necessary annotation to mark a Java method as the setter for additional JSON property values that do not match any of the other property names found in the bean.

Parameters:

setter - the method that will be used to set the values of additional properties

enumCreatorMethod

void enumCreatorMethod(com.sun.codemodel.JDefinedClass _enum,
                       com.sun.codemodel.JMethod creatorMethod)

Add the necessary annotation to mark a static Java method as the creator/factory method which can choose the correct Java enum value for a given JSON value during deserialization.

Parameters:

creatorMethod - the method that can create a Java enum value from a JSON value

enumValueMethod

void enumValueMethod(com.sun.codemodel.JDefinedClass _enum,
                     com.sun.codemodel.JMethod valueMethod)

Add the necessary annotation to mark a Java method as the value method that is used to turn a Java enum value into a JSON value during serialization.

Parameters:

valueMethod - the enum instance method that can create a JSON value during serialization

enumConstant

void enumConstant(com.sun.codemodel.JDefinedClass _enum,
                  com.sun.codemodel.JEnumConstant constant,
                  String value)

Add the necessary annotations to an enum constant. For instance, to force the the given value to be used when serializing.

isAdditionalPropertiesSupported

boolean isAdditionalPropertiesSupported()

Indicates whether the annotation style that this annotator uses can support the JSON Schema 'additionalProperties' feature. In other words, can the deserializer associated with this annotation style gather unexpected, additional json properties and does it expect to include them somewhere in the target Java instance.

Jackson is able to use it's JsonAnyGetter and JsonAnySetter features for this purpose, hence for Jackson annotators, this method will return true. Gson does not support 'additional' property values (they are silently discarded at deserialization time), hence for Gson annotators, this method would return false. Moshi 1.x behaves similar to Gson and therefore returns false.

Returns:

Whether this annotator has any way to support 'additional properties'.

dateTimeField

void dateTimeField(com.sun.codemodel.JFieldVar field,
                   com.sun.codemodel.JDefinedClass clazz,
                   com.fasterxml.jackson.databind.JsonNode propertyNode)

Add the necessary annotations to a date-time field. For instance, to format the date-time in the expected style.

Parameters:

field - the field that contains data that will be serialized

propertyNode - the schema node defining this property

dateField

void dateField(com.sun.codemodel.JFieldVar field,
               com.sun.codemodel.JDefinedClass clazz,
               com.fasterxml.jackson.databind.JsonNode propertyNode)

Add the necessary annotations to a date field. For instance, to format the date in the expected style.

Parameters:

field - the field that contains data that will be serialized

propertyNode - the schema node defining this property

timeField

void timeField(com.sun.codemodel.JFieldVar field,
               com.sun.codemodel.JDefinedClass clazz,
               com.fasterxml.jackson.databind.JsonNode propertyNode)

Add the necessary annotations to a time field. For instance, to format the time in the expected style.

Parameters:

field - the field that contains data that will be serialized

propertyNode - the schema node defining this property

additionalPropertiesField

void additionalPropertiesField(com.sun.codemodel.JFieldVar field,
                               com.sun.codemodel.JDefinedClass clazz,
                               String propertyName)

isPolymorphicDeserializationSupported

boolean isPolymorphicDeserializationSupported(com.fasterxml.jackson.databind.JsonNode node)