com.saasquatch.jsonschemainferrer

Interface ExamplesPolicy

All Superinterfaces:

GenericSchemaFeature

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface ExamplesPolicy
extends GenericSchemaFeature

Policy for examples. Implementations are expected to be stateless and thread safe. Note that examples is new in draft-06, and it's the implementations' job to be compliant with the specs.

Author:

sli

Method Summary

Modifier and Type	Method and Description
com.fasterxml.jackson.databind.JsonNode	getExamples(GenericSchemaFeatureInput input)
default com.fasterxml.jackson.databind.node.ObjectNode	getFeatureResult(GenericSchemaFeatureInput input) Get the add-on result to be merged in with the schema

Method Detail

getExamples

@Nullable
com.fasterxml.jackson.databind.JsonNode getExamples(@Nonnull
                                                              GenericSchemaFeatureInput input)

Returns:

The appropriate examples JsonNode for the given input

getFeatureResult

default com.fasterxml.jackson.databind.node.ObjectNode getFeatureResult(GenericSchemaFeatureInput input)

Description copied from interface: GenericSchemaFeature

Get the add-on result to be merged in with the schema

Specified by:

getFeatureResult in interface GenericSchemaFeature