Class AnnotationJsonSerializer

java.lang.Object

net.jacobpeterson.jet.openapiannotationsplugin.gson.serializer.annotation.AnnotationJsonSerializer

All Implemented Interfaces:

com.google.gson.JsonSerializer<Annotation>

@NullMarked
public class AnnotationJsonSerializer
extends Object
implements com.google.gson.JsonSerializer<Annotation>

AnnotationJsonSerializer is a JsonSerializer for Annotation that uses reflection to invoke the Class.getDeclaredMethods() of the Annotation.annotationType() and uses reflection to handle SerializedName, AnnotationJsonIgnore, AnnotationJsonSerializeEmptyArray, AnnotationJsonObjectInline, AnnotationArrayIsNullableValue, AnnotationJsonRawString, AnnotationArrayIsMap, and AnnotationArrayIsMapKey.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ANNOTATION_METHOD_CLASS_NAME_DELIMITER	The delimiter as described by CURRENT_ANNOTATION_METHOD: "#"
static final ThreadLocal<@Nullable Method>	CURRENT_ANNOTATION_METHOD	The ThreadLocal Method of the current Annotation being serialized.
static final String	JSON_KEY_CLASS_TRACER	The JSON key name for getTracerClasses(): "__AnnotationJsonSerializer.JSON_KEY_CLASS_TRACER__"
static final String	JSON_KEY_METHOD_TRACER	The JSON key name for CURRENT_ANNOTATION_METHOD: "__AnnotationJsonSerializer.JSON_KEY_METHOD_TRACER__"

Constructor Summary

Constructors

Constructor	Description
AnnotationJsonSerializer(Set<Class<? extends Annotation>> tracerClasses)	Creates a new AnnotationJsonSerializer instance.

Method Summary

Modifier and Type	Method	Description
Set<Class<? extends Annotation>>	getTracerClasses()	The Set of Annotation Classes to insert a JSON_KEY_CLASS_TRACER property into the serialized JsonObject with the value of Class.getCanonicalName().
static void	removeTracers(com.google.gson.JsonObject jsonObject)	Removes all JSON_KEY_CLASS_TRACER and JSON_KEY_METHOD_TRACER keys from the given JsonObject.
com.google.gson.JsonElement	serialize(Annotation src, Type typeOfSrc, com.google.gson.JsonSerializationContext context)

Methods inherited from class Object

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

Field Details

JSON_KEY_CLASS_TRACER

public static final String JSON_KEY_CLASS_TRACER

The JSON key name for getTracerClasses(): "__AnnotationJsonSerializer.JSON_KEY_CLASS_TRACER__"

See Also:

• Constant Field Values

JSON_KEY_METHOD_TRACER

public static final String JSON_KEY_METHOD_TRACER

The JSON key name for CURRENT_ANNOTATION_METHOD: "__AnnotationJsonSerializer.JSON_KEY_METHOD_TRACER__"

See Also:

• Constant Field Values

ANNOTATION_METHOD_CLASS_NAME_DELIMITER

public static final String ANNOTATION_METHOD_CLASS_NAME_DELIMITER

The delimiter as described by CURRENT_ANNOTATION_METHOD: "#"

See Also:

• Constant Field Values

CURRENT_ANNOTATION_METHOD

public static final ThreadLocal<@Nullable Method> CURRENT_ANNOTATION_METHOD

The ThreadLocal Method of the current Annotation being serialized. If set and the Annotation.annotationType() being serialized is in getTracerClasses(), then a property with the key of JSON_KEY_METHOD_TRACER and a value of the concatenation of Class.getCanonicalName(), ANNOTATION_METHOD_CLASS_NAME_DELIMITER, and Method.getName() is added to the serialized JsonObject.

Constructor Details

AnnotationJsonSerializer

public AnnotationJsonSerializer(Set<Class<? extends Annotation>> tracerClasses)

Creates a new AnnotationJsonSerializer instance.

Parameters:

tracerClasses - The Set of Annotation Classes to insert a JSON_KEY_CLASS_TRACER property into the serialized JsonObject with the value of Class.getCanonicalName().

Method Details

removeTracers

public static void removeTracers(com.google.gson.JsonObject jsonObject)

Removes all JSON_KEY_CLASS_TRACER and JSON_KEY_METHOD_TRACER keys from the given JsonObject.

Parameters:

jsonObject - the JsonObject

serialize

public com.google.gson.JsonElement serialize(Annotation src,
 Type typeOfSrc,
 com.google.gson.JsonSerializationContext context)

Specified by:

serialize in interface com.google.gson.JsonSerializer<Annotation>

getTracerClasses

public Set<Class<? extends Annotation>> getTracerClasses()

The Set of Annotation Classes to insert a JSON_KEY_CLASS_TRACER property into the serialized JsonObject with the value of Class.getCanonicalName().