org.jsonschema2pojo

Class AbstractAnnotator

java.lang.Object

org.jsonschema2pojo.AbstractAnnotator

All Implemented Interfaces:

Annotator

Direct Known Subclasses:

AbstractTypeInfoAwareAnnotator, GsonAnnotator, Jsonb1Annotator, Jsonb2Annotator, Moshi1Annotator, NoopAnnotator

public abstract class AbstractAnnotator
extends Object
implements Annotator

A default implementation of the Annotator interface that makes it easier to plug in different Annotator implementations.

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.

Constructor Summary

Constructors

Constructor and Description
AbstractAnnotator()
AbstractAnnotator(GenerationConfig generationConfig)

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 node) 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 node) 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.
GenerationConfig	getGenerationConfig()
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 node) 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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractAnnotator

public AbstractAnnotator()

AbstractAnnotator

public AbstractAnnotator(GenerationConfig generationConfig)

Method Detail

typeInfo

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

Description copied from interface: Annotator

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

Specified by:

typeInfo in interface Annotator

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

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

Description copied from interface: Annotator

Add the necessary annotation to dictate correct property order during serialization

Specified by:

propertyOrder in interface Annotator

Parameters:

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

propertiesNode - the properties to be ordered

propertyInclusion

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

Description copied from interface: Annotator

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

Specified by:

propertyInclusion in interface Annotator

Parameters:

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

schema - the object schema associated with this clazz

propertyField

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

Description copied from interface: Annotator

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

Specified by:

propertyField in interface Annotator

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

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

Description copied from interface: Annotator

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

Specified by:

propertyGetter in interface Annotator

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

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

Description copied from interface: Annotator

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

Specified by:

propertySetter in interface Annotator

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

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

Description copied from interface: Annotator

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.

Specified by:

anyGetter in interface Annotator

Parameters:

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

anySetter

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

Description copied from interface: Annotator

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.

Specified by:

anySetter in interface Annotator

Parameters:

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

enumCreatorMethod

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

Description copied from interface: Annotator

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.

Specified by:

enumCreatorMethod in interface Annotator

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

enumValueMethod

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

Description copied from interface: Annotator

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.

Specified by:

enumValueMethod in interface Annotator

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

enumConstant

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

Description copied from interface: Annotator

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

Specified by:

enumConstant in interface Annotator

isAdditionalPropertiesSupported

public boolean isAdditionalPropertiesSupported()

Description copied from interface: Annotator

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.

Specified by:

isAdditionalPropertiesSupported in interface Annotator

Returns:

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

additionalPropertiesField

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

Specified by:

additionalPropertiesField in interface Annotator

isPolymorphicDeserializationSupported

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

Specified by:

isPolymorphicDeserializationSupported in interface Annotator

getGenerationConfig

public GenerationConfig getGenerationConfig()

dateField

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

Description copied from interface: Annotator

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

Specified by:

dateField in interface Annotator

Parameters:

field - the field that contains data that will be serialized

node - the schema node defining this property

timeField

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

Description copied from interface: Annotator

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

Specified by:

timeField in interface Annotator

Parameters:

field - the field that contains data that will be serialized

node - the schema node defining this property

dateTimeField

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

Description copied from interface: Annotator

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

Specified by:

dateTimeField in interface Annotator

Parameters:

field - the field that contains data that will be serialized

node - the schema node defining this property