Class JsonSchemaGenerator

java.lang.Object

com.fasterxml.jackson.module.jsonSchema.JsonSchemaGenerator

public class JsonSchemaGenerator
extends Object

Convenience class that wraps JSON Schema generation functionality.

Field Summary

Fields

Modifier and Type	Field	Description
protected final com.fasterxml.jackson.databind.ObjectMapper	_mapper	Deprecated. Since 2.6
private final SchemaFactoryWrapper	_visitor
private final WrapperFactory	_wrapperFactory
protected final com.fasterxml.jackson.databind.ObjectWriter	_writer

Constructor Summary

Constructors

Constructor	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	Description
JsonSchema	generateSchema(com.fasterxml.jackson.databind.JavaType type)
JsonSchema	generateSchema(Class<?> type)

Methods inherited from class Object

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

Field Details

_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

_wrapperFactory

private final WrapperFactory _wrapperFactory

_visitor

private final SchemaFactoryWrapper _visitor

Since:

2.8.1

Constructor Details

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 Details

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