com.saasquatch.jsonschemainferrer

Class JsonSchemaInferrerBuilder

java.lang.Object

com.saasquatch.jsonschemainferrer.JsonSchemaInferrerBuilder

@NotThreadSafe
public final class JsonSchemaInferrerBuilder
extends Object

Builder for JsonSchemaInferrer. This class is mutable and not thread safe.

Author:

sli

See Also:

JsonSchemaInferrer.newBuilder()

Method Summary

Modifier and Type	Method and Description
JsonSchemaInferrerBuilder	addEnumExtractors(EnumExtractor... enumExtractors) Add EnumExtractors.
JsonSchemaInferrerBuilder	addFormatInferrers(FormatInferrer... formatInferrers) Add a FormatInferrer for inferring the format of strings.
JsonSchemaInferrerBuilder	addGenericSchemaFeatures(GenericSchemaFeature... features) Add custom implementations of GenericSchemaFeatures.
JsonSchemaInferrer	build()
JsonSchemaInferrerBuilder	setAdditionalPropertiesPolicy(AdditionalPropertiesPolicy additionalPropertiesPolicy) Set the AdditionalPropertiesPolicy.
JsonSchemaInferrerBuilder	setArrayLengthFeatures(EnumSet<ArrayLengthFeature> arrayLengthFeatures) Set the ArrayLengthFeatures enabled
JsonSchemaInferrerBuilder	setDefaultPolicy(DefaultPolicy defaultPolicy) Set the DefaultPolicy.
JsonSchemaInferrerBuilder	setExamplesPolicy(ExamplesPolicy examplesPolicy) Set the ExamplesPolicy.
JsonSchemaInferrerBuilder	setIntegerTypeCriterion(IntegerTypeCriterion integerTypeCriterion) Set the IntegerTypeCriterion.
JsonSchemaInferrerBuilder	setIntegerTypePreference(IntegerTypePreference integerTypePreference) Set the IntegerTypePreference.
JsonSchemaInferrerBuilder	setMultipleOfPolicy(MultipleOfPolicy multipleOfPolicy) Set the MultipleOfPolicy.
JsonSchemaInferrerBuilder	setNumberRangeFeatures(EnumSet<NumberRangeFeature> numberRangeFeatures) Set the NumberRangeFeatures enabled
JsonSchemaInferrerBuilder	setObjectSizeFeatures(EnumSet<ObjectSizeFeature> objectSizeFeatures) Set the ObjectSizeFeatures enabled
JsonSchemaInferrerBuilder	setRequiredPolicy(RequiredPolicy requiredPolicy) Set the RequiredPolicy.
JsonSchemaInferrerBuilder	setSpecVersion(SpecVersion specVersion) Set the specification version.
JsonSchemaInferrerBuilder	setStringLengthFeatures(EnumSet<StringLengthFeature> stringLengthFeatures) Set the StringLengthFeatures enabled
JsonSchemaInferrerBuilder	setTitleDescriptionGenerator(TitleDescriptionGenerator titleDescriptionGenerator) Set the TitleDescriptionGenerator for this inferrer.

Methods inherited from class java.lang.Object

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

Method Detail

setSpecVersion

public JsonSchemaInferrerBuilder setSpecVersion(@Nonnull
                                                SpecVersion specVersion)

Set the specification version. The default is draft-04.

setIntegerTypePreference

public JsonSchemaInferrerBuilder setIntegerTypePreference(@Nonnull
                                                          IntegerTypePreference integerTypePreference)

Set the IntegerTypePreference. The default is IntegerTypePreference.IF_ALL.

See Also:

IntegerTypePreference

setIntegerTypeCriterion

public JsonSchemaInferrerBuilder setIntegerTypeCriterion(@Nonnull
                                                         IntegerTypeCriterion integerTypeCriterion)

Set the IntegerTypeCriterion. The default is IntegerTypeCriteria.nonFloatingPoint().

See Also:

IntegerTypeCriterion, IntegerTypeCriteria

addEnumExtractors

public JsonSchemaInferrerBuilder addEnumExtractors(@Nonnull
                                                   EnumExtractor... enumExtractors)

Add EnumExtractors.

See Also:

EnumExtractor, EnumExtractors

setTitleDescriptionGenerator

public JsonSchemaInferrerBuilder setTitleDescriptionGenerator(@Nonnull
                                                              TitleDescriptionGenerator titleDescriptionGenerator)

Set the TitleDescriptionGenerator for this inferrer. By default it is TitleDescriptionGenerators.noOp(). You can provide your custom implementations and transform the field names however you see fit.

See Also:

TitleDescriptionGenerator, TitleDescriptionGenerators

addFormatInferrers

public JsonSchemaInferrerBuilder addFormatInferrers(@Nonnull
                                                    FormatInferrer... formatInferrers)

Add a FormatInferrer for inferring the format of strings. By default no FormatInferrer is enabled. An example of a possible custom implementation is available at FormatInferrers.dateTime(), which you can potentially use or use it combined with your own implementations.

See Also:

FormatInferrer, FormatInferrers

setAdditionalPropertiesPolicy

public JsonSchemaInferrerBuilder setAdditionalPropertiesPolicy(@Nonnull
                                                               AdditionalPropertiesPolicy additionalPropertiesPolicy)

Set the AdditionalPropertiesPolicy. By default it is AdditionalPropertiesPolicies.noOp().

See Also:

AdditionalPropertiesPolicy, AdditionalPropertiesPolicies

setRequiredPolicy

public JsonSchemaInferrerBuilder setRequiredPolicy(@Nonnull
                                                   RequiredPolicy requiredPolicy)

Set the RequiredPolicy. By default it is RequiredPolicies.noOp().

See Also:

RequiredPolicy, RequiredPolicies

setDefaultPolicy

public JsonSchemaInferrerBuilder setDefaultPolicy(@Nonnull
                                                  DefaultPolicy defaultPolicy)

Set the DefaultPolicy. By default it is DefaultPolicies.noOp().

See Also:

DefaultPolicy, DefaultPolicies

setExamplesPolicy

public JsonSchemaInferrerBuilder setExamplesPolicy(@Nonnull
                                                   ExamplesPolicy examplesPolicy)

Set the ExamplesPolicy. By default is ExamplesPolicies.noOp().

See Also:

ExamplesPolicy, ExamplesPolicies

setMultipleOfPolicy

public JsonSchemaInferrerBuilder setMultipleOfPolicy(@Nonnull
                                                     MultipleOfPolicy multipleOfPolicy)

Set the MultipleOfPolicy. By default it is MultipleOfPolicies.noOp().

See Also:

MultipleOfPolicy, MultipleOfPolicies

setObjectSizeFeatures

public JsonSchemaInferrerBuilder setObjectSizeFeatures(@Nonnull
                                                       EnumSet<ObjectSizeFeature> objectSizeFeatures)

Set the ObjectSizeFeatures enabled

setArrayLengthFeatures

public JsonSchemaInferrerBuilder setArrayLengthFeatures(@Nonnull
                                                        EnumSet<ArrayLengthFeature> arrayLengthFeatures)

Set the ArrayLengthFeatures enabled

setStringLengthFeatures

public JsonSchemaInferrerBuilder setStringLengthFeatures(@Nonnull
                                                         EnumSet<StringLengthFeature> stringLengthFeatures)

Set the StringLengthFeatures enabled

setNumberRangeFeatures

public JsonSchemaInferrerBuilder setNumberRangeFeatures(@Nonnull
                                                        EnumSet<NumberRangeFeature> numberRangeFeatures)

Set the NumberRangeFeatures enabled

addGenericSchemaFeatures

public JsonSchemaInferrerBuilder addGenericSchemaFeatures(@Nonnull
                                                          GenericSchemaFeature... features)

Add custom implementations of GenericSchemaFeatures.

build

public JsonSchemaInferrer build()

Returns:

the JsonSchemaInferrer built

Throws:

IllegalArgumentException - if the spec version and features don't match up