com.fasterxml.jackson.module.jsonSchema

Class JsonSchemaGenerator

java.lang.Object

com.fasterxml.jackson.module.jsonSchema.JsonSchemaGenerator

public class JsonSchemaGenerator
extends Object

Convenience class that wraps JSON Schema generation functionality.

Author:

tsaloranta

Field Summary

Fields

Modifier and Type	Field and Description
protected com.fasterxml.jackson.databind.ObjectMapper	_mapper Deprecated. Since 2.6
protected com.fasterxml.jackson.databind.ObjectWriter	_writer

Constructor Summary

Constructors

Constructor and Description
JsonSchemaGenerator(com.fasterxml.jackson.databind.ObjectMapper mapper)
JsonSchemaGenerator(com.fasterxml.jackson.databind.ObjectMapper mapper, SchemaFactoryWrapper visitor) NOTE: resulting generator is NOT thread-safe, since typically SchemaFactoryWrapper being passed is not thread-safe.
JsonSchemaGenerator(com.fasterxml.jackson.databind.ObjectMapper mapper, WrapperFactory wrapperFactory)
JsonSchemaGenerator(com.fasterxml.jackson.databind.ObjectWriter w)
JsonSchemaGenerator(com.fasterxml.jackson.databind.ObjectWriter w, SchemaFactoryWrapper visitor)
JsonSchemaGenerator(com.fasterxml.jackson.databind.ObjectWriter w, WrapperFactory wrapperFactory)

Method Summary

Modifier and Type	Method and Description
JsonSchema	generateSchema(Class<?> type)
JsonSchema	generateSchema(com.fasterxml.jackson.databind.JavaType type)

Methods inherited from class java.lang.Object

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

Field Detail

_mapper

@Deprecated
protected final com.fasterxml.jackson.databind.ObjectMapper _mapper

Deprecated. Since 2.6

_writer

protected final com.fasterxml.jackson.databind.ObjectWriter _writer

Since:

2.6

Constructor Detail

JsonSchemaGenerator

public JsonSchemaGenerator(com.fasterxml.jackson.databind.ObjectMapper mapper)

JsonSchemaGenerator

public JsonSchemaGenerator(com.fasterxml.jackson.databind.ObjectMapper mapper,
                           WrapperFactory wrapperFactory)

JsonSchemaGenerator

public JsonSchemaGenerator(com.fasterxml.jackson.databind.ObjectMapper mapper,
                           SchemaFactoryWrapper visitor)

NOTE: resulting generator is NOT thread-safe, since typically SchemaFactoryWrapper being passed is not thread-safe.

Since:

2.8.1

JsonSchemaGenerator

public JsonSchemaGenerator(com.fasterxml.jackson.databind.ObjectWriter w)

Since:

2.6

JsonSchemaGenerator

public JsonSchemaGenerator(com.fasterxml.jackson.databind.ObjectWriter w,
                           WrapperFactory wrapperFactory)

Since:

2.6

JsonSchemaGenerator

public JsonSchemaGenerator(com.fasterxml.jackson.databind.ObjectWriter w,
                           SchemaFactoryWrapper visitor)

Since:

2.8.1

Method Detail

generateSchema

public JsonSchema generateSchema(Class<?> type)
                          throws com.fasterxml.jackson.databind.JsonMappingException

Throws:

com.fasterxml.jackson.databind.JsonMappingException

generateSchema

public JsonSchema generateSchema(com.fasterxml.jackson.databind.JavaType type)
                          throws com.fasterxml.jackson.databind.JsonMappingException

Throws:

com.fasterxml.jackson.databind.JsonMappingException