Package com.github.victools.jsonschema.generator

Class SchemaGeneratorConfigBuilder

java.lang.Object
com.github.victools.jsonschema.generator.SchemaGeneratorConfigBuilder
public class SchemaGeneratorConfigBuilder extends Object
Builder class for creating a configuration object to be passed into the SchemaGenerator's constructor.

  • Constructor Details

    • SchemaGeneratorConfigBuilder

      @Deprecated public SchemaGeneratorConfigBuilder(tools.jackson.databind.ObjectMapper objectMapper)
      Deprecated.
      use SchemaGeneratorConfigBuilder(ObjectMapper, SchemaVersion) instead
      Constructor of an empty configuration builder for a Draft 7 schema. This is equivalent to calling:
      new SchemaGeneratorConfigBuilder(objectMapper, SchemaVersion.DRAFT_7, OptionPreset.FULL_DOCUMENTATION)
      Parameters:
      objectMapper - supplier for object and array nodes for the JSON structure being generated
      See Also:

    • SchemaGeneratorConfigBuilder

      public SchemaGeneratorConfigBuilder(tools.jackson.databind.ObjectMapper objectMapper, SchemaVersion schemaVersion)
      Constructor of an empty configuration builder. This is equivalent to calling:
      new SchemaGeneratorConfigBuilder(objectMapper, schemaVersion, OptionPreset.FULL_DOCUMENTATION)
      Parameters:
      objectMapper - supplier for object and array nodes for the JSON structure being generated
      schemaVersion - designated JSON Schema version
      See Also:

    • SchemaGeneratorConfigBuilder

      public SchemaGeneratorConfigBuilder(SchemaVersion schemaVersion)
      Constructor of an empty configuration builder with a default ObjectMapper instance. This is equivalent to calling:
      new SchemaGeneratorConfigBuilder(schemaVersion, OptionPreset.FULL_DOCUMENTATION)
      Parameters:
      schemaVersion - designated JSON Schema version
      See Also:

    • SchemaGeneratorConfigBuilder

      @Deprecated public SchemaGeneratorConfigBuilder(tools.jackson.databind.ObjectMapper objectMapper, OptionPreset preset)
      Deprecated.
      use SchemaGeneratorConfigBuilder(ObjectMapper, SchemaVersion, OptionPreset) instead
      Constructor of an empty configuration builder for a Draft 7 schema. This is equivalent to calling:
      new SchemaGeneratorConfigBuilder(objectMapper, SchemaVersion.DRAFT_7, preset)
      Parameters:
      objectMapper - supplier for object and array nodes for the JSON structure being generated
      preset - default settings for standard Option values

    • SchemaGeneratorConfigBuilder

      public SchemaGeneratorConfigBuilder(SchemaVersion schemaVersion, OptionPreset preset)
      Constructor of an empty configuration builder with a default ObjectMapper instance.
      Parameters:
      schemaVersion - designated JSON Schema version
      preset - default settings for standard Option values

    • SchemaGeneratorConfigBuilder

      public SchemaGeneratorConfigBuilder(tools.jackson.databind.ObjectMapper objectMapper, SchemaVersion schemaVersion, OptionPreset preset)
      Constructor of an empty configuration builder.
      Parameters:
      objectMapper - supplier for object and array nodes for the JSON structure being generated
      schemaVersion - designated JSON Schema version
      preset - default settings for standard Option values

  • Method Details

    • build

      public SchemaGeneratorConfig build()
      Create a schema generator instance from the builder.
      Returns:
      successfully created/initialised generator instance

    • forTypesInGeneral

      public SchemaGeneratorGeneralConfigPart forTypesInGeneral()
      Get the part of this configuration builder dedicated to custom attribute look-ups for types in general, independent of the declaration context.
      Returns:
      configuration part responsible for handling types regardless of their declaration context

    • forFields

      public SchemaGeneratorConfigPart<FieldScope> forFields()
      Get the part of this configuration builder dedicated to custom attribute look-ups for fields.
      Returns:
      configuration part responsible for handling of fields
      See Also:

    • forMethods

      public SchemaGeneratorConfigPart<MethodScope> forMethods()
      Get the part of this configuration builder dedicated to custom attribute look-ups for methods.
      Returns:
      configuration part responsible for handling of methods
      See Also:

    • getObjectMapper

      public tools.jackson.databind.ObjectMapper getObjectMapper()
      Retrieve the associated object mapper instance.
      Returns:
      supplier for object and array nodes for the JSON structure being generated

    • getSetting

      public Boolean getSetting(Option setting)
      Check whether the given setting/option has been set and if yes, whether it is enabled or disabled.
      Parameters:
      setting - generator option to check for
      Returns:
      currently configured flag (i.e. true/false if already set), or null if not configured

    • with

      public SchemaGeneratorConfigBuilder with(Module module)
      Applying a module to this configuration builder instance.
      Parameters:
      module - configuration module to add/apply
      Returns:
      this builder instance (for chaining)

    • with

      @Deprecated public SchemaGeneratorConfigBuilder with(CustomDefinitionProviderV2 definitionProvider)
      Deprecated.
      use SchemaGeneratorGeneralConfigPart.withCustomDefinitionProvider(CustomDefinitionProviderV2) instead
      Adding a custom schema provider - if it returns null for a given type, the next definition provider will be applied.
      If all custom schema providers return null (or there is none), then the standard behaviour applies.
      Parameters:
      definitionProvider - provider of a custom definition to register, which may return null
      Returns:
      this builder instance (for chaining)

    • with

      @Deprecated public SchemaGeneratorConfigBuilder with(TypeAttributeOverride override)
      Deprecated.
      use SchemaGeneratorGeneralConfigPart.withTypeAttributeOverride(TypeAttributeOverrideV2) instead
      Adding an override for type attributes - all the registered overrides will be applied in the order of having been added.
      Parameters:
      override - adding/removing attributes on a JSON Schema node - specifically intended for attributes relating to the type in general.
      Returns:
      this builder instance (for chaining)

    • with

      public SchemaGeneratorConfigBuilder with(Option setting, Option... moreSettings)
      Enable an option for the schema generation.
      Parameters:
      setting - generator option to enable
      moreSettings - additional generator options to enable
      Returns:
      this builder instance (for chaining)

    • without

      public SchemaGeneratorConfigBuilder without(Option setting, Option... moreSettings)
      Disable an option for the schema generation.
      Parameters:
      setting - generator option to disable
      moreSettings - additional generator options to disable
      Returns:
      this builder instance (for chaining)

    • withAnnotationInclusionOverride

      public SchemaGeneratorConfigBuilder withAnnotationInclusionOverride(Class<? extends Annotation> annotationType, com.fasterxml.classmate.AnnotationInclusion override)
      Register an explicit annotation inclusion rule for a given annotation type.
      Parameters:
      annotationType - type of annotation for which the inclusion behaviour should be overridden
      override - inclusion behaviour to apply for the given annotation type
      Returns:
      this builder instance (for chaining)
      Since:
      4.31.0

    • withObjectMapper

      public SchemaGeneratorConfigBuilder withObjectMapper(tools.jackson.databind.ObjectMapper objectMapper)
      Register a custom ObjectMapper to create object and array nodes for the JSON structure being generated. Additionally, it is used to serialize a given schema, e.g., within the standard Maven plugin as either YAML or JSON.
      Parameters:
      objectMapper - supplier for object and array nodes for the JSON structure being generated
      Returns:
      this builder instance (for chaining)
      Since:
      4.32.0