org.springframework.data.rest.webmvc.json

Class PersistentEntityToJsonSchemaConverter

java.lang.Object

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

All Implemented Interfaces:

ConditionalConverter, ConditionalGenericConverter, GenericConverter

public class PersistentEntityToJsonSchemaConverter
extends Object
implements ConditionalGenericConverter

Converter to create JsonSchema instances for PersistentEntitys.

Author:

Jon Brisbin, Oliver Gierke, Greg Turnquist

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PersistentEntityToJsonSchemaConverter.ValueTypeSchemaPropertyCustomizerFactory

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

GenericConverter.ConvertiblePair

Constructor Summary

Constructors

Constructor and Description

PersistentEntityToJsonSchemaConverter(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 and Description
JsonSchema	convert(Class<?> domainType) Converts the given type into a JsonSchema instance.
JsonSchema	convert(Object source, TypeDescriptor sourceType, TypeDescriptor targetType)
Set<GenericConverter.ConvertiblePair>	getConvertibleTypes()
boolean	matches(TypeDescriptor sourceType, TypeDescriptor targetType)

Methods inherited from class java.lang.Object

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

Constructor Detail

PersistentEntityToJsonSchemaConverter

public PersistentEntityToJsonSchemaConverter(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 Detail

matches

public boolean matches(TypeDescriptor sourceType,
                       TypeDescriptor targetType)

Specified by:

matches in interface ConditionalConverter

getConvertibleTypes

public Set<GenericConverter.ConvertiblePair> getConvertibleTypes()

Specified by:

getConvertibleTypes in interface 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,
                          TypeDescriptor sourceType,
                          TypeDescriptor targetType)

Specified by:

convert in interface GenericConverter