Package org.apache.johnzon.jsonb.polymorphism

Class JsonbPolymorphismHandler

java.lang.Object

org.apache.johnzon.jsonb.polymorphism.JsonbPolymorphismHandler

public class JsonbPolymorphismHandler
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
private Map<Class<?>,JsonbPolymorphismTypeInfo>	typeInfoCache

Constructor Summary

Constructors

Constructor	Description
JsonbPolymorphismHandler()

Method Summary

Modifier and Type	Method	Description
JsonbPolymorphismTypeInfo	getOrCreatePolymorphismTypeInfo(Class<?> clazz)	Looks up a JsonbPolymorphismTypeInfo from the cache or creates it for the given clazz if it supports polymorphism.
Map.Entry<String,String>[]	getPolymorphismPropertiesToSerialize(Class<?> clazz, Collection<String> otherProperties)
Class<?>	getTypeToDeserialize(jakarta.json.JsonObject jsonObject, Class<?> clazz)
boolean	hasPolymorphism(Class<?> clazz)
void	validateJsonbPolymorphismAnnotations(Class<?> classToValidate)	Validates JsonbTypeInfo annotation on clazz and its parents (superclass/interfaces), see validateSubtypeCompatibility(Class), validateOnlyOneParentWithTypeInfo(Class) and validateNoTypeInfoKeyCollision(Class)
protected void	validateNoTypeInfoKeyCollision(Class<?> classToValidate)	Validates that JsonbTypeInfo.key() is only defined once in type hierarchy.
protected void	validateOnlyOneParentWithTypeInfo(Class<?> classToValidate)	Validates that only one parent class (superclass + interfaces) has JsonbTypeInfo annotation
protected void	validateSubtypeCompatibility(Class<?> classToValidate)	Validation fails if any clazz and JsonbSubtype.type() aren't compatible.

Methods inherited from class java.lang.Object

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

Field Detail

typeInfoCache

private final Map<Class<?>,JsonbPolymorphismTypeInfo> typeInfoCache

Constructor Detail

JsonbPolymorphismHandler

public JsonbPolymorphismHandler()

Method Detail

hasPolymorphism

public boolean hasPolymorphism(Class<?> clazz)

getPolymorphismPropertiesToSerialize

public Map.Entry<String,String>[] getPolymorphismPropertiesToSerialize(Class<?> clazz,
                                                                             Collection<String> otherProperties)

getTypeToDeserialize

public Class<?> getTypeToDeserialize(jakarta.json.JsonObject jsonObject,
                                     Class<?> clazz)

getOrCreatePolymorphismTypeInfo

public JsonbPolymorphismTypeInfo getOrCreatePolymorphismTypeInfo(Class<?> clazz)

Looks up a JsonbPolymorphismTypeInfo from the cache or creates it for the given clazz if it supports polymorphism. This is the case if either one of these conditions is truthy:

• clazz has an JsonbTypeInfo annotation
• any class in the type hierarchy of clazz has an JsonbTypeInfo annotation

Parameters:

clazz - Class to inspect

Returns:

JsonbPolymorphismTypeInfo if the class supports polymorphism, null otherwise

validateJsonbPolymorphismAnnotations

public void validateJsonbPolymorphismAnnotations(Class<?> classToValidate)

Validates JsonbTypeInfo annotation on clazz and its parents (superclass/interfaces), see validateSubtypeCompatibility(Class), validateOnlyOneParentWithTypeInfo(Class) and validateNoTypeInfoKeyCollision(Class)

Parameters:

classToValidate - Class to validate

Throws:

jakarta.json.bind.JsonbException - validation failed

validateSubtypeCompatibility

protected void validateSubtypeCompatibility(Class<?> classToValidate)

Validation fails if any clazz and JsonbSubtype.type() aren't compatible.

Parameters:

classToValidate - Class to validate

Throws:

jakarta.json.bind.JsonbException - validation failed

validateOnlyOneParentWithTypeInfo

protected void validateOnlyOneParentWithTypeInfo(Class<?> classToValidate)

Validates that only one parent class (superclass + interfaces) has JsonbTypeInfo annotation

Parameters:

classToValidate - class to validate

Throws:

jakarta.json.bind.JsonbException - validation failed

validateNoTypeInfoKeyCollision

protected void validateNoTypeInfoKeyCollision(Class<?> classToValidate)

Validates that JsonbTypeInfo.key() is only defined once in type hierarchy. Assumes validateOnlyOneParentWithTypeInfo(Class) already passed.

Parameters:

classToValidate - class to validate

Throws:

jakarta.json.bind.JsonbException - validation failed