com.github.reinert.jjschema

Class JsonSchemaGenerator

java.lang.Object

com.github.reinert.jjschema.JsonSchemaGenerator

Direct Known Subclasses:

HyperSchemaGeneratorV4, JsonSchemaGeneratorV4

public abstract class JsonSchemaGenerator
extends Object

Generates JSON schema from Java Types

Author:

reinert

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	JsonSchemaGenerator()

Method Summary

Methods

Modifier and Type	Method and Description
protected <T> com.fasterxml.jackson.databind.node.ObjectNode	checkAndProcessType(Class<T> type, com.fasterxml.jackson.databind.node.ObjectNode schema) Checks whether the type is SimpleType (mapped by SimpleTypeMappings), Collection or Iterable (for mapping arrays), Void type (returning null), or custom Class (for mapping objects).
protected com.fasterxml.jackson.databind.node.ObjectNode	createInstance()
protected com.fasterxml.jackson.databind.node.ObjectNode	generatePropertySchema(Method method, Field field)
<T> com.fasterxml.jackson.databind.node.ObjectNode	generateSchema(Class<T> type)
boolean	isAutoPutVersion() Checks if this generator should put the $schema attribute at the root schema.
protected com.fasterxml.jackson.databind.node.ObjectNode	mergeSchema(com.fasterxml.jackson.databind.node.ObjectNode parent, com.fasterxml.jackson.databind.node.ObjectNode child, boolean overwriteChildProperties) Merges two schemas.
protected <T> com.fasterxml.jackson.databind.node.ObjectNode	mergeWithParent(Class<T> type, com.fasterxml.jackson.databind.node.ObjectNode schema) If the Java Type inherits from other Java Type then Object, then it is assumed to inherit from other custom type.
protected void	overwriteProperty(com.fasterxml.jackson.databind.node.ObjectNode parent, com.fasterxml.jackson.databind.node.ObjectNode child, String propertyName)
protected <T> com.fasterxml.jackson.databind.node.ObjectNode	processCustomType(Class<T> type, com.fasterxml.jackson.databind.node.ObjectNode schema) Generates the schema of custom java types
protected <T> void	processProperties(Class<T> type, com.fasterxml.jackson.databind.node.ObjectNode schema)
protected <T> void	processRootAttributes(Class<T> type, com.fasterxml.jackson.databind.node.ObjectNode schema)
protected abstract void	processSchemaProperty(com.fasterxml.jackson.databind.node.ObjectNode schema, Attributes props) Reads Attributes annotation and put its values into the generating schema.
JsonSchemaGenerator	setAutoPutVersion(boolean autoPutVersion) If true, this parameter says that the $schema atribute should be put at the root of all schemas generated by this SchemaGenerator instace.

Methods inherited from class java.lang.Object

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

Constructor Detail

JsonSchemaGenerator

protected JsonSchemaGenerator()

Method Detail

processSchemaProperty

protected abstract void processSchemaProperty(com.fasterxml.jackson.databind.node.ObjectNode schema,
                         Attributes props)

Reads Attributes annotation and put its values into the generating schema. Usually, some verification is done for not putting the default values.

Parameters:

schema -

props -

createInstance

protected com.fasterxml.jackson.databind.node.ObjectNode createInstance()

isAutoPutVersion

public boolean isAutoPutVersion()

Checks if this generator should put the $schema attribute at the root schema.

Returns:

true if it should put the $schema attribute, false otherwise

setAutoPutVersion

public JsonSchemaGenerator setAutoPutVersion(boolean autoPutVersion)

If true, this parameter says that the $schema atribute should be put at the root of all schemas generated by this SchemaGenerator instace.

Parameters:

autoPutVersion -

Returns:

the actual instance of JsonSchemaGenerator

generateSchema

public <T> com.fasterxml.jackson.databind.node.ObjectNode generateSchema(Class<T> type)

checkAndProcessType

protected <T> com.fasterxml.jackson.databind.node.ObjectNode checkAndProcessType(Class<T> type,
                                                                     com.fasterxml.jackson.databind.node.ObjectNode schema)

Checks whether the type is SimpleType (mapped by SimpleTypeMappings), Collection or Iterable (for mapping arrays), Void type (returning null), or custom Class (for mapping objects).

Parameters:

type -

schema -

Returns:

the full schema represented as an ObjectNode.

processCustomType

protected <T> com.fasterxml.jackson.databind.node.ObjectNode processCustomType(Class<T> type,
                                                                   com.fasterxml.jackson.databind.node.ObjectNode schema)

Generates the schema of custom java types

Parameters:

type -

schema -

Returns:

the full schema of custom java types

generatePropertySchema

protected com.fasterxml.jackson.databind.node.ObjectNode generatePropertySchema(Method method,
                                                                    Field field)

processRootAttributes

protected <T> void processRootAttributes(Class<T> type,
                             com.fasterxml.jackson.databind.node.ObjectNode schema)

processProperties

protected <T> void processProperties(Class<T> type,
                         com.fasterxml.jackson.databind.node.ObjectNode schema)

mergeWithParent

protected <T> com.fasterxml.jackson.databind.node.ObjectNode mergeWithParent(Class<T> type,
                                                                 com.fasterxml.jackson.databind.node.ObjectNode schema)

If the Java Type inherits from other Java Type then Object, then it is assumed to inherit from other custom type. In this case, the parent class is processed as well and merged with the child class, having the child a high priority when both have same attributes filled.

Parameters:

type -

schema -

Returns:

The actual schema merged with its parent schema (if it exists)

mergeSchema

protected com.fasterxml.jackson.databind.node.ObjectNode mergeSchema(com.fasterxml.jackson.databind.node.ObjectNode parent,
                                                         com.fasterxml.jackson.databind.node.ObjectNode child,
                                                         boolean overwriteChildProperties)

Merges two schemas.

Parameters:

parent - A parent schema considering inheritance

child - A child schema considering inheritance

overwriteChildProperties - A boolean to check whether properties (from parent or child) must have higher priority

Returns:

The tow schemas merged

overwriteProperty

protected void overwriteProperty(com.fasterxml.jackson.databind.node.ObjectNode parent,
                     com.fasterxml.jackson.databind.node.ObjectNode child,
                     String propertyName)