Package com.kjetland.jackson.jsonSchema

Class JsonSchemaGenerator

  • public class JsonSchemaGenerator
extends java.lang.Object

    • Constructor Summary

      Constructors 
      Constructor Description
      JsonSchemaGenerator​(com.fasterxml.jackson.databind.ObjectMapper rootObjectMapper)
      JSON Schema Generator.
      JsonSchemaGenerator​(com.fasterxml.jackson.databind.ObjectMapper rootObjectMapper, JsonSchemaConfig config)
      JSON Schema Generator.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      com.fasterxml.jackson.databind.JsonNode generateJsonSchema​(com.fasterxml.jackson.databind.JavaType javaType)  
      com.fasterxml.jackson.databind.JsonNode generateJsonSchema​(com.fasterxml.jackson.databind.JavaType javaType, java.lang.String title, java.lang.String description)  
      com.fasterxml.jackson.databind.JsonNode generateJsonSchema​(java.lang.Class<?> clazz)  
      com.fasterxml.jackson.databind.JsonNode generateJsonSchema​(java.lang.Class<?> clazz, java.lang.String title, java.lang.String description)  
      boolean hasNotNullAnnotation​(com.fasterxml.jackson.databind.BeanProperty prop)  
      boolean hasNullableAnnotation​(com.fasterxml.jackson.databind.BeanProperty prop)  

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • JsonSchemaGenerator

        public JsonSchemaGenerator​(com.fasterxml.jackson.databind.ObjectMapper rootObjectMapper)
        JSON Schema Generator.
        Parameters:
        rootObjectMapper - pre-configured ObjectMapper

      • JsonSchemaGenerator

        public JsonSchemaGenerator​(com.fasterxml.jackson.databind.ObjectMapper rootObjectMapper,
                           JsonSchemaConfig config)
        JSON Schema Generator.
        Parameters:
        rootObjectMapper - pre-configured ObjectMapper
        config - by default, JsonSchemaConfig.DEFAULT. Use JsonSchemaConfig.JSON_EDITOR for {@link https://github.com/jdorn/json-editor JSON GUI}.

    • Method Detail

      • generateJsonSchema

        public com.fasterxml.jackson.databind.JsonNode generateJsonSchema​(java.lang.Class<?> clazz)
                                                           throws com.fasterxml.jackson.databind.JsonMappingException
        Throws:
        com.fasterxml.jackson.databind.JsonMappingException

      • generateJsonSchema

        public com.fasterxml.jackson.databind.JsonNode generateJsonSchema​(com.fasterxml.jackson.databind.JavaType javaType)
                                                           throws com.fasterxml.jackson.databind.JsonMappingException
        Throws:
        com.fasterxml.jackson.databind.JsonMappingException

      • generateJsonSchema

        public com.fasterxml.jackson.databind.JsonNode generateJsonSchema​(java.lang.Class<?> clazz,
                                                                  java.lang.String title,
                                                                  java.lang.String description)
                                                           throws com.fasterxml.jackson.databind.JsonMappingException
        Throws:
        com.fasterxml.jackson.databind.JsonMappingException

      • generateJsonSchema

        public com.fasterxml.jackson.databind.JsonNode generateJsonSchema​(com.fasterxml.jackson.databind.JavaType javaType,
                                                                  java.lang.String title,
                                                                  java.lang.String description)
                                                           throws com.fasterxml.jackson.databind.JsonMappingException
        Throws:
        com.fasterxml.jackson.databind.JsonMappingException

      • hasNullableAnnotation

        public boolean hasNullableAnnotation​(com.fasterxml.jackson.databind.BeanProperty prop)

      • hasNotNullAnnotation

        public boolean hasNotNullAnnotation​(com.fasterxml.jackson.databind.BeanProperty prop)