Class JsonSchemaGenerator
java.lang.Object
com.fasterxml.jackson.module.jsonSchema.JsonSchemaGenerator
Convenience class that wraps JSON Schema generation functionality.
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected final com.fasterxml.jackson.databind.ObjectMapper
Deprecated.Since 2.6private final SchemaFactoryWrapper
private final WrapperFactory
protected final com.fasterxml.jackson.databind.ObjectWriter
-
Constructor Summary
ConstructorsConstructorDescriptionJsonSchemaGenerator
(com.fasterxml.jackson.databind.ObjectMapper mapper) JsonSchemaGenerator
(com.fasterxml.jackson.databind.ObjectMapper mapper, SchemaFactoryWrapper visitor) NOTE: resulting generator is NOT thread-safe, since typicallySchemaFactoryWrapper
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 TypeMethodDescriptiongenerateSchema
(com.fasterxml.jackson.databind.JavaType type) generateSchema
(Class<?> type)
-
Field Details
-
_mapper
Deprecated.Since 2.6 -
_writer
protected final com.fasterxml.jackson.databind.ObjectWriter _writer- Since:
- 2.6
-
_wrapperFactory
-
_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 typicallySchemaFactoryWrapper
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
-