Package com.github.victools.jsonschema.generator

Interface SchemaGenerationContext

  • All Known Implementing Classes:
    SchemaGenerationContextImpl
    public interface SchemaGenerationContext
    Generation context for sub-schema definitions.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      com.fasterxml.jackson.databind.node.ObjectNode createDefinition​(com.fasterxml.classmate.ResolvedType targetType)
      Create an inline definition for the given targetType.
      com.fasterxml.jackson.databind.node.ObjectNode createStandardDefinition​(com.fasterxml.classmate.ResolvedType targetType, CustomDefinitionProviderV2 ignoredDefinitionProvider)
      Create an inline definition for the given targetType.
      TypeContext getTypeContext()
      Getter for the type resolution/introspection context in use.
      com.fasterxml.jackson.databind.node.ObjectNode makeNullable​(com.fasterxml.jackson.databind.node.ObjectNode node)
      Ensure that the JSON schema represented by the given node allows for it to be of "type" "null".

    • Method Detail

      • getTypeContext

        TypeContext getTypeContext()
        Getter for the type resolution/introspection context in use.
        Returns:
        type resolution/introspection context

      • createDefinition

        com.fasterxml.jackson.databind.node.ObjectNode createDefinition​(com.fasterxml.classmate.ResolvedType targetType)
        Create an inline definition for the given targetType. Also respecting any custom definition for the given targetType.
        Parameters:
        targetType - type to create definition (reference) node for
        Returns:
        designated definition (reference) node for the targetType
        See Also:
        createStandardDefinition(ResolvedType, CustomDefinitionProviderV2)

      • createStandardDefinition

        com.fasterxml.jackson.databind.node.ObjectNode createStandardDefinition​(com.fasterxml.classmate.ResolvedType targetType,
                                                                        CustomDefinitionProviderV2 ignoredDefinitionProvider)
        Create an inline definition for the given targetType. Ignoring custom definitions up to the given one, but respecting others.
        Parameters:
        targetType - type to create definition (reference) node for
        ignoredDefinitionProvider - custom definition provider to ignore
        Returns:
        designated definition (reference) node for the targetType
        See Also:
        createDefinition(ResolvedType)

      • makeNullable

        com.fasterxml.jackson.databind.node.ObjectNode makeNullable​(com.fasterxml.jackson.databind.node.ObjectNode node)
        Ensure that the JSON schema represented by the given node allows for it to be of "type" "null".
        Parameters:
        node - representation of a JSON schema (part) that should allow a value of "type" "null"
        Returns:
        reference to the given parameter node