Package step.handlers.javahandler.jsonschema

Class DefaultJsonSchemaFieldProcessor

java.lang.Object

step.handlers.javahandler.jsonschema.DefaultJsonSchemaFieldProcessor

All Implemented Interfaces:

JsonSchemaFieldProcessor

public class DefaultJsonSchemaFieldProcessor
extends Object
implements JsonSchemaFieldProcessor

Constructor Summary

Constructors

Constructor	Description
DefaultJsonSchemaFieldProcessor(JsonSchemaCreator jsonSchemaCreator, jakarta.json.spi.JsonProvider jsonProvider)

Method Summary

Modifier and Type	Method	Description
boolean	applyCustomProcessing(Class<?> objectClass, Field field, FieldMetadata fieldMetadata, jakarta.json.JsonObjectBuilder propertiesBuilder, List<String> requiredPropertiesOutput)	Applies non-default JSON schema preparation logic for the field
void	processNestedFields(jakarta.json.JsonObjectBuilder propertyParamsBuilder, Class<?> clazz)

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultJsonSchemaFieldProcessor

public DefaultJsonSchemaFieldProcessor(JsonSchemaCreator jsonSchemaCreator,
                                       jakarta.json.spi.JsonProvider jsonProvider)

Method Detail

applyCustomProcessing

public boolean applyCustomProcessing(Class<?> objectClass,
                                     Field field,
                                     FieldMetadata fieldMetadata,
                                     jakarta.json.JsonObjectBuilder propertiesBuilder,
                                     List<String> requiredPropertiesOutput)
                              throws JsonSchemaPreparationException

Description copied from interface: JsonSchemaFieldProcessor

Applies non-default JSON schema preparation logic for the field

Specified by:

applyCustomProcessing in interface JsonSchemaFieldProcessor

Parameters:

objectClass - the field owner class

field - the target field

fieldMetadata - field metadata containing the information about field name, default value etc

propertiesBuilder - json object builder to be filled with field data

requiredPropertiesOutput - for required fields the field name should be added

Returns:

true - custom processing is applied, false - custom processing is not required

Throws:

JsonSchemaPreparationException

processNestedFields

public void processNestedFields(jakarta.json.JsonObjectBuilder propertyParamsBuilder,
                                Class<?> clazz)
                         throws JsonSchemaPreparationException

Throws:

JsonSchemaPreparationException