wow-schema/me.ahoo.wow.schema/SchemaGeneratorBuilder

SchemaGeneratorBuilder

Builder class for constructing a SchemaGenerator with customizable modules and options. This builder allows configuration of various JSON schema generation modules including Jackson, Jakarta Validation, Swagger2, Kotlin, Joda Money, and Wow-specific modules.

Constructors

constructor()

Properties

customizer

var customizer: Consumer<SchemaGeneratorConfigBuilder>?

jacksonModule

var jacksonModule: JacksonSchemaModule?

Jackson module for handling Jackson annotations in schema generation.

jakartaValidationModule

var jakartaValidationModule: JakartaValidationModule?

jodaMoneyModule

var jodaMoneyModule: JodaMoneyModule?

kotlinModule

var kotlinModule: KotlinModule?

objectMapper

var objectMapper: ObjectMapper?

optionPreset

var optionPreset: OptionPreset

The preset of options to apply to the schema generator.

options

var options: List<Option>

schemaNamingModule

var schemaNamingModule: SchemaNamingModule?

schemaVersion

var schemaVersion: SchemaVersion

The JSON Schema version to use for generation.

swagger2Module

var swagger2Module: Swagger2Module?

wowModule

var wowModule: WowModule?

Functions

build

fun build(): SchemaGenerator

Builds a generator from buildConfig.

buildConfig

fun buildConfig(): SchemaGeneratorConfig

The generator configuration: the modules in a fixed order, then options, then the customizer.

copy

fun copy(): SchemaGeneratorBuilder

A builder with the same settings: changing a setting of either one leaves the other as it is. The module instances are shared, not copied, and a module such as WowJacksonModule keeps the object mapper of the last configuration it was applied to, so build at most one of the two when they use different object mappers.

customizer