io.apicurio.datamodels.core.factories

Class OasSchemaFactory

java.lang.Object

io.apicurio.datamodels.core.factories.OasSchemaFactory

public class OasSchemaFactory
extends Object

Author:

eric.wittmann@gmail.com

Constructor Summary

Constructors

Constructor and Description
OasSchemaFactory()

Method Summary

Modifier and Type	Method and Description
static IDefinition	createSchemaDefinitionFromExample(OasDocument document, String name, Object example) Creates a new definition schema from a given example.

Methods inherited from class java.lang.Object

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

Constructor Detail

OasSchemaFactory

public OasSchemaFactory()

Method Detail

createSchemaDefinitionFromExample

public static IDefinition createSchemaDefinitionFromExample(OasDocument document,
                                                            String name,
                                                            Object example)

Creates a new definition schema from a given example. This method will analyze the example object and create a new schema object that represents the example. Note that this method does not support arbitrarily complicated examples, and should be used as a starting point for a schema, not a canonical one.

Parameters:

document -

name -

example -