com.github.reinert.jjschema

Class HyperSchemaGeneratorV4

java.lang.Object

com.github.reinert.jjschema.JsonSchemaGenerator

com.github.reinert.jjschema.HyperSchemaGeneratorV4

public class HyperSchemaGeneratorV4
extends JsonSchemaGenerator

A Hyper-Schema generator from JSR311 specification (Java RESTful) annotated classes. It generates an hyper-schema with correct links, targets, mediaType, and other properties. Please consider looking at JavaRESTfulTest for an example of how to use it.

Author:

Danilo

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	HyperSchemaGeneratorV4(JsonSchemaGenerator jsonSchemaGenerator)

Method Summary

Modifier and Type	Method and Description
<T> com.fasterxml.jackson.databind.node.ObjectNode	generateSchema(Class<T> type)
protected void	processSchemaProperty(com.fasterxml.jackson.databind.node.ObjectNode schema, Attributes props) Reads Attributes annotation and put its values into the generating schema.

Methods inherited from class com.github.reinert.jjschema.JsonSchemaGenerator

checkAndProcessType, createInstance, createRefSchema, generatePropertySchema, isAutoPutVersion, mergeSchema, mergeWithParent, overwriteProperty, processCustomType, processFields, processProperties, processRootAttributes, setAutoPutVersion

Methods inherited from class java.lang.Object

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

Constructor Detail

HyperSchemaGeneratorV4

protected HyperSchemaGeneratorV4(JsonSchemaGenerator jsonSchemaGenerator)

Method Detail

generateSchema

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

Overrides:

generateSchema in class JsonSchemaGenerator

Throws:

TypeException

processSchemaProperty

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

Description copied from class: JsonSchemaGenerator

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

Specified by:

processSchemaProperty in class JsonSchemaGenerator