manifold.api.json.codegen.schema

Interface IJsonFormatTypeResolver

All Superinterfaces:

ICoercionProvider

All Known Implementing Classes:

BigNumberFormatResolver, BinaryFormatResolver, DefaultFormatResolver

public interface IJsonFormatTypeResolver
extends ICoercionProvider

Implement this interface as a service provider. Provide a mapping from a JSON Schema "format" to a Java type. For instance,

the "date-time" format maps to LocalDateTime

See DefaultFormatResolver to see how "date-time" and other formats are mapped to a set of Java types.

Register one or more of your IJsonFormatTypeResolver implementations in a file named:

META-INF/services/manifold.api.json.codegen.schema.IJsonFormatTypeResolver

This file contains the fully qualified names of your implementations, one per line e.g.,

 com.example.FooFormatTypeResolver
 com.example.BarFormatTypeResolver
 

Method Summary

Modifier and Type	Method and Description
Set<String>	getFormats() A list of one or more format names such as "date-time", "date", "time" to be referenced in Json Schema "format" types.
JsonFormatType	resolveType(String format) Given a JSON Schema "format" value such as "date-time" provide an JsonFormatType to correspond with the format.

Methods inherited from interface manifold.ext.api.ICoercionProvider

coerce, toBindingValue

Method Detail

getFormats

Set<String> getFormats()

A list of one or more format names such as "date-time", "date", "time" to be referenced in Json Schema "format" types.

Returns:

resolveType

JsonFormatType resolveType(String format)

Given a JSON Schema "format" value such as "date-time" provide an JsonFormatType to correspond with the format.

Parameters:

format - The JSON Schema "format" value such as "date-time".

Returns:

An instance of JsonFormatType to correspond with the format or null if unresolved.