com.saasquatch.jsonschemainferrer

Class JsonSchemaInferrer

java.lang.Object

com.saasquatch.jsonschemainferrer.JsonSchemaInferrer

@Immutable
public final class JsonSchemaInferrer
extends Object

Infer JSON schema based on sample JSONs. This class is immutable and thread safe.

Author:

sli

See Also:

newBuilder(), inferForSample(JsonNode), inferForSamples(Collection)

Method Summary

Modifier and Type	Method and Description
com.fasterxml.jackson.databind.node.ObjectNode	inferForSample(com.fasterxml.jackson.databind.JsonNode sample) Infer the JSON schema from a sample JSON.
com.fasterxml.jackson.databind.node.ObjectNode	inferForSamples(Collection<? extends com.fasterxml.jackson.databind.JsonNode> samples) Infer the JSON schema from multiple sample JSONs.
static JsonSchemaInferrerBuilder	newBuilder()

Methods inherited from class java.lang.Object

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

Method Detail

newBuilder

@Nonnull
public static JsonSchemaInferrerBuilder newBuilder()

Returns:

A new instance of JsonSchemaInferrerBuilder with default options.

inferForSample

@Nonnull
public com.fasterxml.jackson.databind.node.ObjectNode inferForSample(@Nullable
                                                                              com.fasterxml.jackson.databind.JsonNode sample)

Infer the JSON schema from a sample JSON.

Parameters:

sample - the sample JSON

Returns:

the inferred JSON schema

inferForSamples

@Nonnull
public com.fasterxml.jackson.databind.node.ObjectNode inferForSamples(@Nonnull
                                                                               Collection<? extends com.fasterxml.jackson.databind.JsonNode> samples)

Infer the JSON schema from multiple sample JSONs.

Parameters:

samples - the sample JSONs

Returns:

the inferred JSON schema