org.jsonschema2pojo

Class GsonAnnotator

java.lang.Object

org.jsonschema2pojo.AbstractAnnotator

org.jsonschema2pojo.GsonAnnotator

All Implemented Interfaces:

Annotator

public class GsonAnnotator
extends AbstractAnnotator

Annotates generated Java types using Gson. The annotations used here are most useful when the JSON fields have characters (like underscores) that are poorly suited for beans. By using the SerializedName annotation, we are able to preserve the original format. Use this in conjunction with GenerationConfig.getPropertyWordDelimiters() to filter out underscores or other unwanted delimiters but still marshal/unmarshal the same content.

See Also:

https://code.google.com/p/google-gson/

Constructor Summary

Constructors

Constructor and Description
GsonAnnotator(GenerationConfig generationConfig)

Method Summary

Modifier and Type	Method and Description
void	enumConstant(com.sun.codemodel.JDefinedClass _enum, com.sun.codemodel.JEnumConstant constant, String value) Add the necessary annotations to an enum constant.
boolean	isAdditionalPropertiesSupported() Indicates whether the annotation style that this annotator uses can support the JSON Schema 'additionalProperties' feature.
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

Methods inherited from class org.jsonschema2pojo.AbstractAnnotator

additionalPropertiesField, anyGetter, anySetter, dateField, dateTimeField, enumCreatorMethod, enumValueMethod, getGenerationConfig, isPolymorphicDeserializationSupported, propertyGetter, propertyInclusion, propertyOrder, propertySetter, timeField, typeInfo

Methods inherited from class java.lang.Object

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

Constructor Detail

GsonAnnotator

public GsonAnnotator(GenerationConfig generationConfig)

Method Detail

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

Overrides:

propertyField in class AbstractAnnotator

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

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

Overrides:

enumConstant in class AbstractAnnotator

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

Overrides:

isAdditionalPropertiesSupported in class AbstractAnnotator

Returns:

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