Package org.springframework.data.rest.webmvc.json

Class PersistentEntityToJsonSchemaConverter

java.lang.Object

org.springframework.data.rest.webmvc.json.PersistentEntityToJsonSchemaConverter

All Implemented Interfaces:

org.springframework.core.convert.converter.ConditionalConverter, org.springframework.core.convert.converter.ConditionalGenericConverter, org.springframework.core.convert.converter.GenericConverter

public class PersistentEntityToJsonSchemaConverter
extends Object
implements org.springframework.core.convert.converter.ConditionalGenericConverter

Converter to create JsonSchema instances for PersistentEntitys.

Author:

Jon Brisbin, Oliver Gierke, Greg Turnquist

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PersistentEntityToJsonSchemaConverter.ValueTypeSchemaPropertyCustomizerFactory

Nested classes/interfaces inherited from interface org.springframework.core.convert.converter.GenericConverter

org.springframework.core.convert.converter.GenericConverter.ConvertiblePair

Constructor Summary

Constructors

Constructor	Description
PersistentEntityToJsonSchemaConverter(org.springframework.data.mapping.context.PersistentEntities entities, Associations associations, org.springframework.hateoas.mediatype.MessageResolver resolver, com.fasterxml.jackson.databind.ObjectMapper objectMapper, RepositoryRestConfiguration configuration, PersistentEntityToJsonSchemaConverter.ValueTypeSchemaPropertyCustomizerFactory customizerFactory)	Creates a new PersistentEntityToJsonSchemaConverter for the given PersistentEntities and ResourceMappings.

Method Summary

Modifier and Type	Method	Description
JsonSchema	convert(Class<?> domainType)	Converts the given type into a JsonSchema instance.
JsonSchema	convert(Object source, org.springframework.core.convert.TypeDescriptor sourceType, org.springframework.core.convert.TypeDescriptor targetType)
Set<org.springframework.core.convert.converter.GenericConverter.ConvertiblePair>	getConvertibleTypes()
boolean	matches(org.springframework.core.convert.TypeDescriptor sourceType, org.springframework.core.convert.TypeDescriptor targetType)

Methods inherited from class java.lang.Object

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

Constructor Details

PersistentEntityToJsonSchemaConverter

public PersistentEntityToJsonSchemaConverter(org.springframework.data.mapping.context.PersistentEntities entities,
 Associations associations,
 org.springframework.hateoas.mediatype.MessageResolver resolver,
 com.fasterxml.jackson.databind.ObjectMapper objectMapper,
 RepositoryRestConfiguration configuration,
 PersistentEntityToJsonSchemaConverter.ValueTypeSchemaPropertyCustomizerFactory customizerFactory)

Creates a new PersistentEntityToJsonSchemaConverter for the given PersistentEntities and ResourceMappings.

Parameters:

entities - must not be null.

associations - must not be null.

resolver - must not be null.

objectMapper - must not be null.

configuration - must not be null.

customizerFactory - must not be null.

Method Details

matches

public boolean matches(org.springframework.core.convert.TypeDescriptor sourceType,
 org.springframework.core.convert.TypeDescriptor targetType)

Specified by:

matches in interface org.springframework.core.convert.converter.ConditionalConverter

getConvertibleTypes

public Set<org.springframework.core.convert.converter.GenericConverter.ConvertiblePair> getConvertibleTypes()

Specified by:

getConvertibleTypes in interface org.springframework.core.convert.converter.GenericConverter

convert

public JsonSchema convert(Class<?> domainType)

Converts the given type into a JsonSchema instance.

Parameters:

domainType - must not be null.

Returns:

convert

public JsonSchema convert(Object source,
 org.springframework.core.convert.TypeDescriptor sourceType,
 org.springframework.core.convert.TypeDescriptor targetType)

Specified by:

convert in interface org.springframework.core.convert.converter.GenericConverter